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