Release Notes
Public Image Release Notes
Official End of Support Plan for the Operating System
Announcements
Domain name for API request: cvm.intl.tencentcloudapi.com.
This API is used to query the status of instances.
ID.Limit and is 20 by default.A maximum of 40 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeInstancesStatus. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| InstanceIds.N | No | Array of String | Query by instance ID(s). For example, instance ID: ins-xxxxxxxx. For the specific format, refer to section Ids.N of the API Introduction. You can query up to 100 instances in each request. |
| Offset | No | Integer | Offset; default value: 0. For more information on Offset, see the corresponding section in API Introduction. |
| Limit | No | Integer | Number of results returned; default value: 20; maximum: 100. For more information on Limit, see the corresponding section in API Introduction. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of instance states meeting the filtering conditions. |
| InstanceStatusSet | Array of InstanceStatus | Instance status list. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query the status of two specified instances.
POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstancesStatus
<Common request parameters>
{
"InstanceIds": [
"ins-r8hr2upy",
"ins-5d8a23rs"
],
"Offset": 0,
"Limit": 10
}{
"Response": {
"TotalCount": 2,
"InstanceStatusSet": [
{
"InstanceId": "ins-r8hr2upy",
"InstanceState": "RUNNING"
},
{
"InstanceId": "ins-5d8a23rs",
"InstanceState": "STOPPED"
}
],
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalServerError | Internal error. |
| InvalidFilter | Invalid filter. |
| InvalidInstanceId.Malformed | Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.InstanceIdMalformed | Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number). |
| InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
| UnauthorizedOperation.InvalidToken | Check if the token is valid. |
| UnsupportedOperation | Unsupported operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback