边缘计算机器查询快照列表

1. 接口描述

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

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

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

3. 输出参数

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

4. 示例

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

输入示例

https://ecm.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"
                },
                "TimeStartShare": "2020-09-22",
                "CopyFromRemote": false,
                "IsPermanent": false,
                "DiskUsage": "DATA_DISK",
                "DeadlineTime": "2019-07-15 00:00:00",
                "Percent": 100,
                "SnapshotId": "snap-lfo7xxxx",
                "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"
                },
                "TimeStartShare": "2020-09-22",
                "CopyFromRemote": false,
                "IsPermanent": false,
                "DiskUsage": "DATA_DISK",
                "DeadlineTime": "2019-07-15 00:00:00",
                "Percent": 100,
                "SnapshotId": "snap-jt5nxxxx",
                "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。

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. 错误码

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

错误码	描述
FailedOperation.OperationNotAllow	不允许执行当前操作。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.InvalidFilter	无效过滤器。
MissingParameter	缺少参数错误。

近期搜索热词

云服务器

云硬盘

容器服务

负载均衡

弹性伸缩

私有网络

云函数

API 网关

专线接入

批量计算

对象存储

微服务平台 TSF

文件存储

消息队列 CKafka 版

全站加速网络

日志服务

云数据库 MySQL

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

云数据库 Redis®

内容分发网络 CDN

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

数据传输服务

全球应用加速

腾讯云区块链服务平台 TBaaS

云拨测

访问管理

主机安全

标签

DDoS 防护

密钥管理系统

Web 应用防火墙

操作审计

域名注册

SSL 证书

短信

数据万象

NLP 技术

云点播

云市场

云加密机

云安全中心

云开发 CloudBase

人脸识别

流计算 Oceanus

腾讯云数据仓库 TCHouse-P

Elasticsearch Service

集团账号管理

图像识别

文字识别

口语评测（基础版）

媒体处理

云直播

云联络中心

机器翻译

物联网通信

人脸融合

弹性 MapReduce

游戏数据库 TcaplusDB

腾讯云 BI

游戏多媒体引擎

实时音视频

渠道合作伙伴

TI-ONE 训练平台

数据安全审计

腾讯云数据仓库 TCHouse-D

数据加速器 GooseFS

知识引擎原子能力

统一 Catalog 服务

声音复刻

文旅客情大数据

实时互动-工业能源版

腾讯健康组学平台

大模型图像创作引擎

云压测

腾讯云微搭低代码