Queries the auto scaling configurations of a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetAutoScaleConfig

The operation that you want to perform. Set the value to GetAutoScaleConfig.

ClusterId String Yes ehpc-hz-FYUr32****

The ID of the cluster.

Response parameters

Parameter Type Example Description
ClusterId String ehpc-hz-FYUr32****

The ID of the cluster.

ClusterType String pbs

The type of the scheduler. Valid values:

  • slurm
  • pbs
  • opengridscheduler
  • deadline
EnableAutoGrow Boolean true

Indicates whether the cluster enabled the auto scale-out. Valid values:

  • true
  • false
EnableAutoShrink Boolean true

Indicates whether the cluster enabled the auto scale-in. Valid values:

  • true
  • false
ExcludeNodes String i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****

The compute nodes that were excluded from the list of auto scaling nodes. Multiple compute nodes were separated with commas (,).

ExtraNodesGrowRatio Integer 2

The percentage of extra compute nodes. Valid values: 0 to 100.

If you need to add 100 compute nodes and the value of the ExtraNodesGrowRatio parameter is 2, 102 compute nodes are added.

GrowIntervalInMinutes Integer 2

The interval between two points in time when compute nodes were added. Unit: minutes. Valid values: 2 to 10.

Note An interval may exist during a scale-out task or between two scale-out tasks.
GrowRatio Integer 100

The percentage of each round of scale-out. Valid values: 1 to 100.

If you set GrowRatio to 50, the scale-out has two rounds. Each round completes half of the scale-out.

GrowTimeoutInMinutes Integer 20

The timeout period before the scale-out nodes were started. Unit: minutes. Valid values: 10 to 60.

If the scale-out timeout period has been reached and the scale-out nodes still do not reach the Running state, the system resets them.

ImageId String m-bp10txryr4mhrrt1****

The image ID of the compute nodes in the queue.

MaxNodesInCluster Integer 300

The maximum number of compute nodes that can be added in the cluster. Valid values: 0 to 500.

Queues Array of QueueInfo

The auto scaling configuration of the queue.

Note If auto scaling is enabled for the cluster and queue at the same time, the queue settings prevail.
QueueInfo
EnableAutoGrow Boolean true

Indicates whether the queue enabled the auto scale-out. Valid values:

  • true
  • false
EnableAutoShrink Boolean true

Indicates whether the queue enabled the auto scale-in. Valid values:

  • true
  • false
HostNamePrefix String compute

The prefix of the queue name. You can query queues that have a specified prefix.

HostNameSuffix String 000

The suffix of the queue name. You can query queues that have a specified suffix.

InstanceType String ecs.sn1ne.large

The instance type of the compute nodes that were automatically added in the queue.

InstanceTypes Array of InstanceTypeInfo

The specification information of the compute nodes.

InstanceTypeInfo
HostNamePrefix String compute

The prefix of the hostname. You can query compute nodes that have a specified prefix.

InstanceType String ecs.sn1ne.large

The specification of the compute node.

SpotPriceLimit Float 0.062

The maximum hourly price of the compute nodes. The value can be accurate to three decimal places. The parameter only takes effect when SpotStrategy is set to SpotWithPriceLimit.

SpotStrategy String NoSpot

The bidding method of the compute nodes. Valid values:

  • NoSpot: The compute nodes are pay-as-you-go instances.
  • SpotWithPriceLimit: The compute nodes are preemptible instances that have a maximum hourly price.
  • SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price.
VSwitchId String vsw-bp1lfcjbfb099rrjn****

The ID of the vSwitch.

ZoneId String cn-hangzhou-b

The ID of the zone.

MaxNodesInQueue Integer 100

The maximum number of compute nodes that can be added in a queue. Valid values: 0 to 500.

MinNodesInQueue Integer 10

The minimum number of compute nodes that can be retained in a queue. Valid values: 0 to 50.

QueueImageId String centos_7_06_64_20G_alibase_2019071****

The image ID of the compute nodes in the queue.

QueueName String workq

The name of the queue.

ResourceGroupId String rg-acfmxp7uc24****

The ID of the resource group to which the compute nodes belong.

SpotPriceLimit Float 0.062

The maximum hourly price of the compute nodes. The value can be accurate to three decimal places. The parameter only takes effect when SpotStrategy is set to SpotWithPriceLimit.

SpotStrategy String NoSpot

The preemption policy of the compute nodes. Valid values:

  • NoSpot: The compute nodes are pay-as-you-go instances.
  • SpotWithPriceLimit: The compute nodes are preemptible instances that have a maximum hourly price.
  • SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price.
SystemDiskCategory String cloud_efficiency

The type of the system disk. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: SSD
  • cloud_essd: ESSD
  • cloud: basic disk
SystemDiskLevel String PL1

The performance level of the system disk. Valid values:

  • PL0: A single ESSD can deliver up to 10,000 input/output operations per second (IOPS) of random read/write.
  • PL1: A single ESSD can deliver up to 50,000 IOPS of random read/write.
  • PL2: A single ESSD can deliver up to 100,000 IOPS of random read/write.
  • PL3: A single ESSD can deliver up to 1,000,000 IOPS of random read/write.
SystemDiskSize Integer 40

The size of the system disk. Unit: GB. Valid values: 40 to 500.

RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the request.

ShrinkIdleTimes Integer 3

The number of consecutive idle times of a compute node during the resource scale-in check. Valid values: 2 to 5.

If the parameter is set to 3, a compute node is idle for more than 3 consecutive times. In this case, the node will be released.

ShrinkIntervalInMinutes Integer 2

The interval between two points in time when compute nodes were removed. Unit: minutes. Valid values: 2 to 10.

SpotPriceLimit Float 0.062

The maximum hourly price of the compute nodes. The value can be accurate to three decimal places. The parameter only takes effect when SpotStrategy is set to SpotWithPriceLimit.

SpotStrategy String SpotWithPriceLimit

The preemption policy of the compute nodes. Valid values:

  • NoSpot: The compute nodes are pay-as-you-go instances.
  • SpotWithPriceLimit: The compute nodes are preemptible instances that have a maximum hourly price.
  • SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price.
Uid String 129845258050****

The ID of the Alibaba Cloud account.

Examples

Sample requests

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=GetAutoScaleConfig
&ClusterId=ehpc-hz-FYUr32****
&<Common request parameters>

Sample success responses

XML format

<GetAutoScaleConfigResponse>
      <RequestId>04F0F334-13358736C-A1D7-6C044FE73368</RequestId>
      <ExtraNodesGrowRatio>0</ExtraNodesGrowRatio>
      <EnableAutoGrow>true</EnableAutoGrow>
      <ClusterId>ehpc-hz-FYUr32****</ClusterId>
      <ShrinkIdleTimes>3</ShrinkIdleTimes>
      <MaxNodesInCluster>300</MaxNodesInCluster>
      <ClusterType>pbs</ClusterType>
      <EnableAutoShrink>true</EnableAutoShrink>
      <GrowRatio>100</GrowRatio>
      <GrowIntervalInMinutes>2</GrowIntervalInMinutes>
      <Uid>129845258050****</Uid>
      <GrowTimeoutInMinutes>20</GrowTimeoutInMinutes>
      <ImageId>m-bp10txryr4mhrrt1****</ImageId>
      <ShrinkIntervalInMinutes>2</ShrinkIntervalInMinutes>
      <SpotPriceLimit>0</SpotPriceLimit>
      <Queues>
            <QueueInfo>
                  <MinNodesInQueue>0</MinNodesInQueue>
                  <MaxNodesInQueue>100</MaxNodesInQueue>
                  <EnableAutoGrow>true</EnableAutoGrow>
                  <EnableAutoShrink>true</EnableAutoShrink>
                  <InstanceTypes>
                        <InstanceTypeInfo>
                              <ZoneId>cn-hangzhou-i</ZoneId>
                              <VSwitchId>vsw-bp1lfcjbfb099rrjn****</VSwitchId>
                              <SpotPriceLimit>0</SpotPriceLimit>
                              <HostNamePrefix>compute</HostNamePrefix>
                              <InstanceType>ecs.sn1ne.large</InstanceType>
                              <SpotStrategy>NoSpot</SpotStrategy>
                        </InstanceTypeInfo>
                  </InstanceTypes>
                  <QueueName>workq</QueueName>
            </QueueInfo>
            <QueueInfo>
                  <MinNodesInQueue>0</MinNodesInQueue>
                  <MaxNodesInQueue>100</MaxNodesInQueue>
                  <EnableAutoGrow>true</EnableAutoGrow>
                  <EnableAutoShrink>true</EnableAutoShrink>
                  <InstanceTypes>
            </InstanceTypes>
                  <QueueName>test1</QueueName>
            </QueueInfo>
            <QueueInfo>
                  <MinNodesInQueue>0</MinNodesInQueue>
                  <MaxNodesInQueue>100</MaxNodesInQueue>
                  <EnableAutoGrow>true</EnableAutoGrow>
                  <EnableAutoShrink>true</EnableAutoShrink>
                  <InstanceTypes>
            </InstanceTypes>
                  <QueueName>tes2</QueueName>
            </QueueInfo>
      </Queues>
      <ExcludeNodes>i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****</ExcludeNodes>
      <SpotStrategy>NoSpot</SpotStrategy>
</GetAutoScaleConfigResponse>

JSON format

{
    "RequestId":"04F0F334-13358736C-A1D7-6C044FE73368",
    "ExtraNodesGrowRatio": 0,
    "EnableAutoGrow": true,
    "ClusterId": "ehpc-hz-FYUr32****",
    "ShrinkIdleTimes": 3,
    "MaxNodesInCluster": 300,
    "ClusterType": "pbs",
    "EnableAutoShrink": true,
    "GrowRatio": 100,
    "GrowIntervalInMinutes": 2,
    "Uid": "129845258050****",
    "GrowTimeoutInMinutes": 20,
    "ImageId": "m-bp10txryr4mhrrt1****",
    "ShrinkIntervalInMinutes": 2,
    "SpotPriceLimit": 0,
    "Queues": {
        "QueueInfo": [
            {
                "MinNodesInQueue": "0",
                "MaxNodesInQueue": "100",
                "EnableAutoGrow": "true",
                "EnableAutoShrink": "true",
                "InstanceTypes": {
                    "InstanceTypeInfo": [
                        {
                            "ZoneId": "cn-hangzhou-i",
                            "VSwitchId": "vsw-bp1lfcjbfb099rrjn****",
                            "SpotPriceLimit": "0",
                            "HostNamePrefix": "compute",
                            "InstanceType": "ecs.sn1ne.large",
                            "SpotStrategy": "NoSpot"
                        }
                    ]
                },
                "QueueName": "workq"
            },
            {
                "MinNodesInQueue": "0",
                "MaxNodesInQueue": "100",
                "EnableAutoGrow": "true",
                "EnableAutoShrink": "true",
                "InstanceTypes": {
                    "InstanceTypeInfo": []
                },
                "QueueName": "test1"
            },
            {
                "MinNodesInQueue": "0",
                "MaxNodesInQueue": "100",
                "EnableAutoGrow": "true",
                "EnableAutoShrink": "true",
                "InstanceTypes": {
                    "InstanceTypeInfo": []
                },
                "QueueName": "tes2"
            }
        ]
    },
    "ExcludeNodes": "i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****",
    "SpotStrategy": "NoSpot"
}

Error codes

HttpCode Error code Error message Description
400 InvalidParams The specified parameter %s is invalid. The error message returned because the following parameter is invalid: %s.
404 ClusterNotFound The specified cluster does not exist. The error message returned because the specified cluster does not exist.
403 InvalidOpt The specified operation is invalid. Please try again later. If the problem still exists, submit a ticket. The error message returned because the operation is unknown. Please try again later. If the error persists, submit a ticket.
406 DbError A database service error occurred. The error message returned because the database request has failed.
500 UnknownError An unknown error occurred. The error message returned because an unknown error has occurred.
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request has failed. The service is temporarily unavailable.

For a list of error codes, visit the API Error Center.