查询快照列表

最近更新时间:2018-07-27 21:02:20

1. 接口描述

接口请求域名: cbs.tencentcloudapi.com

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

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

接口请求频率限制:20次/每秒

注意:本接口支持金融区地域。公共参数 Region 为金融区地域时,需要同时指定带金融区地域的域名,例如:cbs.ap-shanghai-fsi.tencentcloudapi.com

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:表示非加密盘快照。)
  • 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. 错误码

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

    错误码 描述
    InvalidFilter 指定的Filter不被支持。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    MissingParameter 参数缺失。请求没有带必选参数。

    5. 示例

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

    输入示例

    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": {
        "RequestId": "3a823099-86f1-6887-6273-5a1f8043d8a3",
        "SnapshotSet": [
          {
            "CreateTime": "2018-04-12 17:34:45",
            "DeadlineTime": null,
            "DiskId": "disk-22rkwrvw",
            "DiskSize": 10,
            "DiskUsage": "DATA_DISK",
            "Encrypt": false,
            "IsPermanent": true,
            "Percent": 100,
            "Placement": {
              "ProjectId": 0,
              "Zone": "ap-guangzhou-2"
            },
            "SnapshotId": "snap-1i97mf6d",
            "SnapshotName": "test_snap_count",
            "SnapshotState": "NORMAL"
          }
        ],
        "TotalCount": 1
      }
    }

    6. 其他资源

    云 API 3.0 提供了配套的开发工具,能更方便的调用 API 。