调用GetAutoScaleConfig获取自动伸缩配置信息_弹性高性能计算(E-HPC)-阿里云帮助中心

调用GetAutoScaleConfig获取指定集群的自动伸缩配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ehpc:GetAutoScaleConfig		全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。	ehpc-hz-FYUr32****

返回参数

名称	类型	描述	示例值
	object
MaxNodesInCluster	integer	集群最多可以扩容的节点数量。可能值：0~500	300
GrowTimeoutInMinutes	integer	扩容超时时间，等待启动节点的超时时间。单位：分钟，可能值：10~60 如果扩容时间大于扩容超时时间，节点依然未达到运行状态，系统将此节点释放。	20
SpotStrategy	string	计算节点抢占策略。可能值： NoSpot：正常按量付费节点。 SpotWithPriceLimit：设置上限价格的抢占式节点。 SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式节点。	SpotWithPriceLimit
EnableAutoShrink	boolean	集群是否启动自动缩容。可能值： true false	true
RequestId	string	请求 ID。	04F0F334-1335-436C-A1D7-6C044FE73368
EnableAutoGrow	boolean	集群是否启动自动扩容。可能值： true false	true
ClusterType	string	集群的调度器类型。可能值： slurm pbs opengridscheduler deadline	pbs
ExcludeNodes	string	不参与自动伸缩的节点列表，多个节点之间用半角逗号（,）隔开。	i-bp19lgqwxb4206t5**,i-bp1g4hvzs9pywrhb**
ShrinkIntervalInMinutes	integer	缩容时间间隔，每轮计算节点收缩的时间间隔。单位：分钟，可能值：2~10	2
GrowIntervalInMinutes	integer	扩容时间间隔，每轮计算节点扩容的时间间隔。单位：分钟，可能值：2~10 说明一次扩容任务可能会分几次完成，或者连续触发扩容时的时间间隔。	2
SpotPriceLimit	float	计算节点每小时最高价格，最多支持 3 位小数。参数 SpotStrategy 取值为 SpotWithPriceLimit 时生效。	0.062
ExtraNodesGrowRatio	integer	额外节点百分比。可能值：0~100 如果作业负载需要新增 100 个计算节点，ExtraNodesGrowRatio 值为 2，那么最终新增数量为 102。	2
ShrinkIdleTimes	integer	节点连续空闲（未运行作业）次数。节点收缩检查时，一个节点连续处于空闲状态的次数。可能值：2~5 如果该参数值为 3，表示一个计算节点连续空闲超过 3 次，就会被释放。	3
ImageId	string	队列中计算节点镜像 ID。	m-bp10txryr4mhrrt1****
GrowRatio	integer	扩容比例。可能值：1~100 如果作业负载需要新增 10 个计算节点，GrowRatio 配置为 50，那么会进行多轮扩容，每轮扩容当前所需的 50%。	100
ClusterId	string	集群 ID。	ehpc-hz-FYUr32****
Uid	string	阿里云账号 ID。	129845258050****
Queues	array<object>	集群队列的自动伸缩配置信息。说明集群和队列同时开启了扩容或缩容时，则以队列设置为优先。
QueueInfo	object
QueueImageId	string	队列中计算节点镜像 ID。	centos_7_06_64_20G_alibase_2019071****
SystemDiskCategory	string	系统盘类型。可能值： cloud_efficiency：高效云盘 cloud_ssd：SSD 云盘 cloud_essd：ESSD 云盘 cloud：普通云盘	cloud_efficiency
InstanceType	string	该队列自动扩容的节点规格。	ecs.sn1ne.large
HostNameSuffix	string	队列名后缀。方便您查询具有指定后缀的队列。	000
SpotStrategy	string	计算节点的抢占策略。可能值： NoSpot：正常按量付费节点。 SpotWithPriceLimit：设置上限价格的抢占式节点。 SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式节点。	NoSpot
MinNodesInQueue	integer	单个队列最小计算节点数，队列最少可以保留的计算节点数量。可能值：0~50	10
HostNamePrefix	string	队列名前缀。方便您查询具有指定前缀的队列。	compute
SystemDiskSize	integer	系统盘大小。单位：GB，可能值：40~500	40
MaxNodesInQueue	integer	单个队列最多可以扩容的节点数量。可能值：0~500	100
EnableAutoShrink	boolean	队列是否启动自动缩容。可能值： true false	true
QueueName	string	队列名称。	workq
EnableAutoGrow	boolean	队列是否启动自动扩容。可能值： true false	true
SystemDiskLevel	string	系统盘性能等级。可能值： PL0：单盘最高随机读写 IOPS 1 万 PL1：单盘最高随机读写 IOPS 5 万 PL2：单盘最高随机读写 IOPS10 万 PL3：单盘最高随机读写 IOPS 100 万	PL1
ResourceGroupId	string	计算节点所属的资源组 ID。	rg-acfmxp7uc24****
SpotPriceLimit	float	计算节点每小时最高价格，支持最大 3 位小数。参数 SpotStrategy 取值为 SpotWithPriceLimit 时生效。	0.062
InstanceTypes	array<object>	计算节点规格信息。
InstanceTypeInfo	object
HostNamePrefix	string	主机名前缀。方便您查询具有指定前缀的节点。	compute
VSwitchId	string	计算节点所属的交换机 ID。	vsw-bp1lfcjbfb099rrjn****
ZoneId	string	计算节点所属的可用区 ID。	cn-hangzhou-b
SpotPriceLimit	float	计算节点每小时最高价格，支持最多 3 位小数。参数 SpotStrategy 取值为 SpotWithPriceLimit 时生效。	0.062
InstanceType	string	节点规格。	ecs.sn1ne.large
SpotStrategy	string	计算节点竞价策略。可能值： NoSpot：正常按量付费节点。 SpotWithPriceLimit：设置上限价格的抢占式节点。 SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式节点。	NoSpot
SpotDuration	integer	抢占式实例的保护期，单位为小时。取值为 0~1，默认为 1，设置为 0 表示无保护期。	0
SpotInterruptionBehavior	string	抢占实例中断模式。目前仅支持 Terminate（默认）直接释放实例。	Terminate
DataDisks	array<object>	节点上挂载的数据盘信息列表。
DataDisksInfo	object
DataDiskCategory	string	第 N 个该节点挂载的数据盘类型。可能值： cloud_efficiency：高效云盘 cloud_ssd：SSD 云盘 cloud_essd：ESSD 云盘 cloud：普通云盘	cloud_efficiency
DataDiskSize	integer	第 N 个该节点挂载的数据盘容量大小。单位：GB 可能值：40~500	40
DataDiskDeleteWithInstance	boolean	第 N 个该节点挂载的数据盘是否随实例释放。可能值： true：是 false：否	true
DataDiskPerformanceLevel	string	第 N 个该节点的数据盘类型为 ESSD 云盘时，区分性能等级。仅当 DataDisks.N.DataDiskCategory=cloud_essd 时返回该参数。可能值： PL0：单盘最高随机读写 IOPS 1 万 PL1：单盘最高随机读写 IOPS 5 万 PL2：单盘最高随机读写 IOPS 10 万 PL3：单盘最高随机读写 IOPS 100 万	PL1
DataDiskEncrypted	boolean	第 N 个该节点的数据盘是否加密。可能值： true：是 false：否	false
DataDiskKMSKeyId	string	第 N 个该节点的数据盘使用的 KMS 密钥 ID。	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：否说明如果设置为 true，自动伸缩会按照实例库存数量从多到少的顺序选择实例规格，尽力交付实例资源。	false
ComputeEnableHt	boolean	计算节点对应的 ECS 实例是否开启超线程。	true
DnsConfig	string	DNS 配置信息。	"{\"DnsType\":\"PrivateZone\",\"DnsName\":\"xxxxx\"}"

示例

正常返回示例

JSON格式

{
  "MaxNodesInCluster": 300,
  "GrowTimeoutInMinutes": 20,
  "SpotStrategy": "SpotWithPriceLimit",
  "EnableAutoShrink": true,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "EnableAutoGrow": true,
  "ClusterType": "pbs",
  "ExcludeNodes": "i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****",
  "ShrinkIntervalInMinutes": 2,
  "GrowIntervalInMinutes": 2,
  "SpotPriceLimit": 0.062,
  "ExtraNodesGrowRatio": 2,
  "ShrinkIdleTimes": 3,
  "ImageId": "m-bp10txryr4mhrrt1****",
  "GrowRatio": 100,
  "ClusterId": "ehpc-hz-FYUr32****",
  "Uid": "129845258050****",
  "Queues": {
    "QueueInfo": [
      {
        "QueueImageId": "centos_7_06_64_20G_alibase_2019071****",
        "SystemDiskCategory": "cloud_efficiency",
        "InstanceType": "ecs.sn1ne.large",
        "HostNameSuffix": "000",
        "SpotStrategy": "NoSpot",
        "MinNodesInQueue": 10,
        "HostNamePrefix": "compute",
        "SystemDiskSize": 40,
        "MaxNodesInQueue": 100,
        "EnableAutoShrink": true,
        "QueueName": "workq",
        "EnableAutoGrow": true,
        "SystemDiskLevel": "PL1",
        "ResourceGroupId": "rg-acfmxp7uc24****",
        "SpotPriceLimit": 0.062,
        "InstanceTypes": {
          "InstanceTypeInfo": [
            {
              "HostNamePrefix": "compute",
              "VSwitchId": "vsw-bp1lfcjbfb099rrjn****",
              "ZoneId": "cn-hangzhou-b",
              "SpotPriceLimit": 0.062,
              "InstanceType": "ecs.sn1ne.large",
              "SpotStrategy": "NoSpot",
              "SpotDuration": 0,
              "SpotInterruptionBehavior": "Terminate"
            }
          ]
        },
        "DataDisks": {
          "DataDisksInfo": [
            {
              "DataDiskCategory": "cloud_efficiency",
              "DataDiskSize": 40,
              "DataDiskDeleteWithInstance": true,
              "DataDiskPerformanceLevel": "PL1",
              "DataDiskEncrypted": false,
              "DataDiskKMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40826X"
            }
          ]
        },
        "MaxNodesPerCycle": 20,
        "MinNodesPerCycle": 5,
        "AutoMinNodesPerCycle": false,
        "SortedByInventory": false
      }
    ]
  },
  "ComputeEnableHt": true,
  "DnsConfig": "\"{\\\"DnsType\\\":\\\"PrivateZone\\\",\\\"DnsName\\\":\\\"xxxxx\\\"}\""
}

错误码

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.	-
404	ClusterNotFound	The specified cluster does not exist.	指定的集群不存在，请您检查该参数是否正确。
406	DbError	A database service error occurred.	数据库请求失败
500	UnknownError	An unknown error occurred.	未知错误
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	请求失败，服务暂时不可用

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-08-11	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-07-13	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-05-23	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-03-15	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2021-12-23	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情