tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDiskBackups

Last updated: 2023-06-21 15:01:17

1. API Description

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

This API is used to query the details of backup points.

You can filter results by backup point ID. You can also look for certain backup points by specifying the ID or type of the cloud disk for which the backup points are created. The relationship between different filters is logical AND. For more information on filters, see Filter.
If the parameter is empty, a certain number (as specified by Limit and 20 by default) of backup points will be returned.

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: DescribeDiskBackups.
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.
DiskBackupIds.N No Array of String List of IDs of the backup points to be queried. DiskBackupIds and Filters cannot be specified at the same time.
Filters.N No Array of Filter Filter. DiskBackupIds and Filters cannot be specified at the same time. Valid values:
  • disk-backup-id - Array of String - Required: No - (Filter) Filter by backup point ID in the format of dbp-11112222.

  • disk-id - Array of String - Required: No - (Filter) Filter by ID of the cloud disk for which backup points are created.

  • disk-usage - Array of String - Required: No - (Filter) Filter by type of the cloud disk for which backup points are created. (SYSTEM_DISK: System disk | DATA_DISK: Data disk)
    		•
    Offset No Integer Offset. Default value: 0. For more information on Offset, see the relevant section of the API Overview.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant section of the API Overview.
    Order No String Sorting order of cloud disk backup points. Valid values:
  • ASC: Ascending
  • DESC: Descending
    		•
    OrderField No String The field by which cloud disk backup points are sorted. Valid values:
  • CREATE_TIME: Sort by creation time
    Backup points are sorted by creation time by default.
    		•

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible cloud disk backup points.
    DiskBackupSet Array of DiskBackup List of details of cloud disk backup points.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the list of backup points

    This example shows you how to query the list of backup points.

    Input Example

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

{
    "Limit": 10,
    "Offset": 0
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "DiskBackupSet": [
            {
                "DiskBackupName": "11111",
                "Encrypt": false,
                "Percent": 100,
                "DiskBackupId": "dbp-xxxxxxxx",
                "DiskSize": 100,
                "DiskBackupState": "NORMAL",
                "DiskUsage": "DATA_DISK",
                "CreateTime": "2022-04-02T17:44:55+00:00",
                "DiskId": "disk-xxxxxxxx"
            }
        ],
        "RequestId": "6cd062f5-aa65-4477-a253-1ab41ab963fd"
    }
}

    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
    InvalidFilter The specified Filter is not supported.
    InvalidParameter Incorrect parameter.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy