DescribeAutoScaleConfig - Elastic High Performance Computing

Queries 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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:DescribeAutoScaleConfig	READ	All Resources *	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
MaxNodesInCluster	integer	The maximum number of compute nodes in the cluster. This parameter indicates the largest number of nodes that can be added to the cluster.	100
GrowTimeoutInMinutes	integer	The timeout period before the scale-out nodes were started. Valid values: 10 to 60.	20
SpotStrategy	string	The bidding method of the compute nodes. Valid values: NoSpot: The instances of the compute node are pay-as-you-go instances. SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price. SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is automatically used as the bidding price.	NoSpot
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73
EnableAutoShrink	boolean	Specifies whether to enable auto scale-in.	true
ClusterType	string	The type of the scheduler. Valid values: pbs slurm opengridscheduler deadline	slurm
EnableAutoGrow	boolean	Specifies whether to enable auto scale-out.	true
ExcludeNodes	string	The list of nodes on which auto scaling is not enabled.	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 of the new ECS instance. The value is accurate to three decimal places. It takes effect only when SpotStrategy is set to SpotWithPriceLimit.	0.062
ShrinkIdleTimes	integer	The number of consecutive idle times of a node during the resource shrink check. Valid values: 2 to 5.	3
ExtraNodesGrowRatio	integer	The percentage of extra compute nodes. Valid values: 0 to 100.	0
GrowRatio	integer	The percentage of each round of scale-out. Valid values: 1 to 100.	1
Uid	string	The user ID.	testu****
ClusterId	string	The ID of the associated cluster.	ehpc-hz-FYUr32****

Examples

Sample success responses

JSONformat

{
  "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.
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.
406	DbError	A database service error occurred.	Database request failed.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
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.

For a list of error codes, visit the Service error codes.