查询云硬盘备份列表
最近更新时间: 2024-09-03 18:49:42
1. 接口描述
接口请求域名： brc.api3.cloud.sunhongs.com。
本接口用于查询云硬盘备份列表。
- 可以根据备份ID、备份状态等信息来查询云硬盘备份的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器
Filter。 - 如果参数为空，返回当前用户一定数量（
Limit所指定的数量，默认为20）的云硬盘备份列表。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-09 16:45:03。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeBackups |
| Version | 是 | 否 | String | 公共参数，本接口取值：2022-05-16 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| Filters | 否 | 否 | Array of Filter | 过滤条件。<br><li>backup-id - Array of String - 是否必填：否 -（过滤条件）按照备份的ID过滤。快照ID形如：backup-11112222。<br><li>backup-name - Array of String - 是否必填：否 -（过滤条件）按照备份名称过滤。<br><li>backup-state - Array of String - 是否必填：否 -（过滤条件）按照备份状态过滤。 (NORMAL：正常 | CREATING：创建中 | ROLLBACKING：回滚中。)<br><li>disk-usage - Array of String - 是否必填：否 -（过滤条件）按创建快照的云盘类型过滤。 (SYSTEM_DISK：代表系统盘 | DATA_DISK：代表数据盘。)<br><li>platform-project-id - Array of String - 是否必填：否 -（过滤条件）按备份所属项目ID过滤。<br><li>disk-id - Array of String - 是否必填：否 -（过滤条件）按照创建备份的云硬盘ID过滤。<br><li>zone - Array of String - 是否必填：否 -（过滤条件）按照可用区过滤。<br><li>backup-group-id - Array of String - 是否必填：否 -（过滤条件）按照备份绑定的备份组ID过滤。 |
| Offset | 否 | 否 | Uint64 | 偏移量，默认为0。 |
| Limit | 否 | 否 | Uint64 | 返回数量，默认为20，最大值为100。 |
| Order | 否 | 否 | String | 输出列表的排列顺序。取值范围：<br><li>ASC：升序排列<br><li>DESC：降序排列。 |
| OrderField | 否 | 否 | String | 备份列表排序的依据字段。取值范围：<br><li>CREATE_TIME：依据备份的创建时间排序<br>默认按创建时间排序。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | 备份的数量 |
| BackupSet | Backup | 云硬盘备份列表详情。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.InvalidValue | |
| InvalidParameter.MissingParameter | |
| InvalidParameter.InvalidFilter |