1. 接口描述
接口请求域名: cbs.api3.gsesgpucloud.com。
本接口(DescribeSnapshots)用于查询快照的详细信息。
- 根据快照ID、创建快照的云硬盘ID、创建快照的云硬盘类型等对结果进行过滤,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器
Filter
。 - 如果参数为空,返回当前用户一定数量(
Limit
所指定的数量,默认为20)的快照列表。
默认接口请求频率限制:20次/秒。
接口更新时间:2024-08-14 00:44:35。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:DescribeSnapshots |
Version | 是 | 否 | String | 公共参数,本接口取值:2017-03-12 |
Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
SnapshotIds | 否 | 否 | Array of String | 要查询快照的ID列表。参数不支持同时指定SnapshotIds 和Filters 。示例值: |
Filters | 否 | 否 | Array of Filter | 过滤条件。参数不支持同时指定SnapshotIds 和Filters 。snap-11112222 。 |
Offset | 否 | 否 | Uint64 | 偏移量,默认为0。 示例值: |
Limit | 否 | 否 | Uint64 | 返回数量,默认为20,最大值为100。 示例值: |
Order | 否 | 否 | String | 输出云盘列表的排列顺序。取值范围: 示例值: |
OrderField | 否 | 否 | String | 快照列表排序的依据字段。取值范围: 默认按创建时间排序。 示例值: |
InnerSearch | 否 | 否 | String | 模糊搜索参数。 示例值: |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Uint64 | 快照的数量。 示例值: |
SnapshotSet | Snapshot | 快照的详情列表。 示例值:查看 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue | 无效参数值。参数值格式错误或者参数值不被支持等。 |
MissingParameter | 参数缺失。请求没有带必选参数。 |
InvalidFilter | 指定的Filter不被支持。 |