tencent cloud

1. API Description

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

This API (DescribeDisks) is used to query the list of cloud disks.

• The details of the cloud disk can be queried based on the ID, type or status of the cloud disk. The relationship between different conditions is AND. For more information about filtering, please see the Filter.
• If the parameter is empty, a certain number (specified by Limit; the default is 20) of cloud disk lists are returned to the current user.

A maximum of 100 requests can be initiated per second for this API.

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.

3. Output Parameters

4. Example

Example1 Querying all attached data disks

This example shows you how to query all attached data disks.

Input Example

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

{
    "Filters": [
        {
            "Values": [
                "ATTACHED"
            ],
            "Name": "disk-state"
        },
        {
            "Values": [
                "DATA_DISK"
            ],
            "Name": "disk-usage"
        }
    ]
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "e2386a23-48c1-4c18-9a36-4e7354f333b2",
        "DiskSet": [
            {
                "DeleteWithInstance": false,
                "Encrypt": false,
                "DiskType": "CLOUD_BASIC",
                "AutoRenewFlagError": false,
                "Rollbacking": false,
                "RenewFlag": "NOTIFY_AND_MANUAL_RENEW",
                "DiskName": "test",
                "Tags": [],
                "InstanceId": "",
                "DifferDaysOfDeadline": 1,
                "DiskId": "disk-b94t5dzt",
                "DiskState": "ATTACHED",
                "Placement": {
                    "ProjectId": 0,
                    "Zone": "ap-guangzhou-2"
                },
                "IsReturnable": false,
                "DeadlineTime": "2018-10-26 10:55:43",
                "Attached": true,
                "DiskSize": 10,
                "DiskUsage": "DATA_DISK",
                "Portable": true,
                "DiskChargeType": "PREPAID",
                "SnapshotAbility": true,
                "DeadlineError": false,
                "RollbackPercent": 100,
                "AutoSnapshotPolicyIds": null,
                "ReturnFailCode": 3,
                "CreateTime": "2018-09-26 17:36:07",
                "ThroughputPerformance": 1,
                "Migrating": true,
                "InstanceIdList": [
                    "ins-test1234"
                ],
                "Shareable": true,
                "MigratePercent": 100,
                "SnapshotSize": 100,
                "SnapshotCount": 0,
                "BackupDisk": true,
                "AttachMode": "PF",
                "DiskBackupQuota": 1,
                "DiskBackupCount": 1,
                "DeleteSnapshot": 0,
                "InstanceType": "CVM"
            }
        ]
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

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