腾讯云云硬盘快照正式商业化计费公告
腾讯云云硬盘快照跨地域复制功能正式商业化计费公告
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.
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: dbp-11112222. |
| 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: |
| OrderField | No | String | The field by which cloud disk backup points are sorted. Valid values: Backup points are sorted by creation time by default. |
| 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. |
This example shows you how to query the list of backup points.
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDiskBackups
<Common request parameters>
{
"Limit": 10,
"Offset": 0
}
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
文档反馈