1. Interface Description
Interface request domain name: cvm.api3.convergecloud.com.
This API (DescribeInstancesStatus) is used to query the status of one or more instances.
- You can query the status of an instance based on the instance ID.
- If no parameter is defined, a specific number (specified by the Limit, 20 by default) of instances of the current user are returned.
Default interface request rate limit: 20 times per second.
Interface update time: 2018-03-22 08:49:07.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeInstancesStatus |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| InstanceIds | No | No | Array of String | Query by one or more instance IDs. The instance ID is in the format of ins-11112222. For the specific format of this parameter, see the section id.N in the API Introduction. A maximum of 100 instances per request are allowed.Example: ["ins-r8hr2upy\r\n","ins-5d8a23rs\r\n"] |
| Offset | No | No | Int64 | Offset, 0 by default. For further introduction to the Offset, see relevant sections in the API Introduction.Example: 0 |
| Limit | No | No | Int64 | Number of returns, 20 by default, and the maximum value is 100. For further introduction to the Limit, see relevant sections in the API Introduction.Example: 2 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TotalCount | Int64 | Number of eligible instance statuses. Example: 2 |
| InstanceStatusSet | Array of InstanceStatus | List of Instance Status. Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or not supported, etc. |
| InternalServerError | Internal operation error. |
| InvalidParameterValue.LimitExceeded | The parameter value is out of range |
| InvalidInstanceId.Malformed | Invalid Instance ID. The format of the specified instance ID is incorrect, for example, an instance ID length error ins-1122. |