Query cluster auto scaling settings using GetAutoScaleConfig - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Retrieves the auto scaling configuration of a cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ehpc:GetAutoScaleConfig

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	ehpc-hz-FYUr32****

Response elements

Element	Type	Description	Example
	object
MaxNodesInCluster	integer	The interval between two consecutive rounds of scale-in. Unit: minutes. Valid values: 2 to 10. Note An interval may exist during multiple rounds of a scale-out task or between two consecutive scale-out tasks.	300
GrowTimeoutInMinutes	integer	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.	20
SpotStrategy	string	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.	SpotWithPriceLimit
EnableAutoShrink	boolean	The number of consecutive times that a compute node is idle 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 three consecutive times. In this case, the node is released.	true
RequestId	string	The image ID of the compute nodes in the queue.	04F0F334-1335-436C-A1D7-6C044FE73368
EnableAutoGrow	boolean	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.	true
ClusterType	string	The ID of the cluster.	pbs
ExcludeNodes	string	The ID of the Alibaba Cloud account.	i-bp19lgqwxb4206t5**,i-bp1g4hvzs9pywrhb**
ShrinkIntervalInMinutes	integer	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.	2
GrowIntervalInMinutes	integer	The image ID of the compute nodes in the queue.	2
SpotPriceLimit	number	The type of the system disk. Valid values: cloud_efficiency: ultra disk cloud_ssd: SSD cloud_essd: ESSD cloud: basic disk	0.062
ExtraNodesGrowRatio	integer	The instance type of the compute nodes that were automatically added in the queue.	2
ShrinkIdleTimes	integer	The suffix of the queue name. You can query queues that have a specified suffix.	3
ImageId	string	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.	m-bp10txryr4mhrrt1****
GrowRatio	integer	The minimum number of compute nodes that can be retained in a queue. Valid values: 0 to 50.	100
ClusterId	string	The prefix of the queue name. You can query queues that have a specified prefix.	ehpc-hz-FYUr32****
Uid	string	The size of the system disk. Unit: GB. Valid values: 40 to 500.	129845258050****
Queues	object
QueueInfo	array<object>	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.
	array<object>
QueueImageId	string	The image ID of the compute node in the queue.	centos_7_06_64_20G_alibase_2019071****
SystemDiskCategory	string	The category of the system disk. Valid values: cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: enhanced SSD (ESSD). cloud: basic disk.	cloud_efficiency
InstanceType	string	The instance type of the compute nodes that are automatically added to the queue.	ecs.sn1ne.large
HostNameSuffix	string	The suffix of the queue name. You can query queues that have a specified suffix.	000
SpotStrategy	string	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.	NoSpot
MinNodesInQueue	integer	The minimum number of compute nodes that can be retained in a queue. Valid values: 0 to 50.	10
HostNamePrefix	string	The prefix of the queue name. You can query queues that have a specified prefix.	compute
SystemDiskSize	integer	The system disk size. Unit: GB. Valid values: 40 to 500.	40
MaxNodesInQueue	integer	The maximum number of compute nodes that can be added to a queue. Valid values: 0 to 500.	100
EnableAutoShrink	boolean	Indicates whether the queue enabled the auto scale-in. Valid values: true false	true
QueueName	string	The name of the queue.	workq
EnableAutoGrow	boolean	Indicates whether the queue enabled the auto scale-out. Valid values: true false	true
SystemDiskLevel	string	The performance level of the system disk. Valid values: PL0: An ESSD can deliver up to 10,000 random read/write IOPS. PL1: An ESSD can deliver up to 50,000 random read/write IOPS. PL2: An ESSD can deliver up to 100,000 random read/write IOPS. PL3: An ESSD can deliver up to 1,000,000 random read/write IOPS.	PL1
ResourceGroupId	string	The ID of the resource group to which the compute nodes belong.	rg-acfmxp7uc24****
SpotPriceLimit	number	The maximum hourly price of the compute nodes. The value can be accurate to three decimal places. This parameter is valid only when the SpotStrategy parameter is set to SpotWithPriceLimit.	0.062
InstanceTypes	object
InstanceTypeInfo	array<object>	The specification information of the compute nodes.
	object
HostNamePrefix	string	The prefix of the hostname. You can query compute nodes that have a specified prefix.	compute
VSwitchId	string	The ID of the vSwitch.	vsw-bp1lfcjbfb099rrjn****
ZoneId	string	The ID of the zone.	cn-hangzhou-b
SpotPriceLimit	number	The maximum hourly price of the compute nodes. The value can be accurate to three decimal places. This parameter is valid only when the SpotStrategy parameter is set to SpotWithPriceLimit.	0.062
InstanceType	string	The instance type of the compute nodes.	ecs.sn1ne.large
SpotStrategy	string	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.	NoSpot
SpotDuration	integer	The protection period of the preemptible instance. Unit: hours. Valid values: 0 to 1. Default value: 1. A value of 0 means no protection period is specified.	0
SpotInterruptionBehavior	string	The interruption event of the preemptible instance. The value can only be Terminate, which specifies that the instance is released.	Terminate
DataDisks	object
DataDisksInfo	array<object>	The list of data disks.
	object
DataDiskCategory	string	The type of the data disk. Valid values: cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: ESSD. cloud: basic disk.	cloud_efficiency
DataDiskSize	integer	The capacity of the data disk. Unit: GB. Valid values: 40 to 500.	40
DataDiskDeleteWithInstance	boolean	Indicates whether the data disk is released when the node is released. Valid values: true false	true
DataDiskPerformanceLevel	string	The performance level of the ESSD used as the data disk. The parameter is returned only when the DataDisks.N.DataDiskCategory parameter is set to cloud_essd. Valid values: PL0: An ESSD can deliver up to 10,000 random read/write IOPS. PL1: An ESSD can deliver up to 50,000 random read/write IOPS. PL2: An ESSD can deliver up to 100,000 random read/write IOPS. PL3: An ESSD can deliver up to 1,000,000 random read/write IOPS.	PL1
DataDiskEncrypted	boolean	Indicates whether the data disk is encrypted. Valid values: true false	false
DataDiskKMSKeyId	string	The ID of the KMS key that is used by the data disk.	0e478b7a-4262-4802-b8cb-00d3fb40826X
MaxNodesPerCycle	integer	The maximum number of compute nodes that can be added in each round of scale-out. Valid values: 0 to 99. Default value: 0.	20
MinNodesPerCycle	integer	The minimum number of compute nodes that can be added in each round of scale-out. Valid values: 1 to 99 Default value: 1. If the compute nodes that you want to add in a round is less than the minimum compute nodes that can be added, the value of this parameter is automatically changed to the number of compute nodes that you want to add. This ensures that compute nodes can be added as expected. Note The configuration takes effect only for the minimum compute nodes that can be added in the current round.	5
AutoMinNodesPerCycle	boolean	Indicates whether the minimum node number for each scale-out is automatically set. If this parameter is set to true, the minimum number of nodes for each scale-out is equal to the number of nodes required by the job. The maximum number is 99.	false
SortedByInventory	boolean	Indicates whether the instances are unordered. Valid values: true false Note If this parameter is set to true, the system selects instance types in descending order based on the number of instances in stock during auto scaling.	false
ComputeEnableHt	boolean	Specifies whether to enable hyper-threading for the ECS instance that is used as the compute node. Note You can only disable hyper-threading for some instance types. The hyper-threading is enabled for ECS instances by default. For more information, see Specify and view CPU options.	true
DnsConfig	string	The DNS configuration.	"{\"DnsType\":\"PrivateZone\",\"DnsName\":\"xxxxx\"}"

Examples

Success response

JSON format

{
  "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\\\"}\""
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
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.	The specified instance does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.
406	DbError	A database service error occurred.	Database request failed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.