查询备份点列表
最近更新时间: 2026-11-06 00:09:12
1. 接口描述
接口请求域名: cbs.api3.fincloud.tencent.cn。
查询备份点列表
默认接口请求频率限制:20次/秒。
接口更新时间:2025-12-31 16:29:27。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeDiskBackups |
| Version | 是 | 否 | String | 公共参数,本接口取值:2017-03-12 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| DiskBackupIds | 否 | 否 | Array of String | 云硬盘备份点ID。云硬盘备份点ID形如:dbp-11112222。此参数的具体格式 示例值: ["dbp-704k734w"] |
| Filters | 否 | 否 | Array of Filter | 过滤条件,详见云硬盘备份点过滤条件表。参数不支持同时指定 DiskBackupIds 和 Filters。 示例值:查看 |
| Offset | 否 | 否 | Uint64 | 偏移量 示例值: 0 |
| Limit | 否 | 否 | Uint64 | 查询数量 示例值: 20 |
| Order | 否 | 否 | String | 升序降序 示例值: ASC |
| OrderField | 否 | 否 | String | 排序字段 示例值: CREATE_TIME |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | 反回总数 示例值: 1 |
| DiskBackupSet | Array of DiskBackup | 2 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 无效参数值。参数值格式错误或者参数值不被支持等。 |
| MissingParameter | 参数缺失。请求没有带必选参数。 |
| InvalidDisk.Expire | 云盘已过期。 |
| InvalidParameter | 参数错误 |
5. 示例
示例1 查询备份点列表
输入示例
https://cbs.api3.fincloud.tencent.cn/?Action=DescribeDiskBackups
&<Common Parameters>
输出示例
{
"Response": {
"TotalCount": 1,
"DiskBackupSet": [
{
"DiskBackupName": "Diskbackup-20240101",
"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"
}
}