API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

1. 接口描述

本接口(DescribeSnapshots)用于查询快照的详细信息。

  • 根据快照ID、创建快照的云硬盘ID、创建快照的云硬盘类型等对结果进行过滤,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器Filter
  • 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的快照列表。接口请求域名: cbs.tencentcloudapi.com 。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSnapshots。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
SnapshotIds.N Array of String 要查询快照的ID列表。参数不支持同时指定SnapshotIdsFilters
Filters.N Array of Filter 过滤条件。参数不支持同时指定SnapshotIdsFilters
  • snapshot-id - Array of String - 是否必填:否 -(过滤条件)按照快照的ID过滤。快照ID形如:snap-11112222
  • snapshot-name - Array of String - 是否必填:否 -(过滤条件)按照快照名称过滤。
  • snapshot-state - Array of String - 是否必填:否 -(过滤条件)按照快照状态过滤。 (NORMAL:正常 | CREATING:创建中 | ROLLBACKING:回滚中。)
  • disk-usage - Array of String - 是否必填:否 -(过滤条件)按创建快照的云盘类型过滤。 (SYSTEM_DISK:代表系统盘 | DATA_DISK:代表数据盘。)
  • project-id - Array of String - 是否必填:否 -(过滤条件)按云硬盘所属项目ID过滤。
  • disk-id - Array of String - 是否必填:否 -(过滤条件)按照创建快照的云硬盘ID过滤。
  • zone - Array of String - 是否必填:否 -(过滤条件)按照可用区过滤。
  • encrypt - Array of String - 是否必填:否 -(过滤条件)按是否加密盘快照过滤。 (TRUE:表示加密盘快照 | FALSE:表示非加密盘快照。)
  • snapshot-type- Array of String - 是否必填:否 -(过滤条件)根据snapshot-type指定的快照类型查询对应的快照。
    (SHARED_SNAPSHOT:表示共享过来的快照 | PRIVATE_SNAPSHOT:表示自己私有快照。)
  • Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考API简介中的相关小节。
    Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    Order String 输出云盘列表的排列顺序。取值范围:
  • ASC:升序排列
  • DESC:降序排列。
  • OrderField String 快照列表排序的依据字段。取值范围:
  • CREATE_TIME:依据快照的创建时间排序
    默认按创建时间排序。
  • 3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 快照的数量。
    SnapshotSet Array of Snapshot 快照的详情列表。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询广州二区状态为NORMAL的快照

    输入示例

    https://cbs.tencentcloudapi.com/?Action=DescribeSnapshots
    &Filters.0.Name=snapshot-state
    &Filters.0.Values.0=NORMAL
    &Filters.1.Name=zone
    &Filters.1.Values.0=ap-guangzhou-2
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 2,
            "RequestId": "4ab150b9-538d-48fb-8821-7fa185f1d07c",
            "SnapshotSet": [
                {
                    "Placement": {
                        "ProjectId": 0,
                        "Zone": "ap-guangzhou-2"
                    },
                    "CopyFromRemote": false,
                    "IsPermanent": false,
                    "DiskUsage": "DATA_DISK",
                    "DeadlineTime": "2019-07-15 00:00:00",
                    "Percent": 100,
                    "SnapshotId": "snap-lfo71d1x",
                    "ShareReference": 0,
                    "SnapshotType": "PRIVATE_SNAPSHOT",
                    "DiskSize": 10,
                    "DiskId": "disk-aq3k1jn0",
                    "SnapshotName": "auto_disk-aq3k1jn0_20190708_00",
                    "Images": [],
                    "CopyingToRegions": [],
                    "Encrypt": false,
                    "CreateTime": "2019-07-08 00:03:13",
                    "ImageCount": 0,
                    "SnapshotState": "NORMAL"
                },
                {
                    "Placement": {
                        "ProjectId": 0,
                        "Zone": "ap-guangzhou-2"
                    },
                    "CopyFromRemote": false,
                    "IsPermanent": false,
                    "DiskUsage": "DATA_DISK",
                    "DeadlineTime": "2019-07-15 00:00:00",
                    "Percent": 100,
                    "SnapshotId": "snap-jt5npvml",
                    "ShareReference": 0,
                    "SnapshotType": "PRIVATE_SNAPSHOT",
                    "DiskSize": 10,
                    "DiskId": "disk-38hlz2p0",
                    "SnapshotName": "auto_disk-38hlz2p0_20190708_00",
                    "Images": [],
                    "CopyingToRegions": [],
                    "Encrypt": false,
                    "CreateTime": "2019-07-08 00:03:10",
                    "ImageCount": 0,
                    "SnapshotState": "NORMAL"
                }
            ]
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidFilter 指定的Filter不被支持。
    InvalidParameterValue 参数取值错误。
    MissingParameter 缺少参数错误。
    UnsupportedOperation 操作不支持。
    目录