Query auto scaling settings with DescribeAutoScaleConfig - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries the auto scaling configuration of a specified 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:DescribeAutoScaleConfig

*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 maximum number of compute nodes that can be added to the cluster.	100
GrowTimeoutInMinutes	integer	The timeout period for starting scale-out nodes. Valid values: 10 to 60.	20
SpotStrategy	string	The bidding method for compute nodes. Valid values: NoSpot: The compute nodes are pay-as-you-go instances. SpotWithPriceLimit: The compute nodes are preemptible instances with a user-defined maximum hourly price. SpotAsPriceGo: The compute nodes are preemptible instances that use the market price at the time of purchase as the bid price.	NoSpot
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73
EnableAutoShrink	boolean	Indicates whether auto scale-in is enabled.	true
ClusterType	string	The scheduler type. Valid values: pbs slurm opengridscheduler deadline	slurm
EnableAutoGrow	boolean	Indicates whether auto scale-out is enabled.	true
ExcludeNodes	string	The nodes excluded from auto scaling.	i-bp19lgqwxb4206t5**,i-bp1g4hvzs9pywrhb**
GrowIntervalInMinutes	integer	The interval between two consecutive rounds of scale-in. Valid values: 2 to 10.	10
ShrinkIntervalInMinutes	integer	The interval between two consecutive rounds of scale-out. Valid values: 2 to 10.	2
SpotPriceLimit	string	The maximum hourly price for the ECS instance, accurate to three decimal places. Takes effect only when SpotStrategy is set to SpotWithPriceLimit.	0.062
ShrinkIdleTimes	integer	The number of consecutive times a node must be idle during scale-in checks before it is removed. Valid values: 2 to 5.	3
ExtraNodesGrowRatio	integer	The percentage of extra compute nodes. Valid values: 0 to 100.	0
GrowRatio	integer	The scale-out percentage per round. Valid values: 1 to 100.	1
Uid	string	The user ID.	testu****
ClusterId	string	The cluster ID.	ehpc-hz-FYUr32****

Examples

Success response

JSON format

{
  "MaxNodesInCluster": 100,
  "GrowTimeoutInMinutes": 20,
  "SpotStrategy": "NoSpot",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73",
  "EnableAutoShrink": true,
  "ClusterType": "slurm",
  "EnableAutoGrow": true,
  "ExcludeNodes": "i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****",
  "GrowIntervalInMinutes": 10,
  "ShrinkIntervalInMinutes": 2,
  "SpotPriceLimit": "0.062",
  "ShrinkIdleTimes": 3,
  "ExtraNodesGrowRatio": 0,
  "GrowRatio": 1,
  "Uid": "testu****",
  "ClusterId": "ehpc-hz-FYUr32****"
}

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.