租户端 存储 云硬盘（CBS） 快照相关接口 DescribeSnapshotGroups

DescribeSnapshotGroups

最近更新时间: 2024-12-21 13:01:31

1. 接口描述

接口请求域名： cbs.api3.gsesgpucloud.com。

本接口用于查询快照组列表，返回状态正常、创建中、回滚中的快照组列表

默认接口请求频率限制：20次/秒。

接口更新时间：2023-12-12 18:41:55。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeSnapshotGroups
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Filters 否 否 Array of Filter 过滤条件。
  • snapshot-group-id - Array of String - 是否必填：否 -（过滤条件）按快照组ID过滤 
  • snapshot-group-state - Array of String - 是否必填：否 -（过滤条件）按快照组状态过滤。(NORMAL: 正常 
    		•
    Offset 否 否 Uint64 偏移量，默认为0
    示例值：
    Limit 否 否 Uint64 返回数量，默认为20，最大值为100。
    示例值：
    Order 否 否 String 输出结果按升序还是降序，DESC表示降序，ASC表示升序
    示例值：
    InnerSearch 否 否 String 模糊搜索参数。
    示例值：

    3. 输出参数

    参数名称 类型 描述
    TotalCount Uint64 符合条件的总数量
    示例值：
    SnapshotGroupSet SnapshotGroup 快照组列表详情
    示例值：查看
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

    错误码 描述
    InvalidParameter 参数错误