Help & DocumentationCloud Block StorageAPI DocumentationCloud Disk APIsDescribeInstancesDiskNum

DescribeInstancesDiskNum

Last updated: 2020-02-03 20:12:47

PDF

Contents：

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.

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: cbs.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: DescribeInstancesDiskNum
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 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 Mounted on Multiple Instances

Input Example

https://cbs.tencentcloudapi.com/?Action=DescribeInstancesDiskNum
&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

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
InvalidDisk.NotPortable Non-elastic cloud disk not supported.
InvalidDiskId.NotFound The ‘DiskId’ entered does not exist.
InvalidParameterValue Invalid parameter value. Parameter value format error or parameter value not supported.
MissingParameter Missing parameter. Request does not include the required parameter.