1. API Description
Domain name for API request: cbs.tencentcloudapi.com.
This API (DescribeInstancesDiskNum) is used to query the number of cloud disks mounted in the instance.
- Batch operations are supported. If multiple CVM instance IDs are specified, the returned results will list the number of cloud disks mounted on each CVM.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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: 2017-03-12. |
| Region |
No |
String |
Common Params. This parameter is not required for this API. |
| InstanceIds.N |
Yes |
Array of String |
ID of the CVM instance can be queried via the API DescribeInstances. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| AttachDetail |
Array of AttachDetail |
The quantity of mounted and mountable elastic cloud disks for each cloud virtual machine |
| RequestId |
String |
The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying the number of cloud disks attached on multiple instances
This example shows you how to query the number of cloud disks attached on multiple instances.
https:
&InstanceIds.0=ins-9w5d2buw
&InstanceIds.1=ins-jw0vit58
&<Common request parameters>
Output Example
{
"Response": {
"AttachDetail": [
{
"InstanceId": "ins-9w5d2buw",
"AttachedDiskCount": 1,
"MaxAttachCount": 10
},
{
"InstanceId": "ins-jw0vit58",
"AttachedDiskCount": 2,
"MaxAttachCount": 10
}
],
"RequestId": "55db49cf-b9d7-da27-825b-5a02ba6884ca"
}
}
5. Developer Resources
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 |
| InvalidDisk.NotPortable |
Non-elastic cloud disks are not supported. |
| InvalidDiskId.NotFound |
The ‘DiskId’ entered does not exist. |
| InvalidParameterValue |
Invalid parameter value. |
| MissingParameter |
Missing parameter. |