Domain name for API request: lighthouse.tencentcloudapi.com.
This API is used to query whether the specified instance can be returned.
A maximum of 10 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: DescribeInstancesReturnable. |
Version | Yes | String | Common Params. The value used for this API: 2020-03-24. |
Region | No | String | Common Params. This parameter is not required for this API. |
InstanceIds.N | No | Array of String | Instance ID list. Each request can contain up to 100 instances at a time. You can get an instance ID from the InstanceId returned by the DescribeInstances API. |
Offset | No | Integer | Offset. Default value: 0. |
Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of eligible instances. |
InstanceReturnableSet | Array of InstanceReturnable | List of returnable instance details. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://lighthouse.tencentcloudapi.com/?Action=DescribeInstancesReturnable
&InstanceIds.0=lhins-ruy9d2tw
&InstanceIds.1=lhins-xusdke45
&<Common request parameters>
{
"Response": {
"TotalCount": 2,
"InstanceReturnableSet": [
{
"InstanceId": "lhins-ruy9d2tw",
"IsReturnable": true,
"ReturnFailCode": 0,
"ReturnFailMessage": "Returnable"
},
{
"InstanceId": "lhins-xusdke45",
"IsReturnable": false,
"ReturnFailCode": 2,
"ReturnFailMessage": "The resource has expired"
}
],
"RequestId": "3ea94867-0d80-4d22-8ba5-a8d9355efca8"
}
}
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 |
---|---|
FailedOperation | Operation failed. |
FailedOperation.DescribeInstanceStatus | An error occurred when querying the instance status. |
FailedOperation.DescribeInstancesReturnableError | An error occurred when querying whether the instance is returnable. |
InternalError.DescribeInstanceStatus | Failed to query the instance status. Please try again later. |
InternalError.DescribeInstancesReturnableError | Failed to query whether the instance can be returned. |
InvalidParameterValue.Duplicated | Invalid parameter value: duplicate values are not allowed. |
InvalidParameterValue.InstanceIdMalformed | Invalid parameter value: the instance ID format is invalid. |
InvalidParameterValue.LimitExceeded | Invalid parametric value: the number of parameter values exceeds the upper limit. |
InvalidParameterValue.Negative | Invalid parametric value: it cannot be negative. |
InvalidParameterValue.OutOfRange | Invalid parametric value: it is not within the valid range. |
ResourceNotFound.InstanceIdNotFound | The instance ID does not exist. |
UnauthorizedOperation.NoPermission | No permission |
Was this page helpful?