Help Center/ Auto Scaling/ API Reference/ Historical APIs/ Querying Instances in a Warm Pool

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

View PDF

Querying Instances in a Warm Pool

Function

This API is used to query instances in the warm pool of an AS group.

Constraints

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

Authorization

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:listWarmPoolInstances	list	-	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

URI

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

**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.
limit	No	String	Specifies the number of records on each page. The default value is 20. Value range: 0 to 100
marker	No	String	Specifies the marker for pagination.

Request

None

Example Request

Query instances in the warm pool of the AS group 5bc3aa02-b83e-454c-aba1-4d2095c68f8b.

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

Response

**Table 2** Response
Parameter	Mandatory	Type	Description
page_info	No	page_info object	Specifies pagination. For details, see Table 3.
warm_pool_instances	No	Array of warm_pool_instances objects	Specifies instances in a warm pool. For details, see Table 4.

**Table 3** **page_info** field description
Parameter	Mandatory	Type	Description
next_marker	No	String	Specifies the marker of the next page.

**Table 4** **warm_pool_instances** field description
Parameter	Mandatory	Type	Description
id	No	String	Specifies the instance ID.
instance_id	No	String	Specifies the VM ID.
name	No	String	Specifies the instance name.
status	No	String	Specifies the instance status.

Example Response

 {
  "page_info": {
    "next_marker": "xxxx"
  },
  "warm_pool_instances": [
    {
      "id": "xxxx",
      "instance_id": "xxxxx",
      "name": "xxxx",
      "status": "PENDING"
    }
  ]
}

Returned Values

Normal
200

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.