1. 接口描述
接口请求域名: cbs.tencentcloudapi.com 。
本接口(DescribeDiskBackups)用于查询备份点的详细信息。
根据备份点ID、创建备份点的云硬盘ID、创建备份点的云硬盘类型等对结果进行过滤,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器Filter。
如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的备份点列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDiskBackups。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DiskBackupIds.N | 否 | Array of String | 要查询备份点的ID列表。参数不支持同时指定 DiskBackupIds 和 Filters。 示例值:["dbp-xxxxxxxx"] |
Filters.N | 否 | Array of Filter | 过滤条件,参数不支持同时指定 DiskBackupIds 和 Filters。过滤条件: |
Offset | 否 | Integer | 偏移量,默认为0。关于Offset 的更进一步介绍请参考API简介中的相关小节。示例值:0 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。关于Limit 的更进一步介绍请参考 API 简介中的相关小节。示例值:20 |
Order | 否 | String | 输出云硬盘备份点列表的排列顺序。取值范围: 示例值:ASC |
OrderField | 否 | String | 云硬盘备份点列表排序的依据字段。取值范围: 默认按创建时间排序。 示例值:CREATE_TIME |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合条件的云硬盘备份点数量。 示例值:1 |
DiskBackupSet | Array of DiskBackup | 云硬盘备份点的详细信息列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询备份点列表
查询备份点列表
输入示例
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDiskBackups
<公共请求参数>
{
"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"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidFilter | 指定的Filter不被支持。 |
InvalidParameter | 参数错误。 |