DescribeInstancesDiskNum

Last updated: 2019-09-09 20:17:33

PDF

1. API Description

Domain name for API request: cbs.tencentcloudapi.com.

This API (DescribeInstancesDiskNum) is used to query the number of cloud disks mounted to the specified instances.

  • 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.

Default request rate limit: 20/sec.

Note: This API supports finance AZs. As finance AZs and non-finance AZs are isolated, when accessing the services in a finance AZ (with the common parameter Region specifying a financial availability zone), it is necessary to specify a domain name with the finance AZ, preferably in the same region as specified in Region.

2. Input Parameters

The list below contains only the API request parameters and certain common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. Value used in 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, see List of Regions supported by the product.
InstanceIds.N Yes Array of String CVM instance ID, which can be queried via the API DescribeInstances

3. Output Parameters

Parameter Name Type Description
AttachDetail Array of AttachDetail The number of mounted and mountable elastic cloud disks of each Cloud Virtual Machine.
RequestId String Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Samples

Sample 1. Querying the Number of Mounted Cloud Disks of Multiple Instances

Input Sample Code

https://cbs.tencentcloudapi.com/?Action=DescribeInstancesDiskNum
&InstanceIds.0=ins-9w5d2buw
&InstanceIds.1=ins-jw0vit58
&<Common request parameters>

Output Sample Code

{
  "Response": {
    "AttachDetail": [
      {
        "InstanceId": "ins-9w5d2buw",
        "AttachedDiskCount": 1,
        "MaxAttachCount": 10
      },
      {
        "InstanceId": "ins-jw0vit58",
        "AttachedDiskCount": 2,
        "MaxAttachCount": 10
      }
    ],
    "RequestId": "55db49cf-b9d7-da27-825b-5a02ba6884ca"
  }
}

5. Resources for Developers

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 comes with SDKs that support multiple programming languages and make it easier to call the APIs.

Command line tools

6. Error Codes

The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

Error Code Description
InvalidDisk.NotPortable Non-elastic cloud disks are not supported.
InvalidDiskId.NotFound The DiskId does not exist.
InvalidParameterValue Invalid parameter value. Parameter value is in an incorrect format or is not supported.
MissingParameter Missing parameter. A required parameter is missing in the request.