tencent cloud

Feedback

DescribeInstancesDiskNum

Last updated: 2022-09-26 17:00:21

1. API Description

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.

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.

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 Params. The value used for this API: DescribeInstancesDiskNum.
Version Yes String Common Params. The value used for this API: 2020-03-24.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceIds.N Yes Array of String List of instance IDs.

3. Output Parameters

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.

4. Example

Example1 Querying the number of attached cloud disks

Input Example

POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstancesDiskNum
<Common request parameters>

{
    "InstanceIds": [
        "lhins-anxwfvxh"
    ]
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "AttachDetailSet": [
            {
                "InstanceId": "lhins-anxwfvxh",
                "AttachedDiskCount": 1,
                "MaxAttachCount": 5
            }
        ],
        "RequestId": "3a73da61-4f9a-453b-bc11-553383f5d59d"
    }
}

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
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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support