查询受备份保护的实例列表
最近更新时间: 2024-09-03 18:49:42
1. 接口描述
接口请求域名： brc.api3.cloud.sunhongs.com。
本接口用于查询受备份保护的实例列表。
- 本接口用于查询实例的备份组信息，包含实例当前的备份列表，绑定的定期备份策略；
- 本接口只会返回当前存在备份组的实例。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-09-14 20:25:02。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeBackupInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2022-05-16 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| Filters | 否 | 否 | Array of Filter | 过滤条件。<br><li>instance-id - Array of String - 是否必填：否 -（过滤条件）按实例ID过滤。<br><li>auto-backup-policy-id - Array of String - 是否必填：否 -（过滤条件）按照实例绑定的定期备份策略过滤。<br><li>auto-backup-policy-name - Array of String - 是否必填：否 -（过滤条件）按照云硬盘绑定的定期备份策略名称过滤。 |
| 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 | 满足条件的数量。 |
| BackupInstanceSet | BackupInstance | 实例的备份详情。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.InvalidParameter | |
| InvalidParameter.InvalidFilter |