DescribeInstancesStatus

Last updated: 2020-03-16 18:27:26

PDF

1. API Description

Domain name for API request: cvm.tencentcloudapi.com.

This API is used to query the status of instances.

  • You can query the status of an instance with its ID.
  • If no parameter is defined, the status of a certain number of instances under the current account will be returned. The number is specified by Limit and is 20 by default.

A maximum of 40 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

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 parameter. The value used for this API: DescribeInstancesStatus.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceIds.N No Array of String Instance ID(s) in the format of ins-xxxxxxxx. For more information on the format of this parameter, see the id.N section of API Introduction. The maximum number of instances in each request is 100.
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.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of instance states meeting the filtering conditions.
InstanceStatusSet Array of InstanceStatus List of instance states.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Viewing the list of instance status

Input Example

GET https://cvm.tencentcloudapi.com/?Action=DescribeInstancesStatus
&InstanceIds.0=ins-r8hr2upy
&InstanceIds.1=ins-5d8a23rs
&Offset=0
&Limit=2
&<common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 2,
    "InstanceStatusSet": [
      {
        "InstanceId": "ins-r8hr2upy",
        "InstanceState": "RUNNING"
      },
      {
        "InstanceId": "ins-5d8a23rs",
        "InstanceState": "STOPPED"
      }
    ],
    "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
InvalidInstanceId.Malformed Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length.
InvalidParameterValue Invalid parameter value: parameter value is in the wrong format or is not supported.
InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.