Help Center/ Auto Scaling/ API Reference/ Historical APIs/ Querying Details About a Warm Pool

Updated on 2026-01-06 GMT+08:00

View PDF

Querying Details About a Warm Pool

This API is used to query details about the warm pool of an AS group.

This API is only available in the AP-Jakarta and LA-Sao Paulo1 regions.

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the permission listed below is required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
as:scalingGroup:getWarmPool	read	-	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

GET /autoscaling-api/{project_id}/scaling-groups/{scaling_group_id}/warm-pool

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
scaling_group_id	Yes	String	Specifies the AS group ID.

None

Query warm pool details about the AS group 5bc3aa02-b83e-454c-aba1-4d2095c68f8b.

GET https://{Endpoint}/autoscaling-api/{project_id}/scaling-groups/5bc3aa02-b83e-454c-aba1-4d2095c68f8b/warm-pool

**Table 2** Response
Parameter	Mandatory	Type	Description
warm_pool	No	object	Specifies details about a warm pool. For details, see Table 3.

**Table 3** **warm_pool** field description
Parameter	Mandatory	Type	Description
min_capacity	No	integer	Specifies the minimum capacity of a warm pool. The minimum and maximum capacities of a warm pool must either both be specified or both left blank. The minimum and maximum capacities must have the same value.
max_capacity	No	integer	Specifies the maximum capacity of a warm pool. The minimum and maximum capacities of a warm pool must either both be specified or both left blank. The minimum and maximum capacities must have the same value.
instance_init_wait_time	No	integer	Specifies the instance initialization waiting time, in seconds.
status	No	string	Specifies the warm pool status. The value can be ACTIVE, CLOSING, or CLOSED.

{
  "warm_pool": {
    "min_capacity": 1,
    "max_capacity": 1,
    "instance_init_wait_time": 30,
    "status": "ACTIVE"
  }
}

Abnormal

Returned Value	Description
400 Bad Request	The server failed to process the request.
401 Unauthorized	You must enter the username and password to access the requested page.
403 Forbidden	You are forbidden to access the requested page.
404 Not Found	The server cannot find the requested page.
405 Method Not Allowed	You are not allowed to use the method specified in the request.
406 Not Acceptable	The client does not accept the response generated by the server.
407 Proxy Authentication Required	The client must be authorized by the proxy before the request can proceed.
408 Request Timeout	The request timed out.
409 Conflict	The request cannot be processed due to a conflict.
500 Internal Server Error	Failed to complete the request. The service is abnormal.
501 Not Implemented	Failed to complete the request. The server does not support the requested function.
502 Bad Gateway	Failed to complete the request. The server received an invalid response from the upstream server.
503 Service Unavailable	Failed to complete the request. The system is abnormal.
504 Gateway Timeout	The gateway timed out.