GetAutoScaleConfig_自动伸缩管理_API 参考_弹性高性能计算E-HPC-阿里云

获取自动伸缩配置信息。

描述

获取单个集群的自动伸缩配置信息。了解更多关于自动伸缩。

请求参数

字段	类型	是否必须	默认值	描述
Action	String	是	-	操作接口名，系统规定参数，取值：`GetAutoScaleConfig`
RegionId	String	是	-	地域ID
ClusterId	String	是	-	集群ID

返回参数

除公共返回参数外返回如下结果：

字段	类型	描述
ClusterId	String	集群ID
ClusterType	String	集群类型：`pbspro` / `slurm`
Uid	String	用户ID
EnableAutoGrow	Boolean	是否允许自动扩容，`true` / `false`
EnableAutoShrink	Boolean	是否允许自动缩容，`true` / `false`
GrowIntervalInMinutes	Integer	扩容时间间隔，每轮资源扩展的时间间隔。默认值2分钟，最小值2分钟，最大值10分钟。
ShrinkIntervalInMinutes	Integer	缩容时间间隔，每轮资源收缩的时间间隔，默认2分钟，最小值2分钟，最大值10分钟。
ShrinkIdleTimes	Integer	节点连续空闲次数，资源收缩检查时，一个节点连续处于空闲的次数。默认值3，最小值2。最大值5。如果一个计算节点连续空闲超过3次，就会被释放。所以默认配置下，一个资源的连续空闲时间超过6分钟，就会被释放。
GrowTimeoutInMinutes	Integer	扩容超时时间，等待启动节点的超时时间。默认值20分钟，最小值10分钟，最大值60分钟。如果超时时间后，节点依然未达到运行状态，将会把这个节点重置，用于新的扩容。
ExtraNodesGrowRatio	Integer	额外节点百分比，默认值0，最小值0，最大值100。例如，根据作业负载需要新增100个计算节点，ExtraNodesGrowRatio值为2，那么最终扩展的节点数量是102。
MaxNodesInCluster	Integer	集群最大计算节点数，集群最多可以扩展的节点数量，默认值100，最小值1。
GrowRatio	Integer	扩容比例，扩展比例(百分比)默认值100，最小值1，最大值100。比如当前根据作业负载需要新增10个计算节点，如果GrowRatio配置为50，就新增5个计算节点。
ExcludeNodes	String	例外节点列表，不使用自动伸缩的节点列表，以半角逗号分割。
SpotStrategy	String	计算节点竞价策略，取值`NoSpot`, `SpotWithPriceLimit`或`SpotAsPriceGo`
SpotPriceLimit	Float	设置实例的每小时最高价格，取值是数字，浮点数，取值范围是当前的价格区间
Queues	Array<QueueInfo>	集群队列的扩容配置信息

其中 QueueInfo 结构包含以下信息：

字段	类型	描述
QueueName	String	集群队列名称
InstanceType	String	该队列自动扩容的实例规格
ResourceGroupId	String	该队列所属资源组ID
EnableAutoGrow	Boolean	队列是否开启自动扩容，`true` / `false`，默认值为`false`
EnableAutoShrink	Boolean	队列是否开启自动缩容，`true` / `false` ，默认值为`false`
InstanceTypes	InstanceTypeInfo	该队列中包含的实例列表信息
SpotStrategy	String	计算节点竞价策略，取值`NoSpot`, `SpotWithPriceLimit`或`SpotAsPriceGo`
SpotPriceLimit	Float	实例的每小时最高价格，取值是数字，浮点数，取值范围是当前的价格区间

示例

请求示例

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=GetAutoScaleConfig&RegionId=cn-hangzhou&ClusterId=<集群ID>&<公共请求参数>

返回示例

XML格式

<GetAutoScaleConfigResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <ClusterType>slurm</ClusterType>
    <Uid>xxxxxx</Uid>
    <EnableAutoGrow>false</EnableAutoGrow>
    <EnableAutoShrink>false</EnableAutoShrink>
    <GrowIntervalInMinutes>2</GrowIntervalInMinutes>
    <ShrinkIntervalInMinutes>2</ShrinkIntervalInMinutes>
    <ShrinkIdleTimes>3</ShrinkIdleTimes>
    <GrowTimeoutInMinutes>20</GrowTimeoutInMinutes>
    <ExtraNodesGrowRatio>0</ExtraNodesGrowRatio>
    <MaxNodesInCluster>100</MaxNodesInCluster>
    <GrowRatio>100</GrowRatio>
    <ExcludeNodes></ExcludeNodes>
    <SpotStrategy>NoSpot</SpotStrategy>
    <SpotPriceLimit>0</SpotPriceLimit>
</GetAutoScaleConfigResponse>

JSON格式

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
    "ClusterType": "slurm",
    "Uid": "xxxxxx",
    "EnableAutoGrow": false,
    "EnableAutoShrink": false,
    "GrowIntervalInMinutes": 2,
    "ShrinkIntervalInMinutes": 2,
    "ShrinkIdleTimes" : 3,
    "GrowTimeoutInMinutes": 20,
    "ExtraNodesGrowRatio": 0,
    "MaxNodesInCluster": 100,
    "GrowRatio": 100,
    "ExcludeNodes": "",
    "SpotStrategy": "NoSpot",
    "SpotPriceLimit": 0,
    "Queues":[
    {
         "SpotPriceLimit":"0.066",
         "QueueName":"workq",
         "SpotStrategy":"SpotWithPriceLimit",
         "InstanceType":"ecs.sn1ne.large"
     }]
}

错误码

查询E-HPC接口错误码请访问错误码。更多错误码，请访问 API 错误中心。