调用SetAutoScaleConfig设置指定集群的自动伸缩配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ehpc:SetAutoScaleConfig | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClusterId | string | 是 | 集群 ID。 | ehpc-hz-FYUr32**** |
| EnableAutoGrow | boolean | 否 | 是否开启自动扩容。取值范围：
默认值： false | false |
| EnableAutoShrink | boolean | 否 | 是否开启自动缩容。取值范围：
默认值： false | false |
| GrowIntervalInMinutes | integer | 否 | 每轮计算节点扩容的时间间隔。单位：分钟 取值范围：2~10 默认值：2 说明
一次扩容任务可能会分几次完成，或者连续触发扩容时的时间间隔。
| 2 |
| ShrinkIntervalInMinutes | integer | 否 | 每轮计算节点收缩的时间间隔。单位：分钟 取值范围：2~10 默认值：2 | 2 |
| ShrinkIdleTimes | integer | 否 | 节点连续空闲（未运行作业）次数。节点收缩检查时，一个节点连续处于空闲状态的次数。 取值范围：2~5 默认值：3 如果设置为 3，表示一个计算节点连续空闲超过 3 次，就会被释放。因为 ShrinkIntervalInMinutes 默认值是 2 分钟，所以默认配置下，一个计算节点连续空闲时间超过 6 分钟，就会被释放。 | 3 |
| GrowTimeoutInMinutes | integer | 否 | 扩容超时时间。单位：分钟 取值范围：10~60 默认值：20 如果扩容时间大于扩容超时时间，节点依然未达到运行状态，该节点将被释放。 | 20 |
| ExtraNodesGrowRatio | integer | 否 | 额外节点百分比。取值范围：0~100 默认值：0 如果作业负载需要新增 100 个计算节点，ExtraNodesGrowRatio 值为 2，那么最终新增数量为 102。 | 0 |
| GrowRatio | integer | 否 | 扩容比例。取值范围：1~100 默认值：100 如果作业负载需要新增 10 个计算节点，GrowRatio 配置为 50，那么会进行多轮扩容，每轮扩容当前所需的 50%节点。 | 50 |
| MaxNodesInCluster | integer | 是 | 集群最多可以扩容的计算节点数量。取值范围：0~500 默认值：100 | 100 |
| ExcludeNodes | string | 否 | 例外节点列表，不参与自动伸缩的节点列表。节点之间用半角逗号（,）隔开。 如果您希望一直保留某个节点，可以设置为例外节点，空闲时不被释放。 | i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb**** |
| SpotStrategy | string | 否 | 计算节点抢占策略。取值范围：
默认值：NoSpot | SpotWithPriceLimit |
| SpotPriceLimit | float | 否 | 设置节点的每小时最高价格，最多支持 3 位小数。参数 | 0.062 |
| ImageId | string | 否 | 镜像 ID。 说明
Queues.N.QueueImageId和ImageId时，默认使用Queues.N.QueueImageId。
| centos_7_03_64_20G_alibase_201708**** |
| Queues | object [] | 否 | 队列信息。 | |
| QueueImageId | string | 否 | 扩容队列的镜像 ID。N 的取值范围：1~8 说明
Queues.N.QueueImageId和ImageId时，默认使用Queues.N.QueueImageId。
| centos_7_03_64_20G_alibase_201708**** |
| SystemDiskCategory | string | 否 | 队列中扩容的计算节点系统盘类型。取值范围：
N 的取值范围：1~8 默认值：cloud_efficiency | cloud_efficiency |
| InstanceType | string | 否 | 队列中自动扩容的节点规格。N 的取值范围：1~8 | ecs.n1.medium |
| HostNameSuffix | string | 否 | 队列中扩容的主机名后缀。方便您管理具有指定后缀的节点。 N 的取值范围：1~8 | 000 |
| SpotStrategy | string | 否 | 队列中自动扩容的计算节点的抢占策略。N 的取值范围：1~8 抢占策略取值范围为：
默认值：NoSpot | NoSpot |
| HostNamePrefix | string | 否 | 队列中扩容的主机名前缀。方便您管理具有指定前缀的节点。 N 的取值范围：1~8 | compute |
| MinNodesInQueue | integer | 否 | 队列允许收缩的最小节点数。取值范围：0~50 N 的取值范围：1~8 默认值：0 | 0 |
| SystemDiskSize | integer | 否 | 队列中扩容的节点系统盘大小。单位：GB 取值范围：40~500 N 的取值范围：1~8 默认值：40 | 40 |
| MaxNodesInQueue | integer | 否 | 队列允许扩容的最大节点数。取值范围：0~500 N 的取值范围：1~8 默认值：100 | 30 |
| EnableAutoShrink | boolean | 否 | 队列是否允许自动缩容。取值范围：
N 的取值范围：1~8 默认值：false | false |
| QueueName | string | 否 | 队列名称。支持同时设置 N 个队列的名称，N 的取值范围：1~8 | cluster1 |
| EnableAutoGrow | boolean | 否 | 队列是否允许自动扩容。取值范围：
N 的取值范围：1~8 默认值：false | false |
| SystemDiskLevel | string | 否 | 队列中扩容的计算节点系统盘性能等级。取值范围：
N 的取值范围：1~8 默认值：PL1 | PL1 |
| SpotPriceLimit | float | 否 | 队列中自动扩容的计算节点的每小时最高价格，支持最多 3 位小数。参数 N 的取值范围：1~8 | 0.662 |
| InstanceTypes | object [] | 否 | 队列中节点信息。 | |
| VSwitchId | string | 否 | 队列中自动扩容的节点绑定的交换机 ID。 支持同时设置 N 个队列的名称，N 的取值范围：1~8 队列自动扩容时支持同时为队列中 N 个节点设置交换机 ID，N 的取值范围：0~500 | vsw-bp1lfcjbfb099rrjn**** |
| ZoneId | string | 否 | 队列中自动扩容的节点所在可用区 ID。 支持同时设置 N 个队列的名称，N 的取值范围：1~8 队列自动扩容时支持同时为队列中 N 个节点设置可用区 ID，N 的取值范围：0~500 | cn-hangzhou-b |
| SpotPriceLimit | float | 否 | 队列中自动扩容的节点每小时最高价格，支持最多 3 位小数。参数 支持同时设置 N 个队列的名称，N 的取值范围：1~8 队列自动扩容时支持同时为队列中 N 个节点设置每小时最高价格，N 的取值范围：0~500 | 0.660 |
| InstanceType | string | 否 | 队列中自动扩容的节点规格。 支持同时设置 N 个队列的名称，N 的取值范围：1~8 队列自动扩容时支持同时为队列中 N 个节点设置规格参数，N 的取值范围：0~500 | ecs.n1.tiny |
| SpotStrategy | string | 否 | 队列中自动扩容的计算节点竞价策略。取值范围：
默认值：NoSpot 支持同时设置 N 个队列的名称，N 的取值范围：1~8 队列自动扩容时支持同时为队列中 N 个节点设置计算节点竞价策略，N 的取值范围：0~500 | SpotWithPriceLimit |
| SpotDuration | integer | 否 | 抢占式实例的保护期，单位为小时。取值为 0~1，设置为 0 则表示无保护期，默认为 1。 | 0 |
| SpotInterruptionBehavior | string | 否 | 抢占实例中断模式。目前仅支持 Terminate（默认）直接释放实例。 | Terminate |
| DataDisks | object [] | 否 | 随节点创建的数据盘信息列表。 | |
| DataDiskSize | integer | 否 | 第 N 个随节点创建的数据盘容量大小。单位：GB 取值范围：40~500 默认值：40 N 的取值范围：0~16 | 40 |
| DataDiskCategory | string | 否 | 第 N 个随节点创建的数据盘类型。取值范围：
默认值：cloud_efficiency N 的取值范围：0~16 | cloud_efficiency |
| DataDiskDeleteWithInstance | boolean | 否 | 第 N 个随节点创建的数据盘是否随实例释放。取值范围：
默认值：true N 的取值范围：0~16 | true |
| DataDiskPerformanceLevel | string | 否 | 第 N 个随节点创建的数据盘类型为 ESSD 云盘时，区分性能等级。仅当 Queues.N.DataDisks.N.DataDiskCategory=cloud_essd 时该参数有效。取值范围：
默认值：PL1 N 的取值范围：0~16 | PL1 |
| DataDiskEncrypted | boolean | 否 | 第 N 个随节点创建的数据盘是否加密。取值范围：
默认值：false N 的取值范围：0~16 | false |
| DataDiskKMSKeyId | string | 否 | 第 N 个随节点创建的数据盘使用的 KMS 密钥 ID。 N 的取值范围：0~16 | 0e478b7a-4262-4802-b8cb-00d3fb40826X |
| MaxNodesPerCycle | long | 否 | 自动伸缩每轮扩容的最大计算节点数。取值范围：0~99。 默认值：0。 | 20 |
| MinNodesPerCycle | long | 否 | 自动伸缩每轮扩容的最小计算节点数。取值范围：1~99。 默认值：1。 如果某一轮次需扩容节点数量小于所设置的最小计算节点数，自动伸缩为保证资源的正常交付，会将该轮次的最小计算节点数自动调整为当前轮次需要扩容节点数量。 说明
该调整仅对当前轮次的最小计算节点数生效。
| 5 |
| AutoMinNodesPerCycle | boolean | 否 | 自动设置单轮扩容的最小节点数量。 如果设置为 true，则每次扩容的最小节点数等于作业所需的节点数量，上限是 99 台。 | false |
| SortedByInventory | boolean | 否 | 实例是否支持乱序排列，取值范围：
说明
如果设置为 true，自动伸缩会按照实例库存数量从多到少的顺序选择实例规格，尽力交付实例资源。
| false |
| ComputeEnableHt | boolean | 否 | 计算节点对应的 ECS 实例是否开启超线程。 说明
该配置仅对部分支持开关超线程的实例规格生效。对于不支持的实例，默认开启超线程。具体请参见自定义 CPU 选项。
| true |
| DnsConfig | string | 否 | DNS 配置信息。 | "{\"DnsType\":\"PrivateZone\",\"DnsName\":\"xxxxx\"}" |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "04F0F334-13358736C-A1D7-6C044FE7****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParams | The specified parameter %s is invalid. | 无效的参数：%s |
| 403 | InvalidOpt | The specified operation is invalid. Please try again later. If the problem still exists, submit a ticket. | - |
| 403 | TooManyComputes | The number of computing nodes exceeds the quota. | 计算节点数超过用户配额 |
| 404 | ClusterNotFound | The specified cluster does not exist. | 指定的集群不存在，请您检查该参数是否正确。 |
| 404 | ImageNotFound | The specified image does not exist. | 指定的镜像不存在，请您检查该参数是否正确。 |
| 406 | DbError | A database service error occurred. | 数据库请求失败 |
| 407 | NotAuthorized | You are not authorized by RAM for this request. | 此请求未获得RAM授权 |
| 500 | UnknownError | An unknown error occurred. | 未知错误 |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | 请求失败，服务暂时不可用 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-08-11 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||||||||
| ||||||||||||||||||||||
| 2023-07-13 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||||||||
| ||||||||||||||||||||||
| 2023-05-23 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||||||||
| ||||||||||||||||||||||
| 2023-03-28 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||||||||
| ||||||||||||||||||||||
| 2023-03-28 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||||||||
| ||||||||||||||||||||||
| 2023-03-15 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||||||||
| ||||||||||||||||||||||
| 2021-12-23 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||||||||
|