Queries the information of instances.
Operation description
You can call this API operation to query the list of instances. The returned instances are ranked in descending order based on the values of GmtCreate. You can specify multiple request parameters. These request parameters can be used to filter query results. The request parameters that you specify have logical AND relations. Only the specified parameters can be used to filter query results.
Debugging
Authorization information
Request syntax
GET /v2/openapi/instances
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
page | integer | No | GET /openapi/instances?name=test&instanceId=abc&page=1&size=10 | 1 |
size | integer | No | 10 | |
status | string | No | Running | |
name | string | No | The number of the page to return. Default value: 1. | The number of entries to return on each page. Valid values: 1 to 50. Default value: 10. |
expiredTime | string | No | The state of the instance. Valid values: Running, Ready, Initializing, and Starting. | 1608533404 |
instanceId | string | No | The name of the instance. Fuzzy match is supported. | Test instance |
Response parameters
Examples
Sample success responses
JSON
format
{
"result": [
{
"regionId": "cn-beijing",
"type": "Standard",
"lockMode": "Unlock",
"expiredTime": "2019-01-06T16:00:00.000Z",
"status": "Running",
"gmtCreate": "2018-12-06T06:14:01.000Z",
"chargeType": "PrePaid",
"industry": "news",
"commodityCode": "airecpre",
"gmtModified": "2018-12-06T11:17:49.000Z",
"dataSetVersion": "20181206170353",
"name": "The time when the instance was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.\n",
"instanceId": "The name of the instance.\n"
}
],
"code": "InternalServerError",
"requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
"message": "An internal server error occurred"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|