Obtains the auto scaling settings 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
MaxNodesInCluster Integer 300

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

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.

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 user-defined 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.
EnableAutoShrink Boolean true

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

  • true
  • false
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the request.

EnableAutoGrow Boolean true

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

  • true
  • false
ClusterType String pbs

The type of the scheduler. Valid values:

  • slurm
  • pbs
  • opengridscheduler
  • deadline
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 (,).

ShrinkIntervalInMinutes Integer 2

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

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.
SpotPriceLimit Float 0.062

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

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.

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.

ImageId String m-bp10txryr4mhrrt1****

The image ID of the compute nodes in the queue.

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.

ClusterId String ehpc-hz-FYUr32****

The ID of the cluster.

Uid String 129845258050****

The ID of the Alibaba Cloud account.

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
QueueImageId String centos_7_06_64_20G_alibase_2019071****

The image ID of the compute nodes in the queue.

SystemDiskCategory String cloud_efficiency

The type of the system disk. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • cloud_essd: enhanced SSD (ESSD)
  • cloud: basic disk
InstanceType String ecs.sn1ne.large

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

HostNameSuffix String 000

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

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 user-defined 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.
MinNodesInQueue Integer 10

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

HostNamePrefix String compute

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

SystemDiskSize Integer 40

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

MaxNodesInQueue Integer 100

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

EnableAutoShrink Boolean true

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

  • true
  • false
QueueName String workq

The name of the queue.

EnableAutoGrow Boolean true

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

  • true
  • false
SystemDiskLevel String PL1

The performance level of the system disk. Valid values:

  • PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.
  • PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.
  • PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.
  • PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.
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 takes effect only when SpotStrategy is set to SpotWithPriceLimit.

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.

VSwitchId String vsw-bp1lfcjbfb099rrjn****

The ID of the vSwitch.

ZoneId String cn-hangzhou-b

The ID of the zone.

SpotPriceLimit Float 0.062

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

InstanceType String ecs.sn1ne.large

The instance type of the node.

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 user-defined 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.
DataDisks Array of DataDisksInfo

The list of data disks.

DataDisksInfo
DataDiskCategory String cloud_efficiency

The type of the data disk. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • cloud_essd: enhanced SSD (ESSD)
  • cloud: basic disk
DataDiskSize Integer 40

The capacity of the data disk. Unit: GB.

Valid values: 40 to 500

DataDiskDeleteWithInstance Boolean true

Indicates whether the data disk is released when the node is released. Valid values:

  • true
  • false
DataDiskPerformanceLevel String PL1

The performance level of the ESSD used as the data disk. The parameter takes effect only when the DataDisks.N.DataDiskCategory parameter is set to cloud_essd. Valid values:

  • PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.
  • PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.
  • PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.
  • PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.
DataDiskEncrypted Boolean false

Indicates whether the data disk is encrypted. Valid values:

  • true
  • false
DataDiskKMSKeyId String 0e478b7a-4262-4802-b8cb-00d3fb40826X

The KMS key ID of the data disk.

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetAutoScaleConfigResponse>
    <MaxNodesInCluster>300</MaxNodesInCluster>
    <GrowTimeoutInMinutes>20</GrowTimeoutInMinutes>
    <SpotStrategy>SpotWithPriceLimit</SpotStrategy>
    <EnableAutoShrink>true</EnableAutoShrink>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <EnableAutoGrow>true</EnableAutoGrow>
    <ClusterType>pbs</ClusterType>
    <ExcludeNodes>i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****</ExcludeNodes>
    <ShrinkIntervalInMinutes>2</ShrinkIntervalInMinutes>
    <GrowIntervalInMinutes>2</GrowIntervalInMinutes>
    <SpotPriceLimit>0.062</SpotPriceLimit>
    <ExtraNodesGrowRatio>2</ExtraNodesGrowRatio>
    <ShrinkIdleTimes>3</ShrinkIdleTimes>
    <ImageId>m-bp10txryr4mhrrt1****</ImageId>
    <GrowRatio>100</GrowRatio>
    <ClusterId>ehpc-hz-FYUr32****</ClusterId>
    <Uid>129845258050****</Uid>
    <Queues>
        <QueueImageId>centos_7_06_64_20G_alibase_2019071****</QueueImageId>
        <SystemDiskCategory>cloud_efficiency</SystemDiskCategory>
        <InstanceType>ecs.sn1ne.large</InstanceType>
        <HostNameSuffix>000</HostNameSuffix>
        <SpotStrategy>NoSpot</SpotStrategy>
        <MinNodesInQueue>10</MinNodesInQueue>
        <HostNamePrefix>compute</HostNamePrefix>
        <SystemDiskSize>40</SystemDiskSize>
        <MaxNodesInQueue>100</MaxNodesInQueue>
        <EnableAutoShrink>true</EnableAutoShrink>
        <QueueName>workq</QueueName>
        <EnableAutoGrow>true</EnableAutoGrow>
        <SystemDiskLevel>PL1</SystemDiskLevel>
        <ResourceGroupId>rg-acfmxp7uc24****</ResourceGroupId>
        <SpotPriceLimit>0.062</SpotPriceLimit>
        <InstanceTypes>
            <HostNamePrefix>compute</HostNamePrefix>
            <VSwitchId>vsw-bp1lfcjbfb099rrjn****</VSwitchId>
            <ZoneId>cn-hangzhou-b</ZoneId>
            <SpotPriceLimit>0.062</SpotPriceLimit>
            <InstanceType>ecs.sn1ne.large</InstanceType>
            <SpotStrategy>NoSpot</SpotStrategy>
        </InstanceTypes>
        <DataDisks>
            <DataDiskCategory>cloud_efficiency</DataDiskCategory>
            <DataDiskSize>40</DataDiskSize>
            <DataDiskDeleteWithInstance>true</DataDiskDeleteWithInstance>
            <DataDiskPerformanceLevel>PL1</DataDiskPerformanceLevel>
            <DataDiskEncrypted>false</DataDiskEncrypted>
            <DataDiskKMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40826X</DataDiskKMSKeyId>
        </DataDisks>
    </Queues>
</GetAutoScaleConfigResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/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" : [ {
    "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" : [ {
      "HostNamePrefix" : "compute",
      "VSwitchId" : "vsw-bp1lfcjbfb099rrjn****",
      "ZoneId" : "cn-hangzhou-b",
      "SpotPriceLimit" : 0.062,
      "InstanceType" : "ecs.sn1ne.large",
      "SpotStrategy" : "NoSpot"
    } ],
    "DataDisks" : [ {
      "DataDiskCategory" : "cloud_efficiency",
      "DataDiskSize" : 40,
      "DataDiskDeleteWithInstance" : true,
      "DataDiskPerformanceLevel" : "PL1",
      "DataDiskEncrypted" : false,
      "DataDiskKMSKeyId" : "0e478b7a-4262-4802-b8cb-00d3fb40826X"
    } ]
  } ]
}

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.
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. Try again later. If the error persists, submit a ticket.
404 ClusterNotFound The specified cluster does not exist. The error message returned because the specified cluster does not exist.
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. Try again later. If the error persists, submit a ticket.
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.