云硬盘查询快照组列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cbs.tencentcloudapi.com 。

本接口（DescribeSnapshotGroups）用于查询快照组列表。

可以根据快照组ID、快照组状态、快照组关联的快照ID等来查询快照组列表，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器Filter。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的快照组列表。

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSnapshotGroups。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
Filters.N	否	Array of Filter	过滤条件。 <li>snapshot-group-id - Array of String - 是否必填：否 -（过滤条件）按快照组ID过滤 <li>snapshot-group-state - Array of String - 是否必填：否 -（过滤条件）按快照组状态过滤。(NORMAL: 正常 \| CREATING:创建中 \| ROLLBACKING:回滚中) <li>snapshot-group-name - Array of String - 是否必填：否 -（过滤条件）按快照组名称过滤 <li>snapshot-id - Array of String - 是否必填：否 -（过滤条件）按快照组内的快照ID过滤
Offset	否	Integer	偏移量，默认为0。示例值：0
Limit	否	Integer	返回数量，默认为20，最大值为100。示例值：20

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的总数量。示例值：100
SnapshotGroupSet	Array of SnapshotGroup	快照组列表详情。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询所有快照组列表

查询所有快照组列表

输入示例

https://cbs.tencentcloudapi.com/?Action=DescribeSnapshotGroups
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 2,
        "RequestId": "8c068f14-5e4d-471a-ab1f-26890ada5952",
        "SnapshotGroupSet": [
            {
                "SnapshotGroupId": "csnap-csoplz7u",
                "SnapshotGroupType": "NORMAL",
                "ContainRootSnapshot": true,
                "SnapshotIdSet": [
                    "snap-31gfd8na",
                    "snap-patkqtz4",
                    "snap-1yirzaum"
                ],
                "SnapshotGroupState": "ROLLBACKING",
                "Percent": 100,
                "SnapshotGroupName": "aubreyxu2",
                "ModifyTime": "2020-09-22T00:00:00+00:00",
                "Images": [],
                "CreateTime": "2020-09-22T00:00:00+00:00",
                "ImageCount": 0,
                "DeadlineTime": null,
                "IsPermanent": true
            },
            {
                "SnapshotGroupId": "csnap-orard7la",
                "SnapshotGroupType": "NORMAL",
                "ContainRootSnapshot": true,
                "SnapshotIdSet": [
                    "snap-50j8l0o8"
                ],
                "SnapshotGroupState": "NORMAL",
                "Percent": 100,
                "SnapshotGroupName": "aubreyxu1",
                "ModifyTime": "2020-09-22T00:00:00+00:00",
                "Images": [
                    {
                        "ImageName": "快照组自定义镜像",
                        "ImageId": "img-nmz7p8wt"
                    }
                ],
                "CreateTime": "2020-09-22T00:00:00+00:00",
                "ImageCount": 1,
                "DeadlineTime": null,
                "IsPermanent": true
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidFilter	指定的Filter不被支持。
InvalidParameter	参数错误。

查询快照组列表

本页目录：