Domain name for API request: lighthouse.tencentcloudapi.com.
This API is used to query the number of cloud disks attached to instances.
A maximum of 20 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: DescribeInstancesDiskNum. |
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 | Yes | Array of String | List of instance IDs. |
Parameter Name | Type | Description |
---|---|---|
AttachDetailSet | Array of AttachDetail | Information of all attached disks |
TotalCount | Integer | Number of attached cloud disks |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstancesDiskNum
<Common request parameters>
{
"InstanceIds": [
"lhins-anxwfvxh"
]
}
{
"Response": {
"TotalCount": 1,
"AttachDetailSet": [
{
"InstanceId": "lhins-anxwfvxh",
"AttachedDiskCount": 1,
"MaxAttachCount": 5
}
],
"RequestId": "3a73da61-4f9a-453b-bc11-553383f5d59d"
}
}
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 |
---|---|
InvalidParameter | Incorrect parameter. |
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. |
ResourceNotFound.InstanceIdNotFound | The instance ID does not exist. |
ResourceNotFound.InstanceNotFound | The instance does not exist. |
Was this page helpful?