DescribeSnapshots - 查询实例或云盘快照列表 - 云服务器 ECS

查询一台ECS实例或一块云盘所有的快照列表信息。例如快照状态、正在创建的快照剩余完成时间、自动快照保留天数等。

接口说明

InstanceId、DiskId和SnapshotIds不是必需的请求参数，但是可以构建过滤器逻辑，参数之间为逻辑与（And）关系。

通过阿里云 CLI 调用 API 时，不同数据类型的请求参数取值必须遵循一定的格式要求，详情请参见 CLI 参数格式说明。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecs:DescribeSnapshots	get	Snapshot `acs:ecs:{#regionId}:{#accountId}:snapshot/` *Snapshot `acs:ecs:{#regionId}:{#accountId}:snapshot/{#snapshotId}`	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	否	指定的实例 ID。	i-bp67acfmxazb4p****
DiskId	string	否	指定的云盘设备 ID。	d-bp67acfmxazb4p****
SnapshotLinkId	string	否	快照链 ID。	sl-bp1grgphbcc9brb5****
RegionId	string	是	云盘所属于的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
SnapshotIds	string	否	快照标识编码。取值可以由多个快照 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。	["s-bp67acfmxazb4p**", "s-bp67acfmxazb5p", … "s-bp67acfmxazb6p**"]
PageNumber	integer	否	快照列表的页码。起始值：1。默认值：1 。	1
PageSize	integer	否	分页查询时设置的每页行数。最大值：100。默认值：10 。	10
NextToken	string	否	查询起始标志。由上一次的请求结果中获取。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	否	分页查询时每页行数。最大值：100。默认值：10。	10
SnapshotName	string	否	快照名称。	testSnapshotName
Status	string	否	快照状态。取值范围： progressing：正在创建的快照。 accomplished：创建成功的快照。 failed：创建失败的快照。 all（默认）：所有快照状态。	all
SnapshotType	string	否	快照创建类型。取值范围： auto：自动创建快照。 user：手动创建快照。 all（默认）：所有的快照创建类型。	all
Filter.1.Key	string	否	查询资源时的筛选键，取值必须为`CreationStartTime`。同时设置`Filter.1.Key`和`Filter.1.Value`可以查询在指定时间点后创建的资源信息。	CreationStartTime
Filter.2.Key	string	否	查询资源时的筛选键，取值必须为`CreationEndTime`。同时设置`Filter.2.Key`和`Filter.2.Value`可以查询在指定时间点前创建的资源信息。	CreationEndTime
Filter.1.Value	string	否	查询资源时的筛选值。指定该参数时必须同时指定`Filter.1.Key`参数，格式为：`yyyy-MM-ddTHH:mmZ`，采用 UTC +0 时区。	2019-12-13T17:00Z
Filter.2.Value	string	否	查询资源时的筛选值。指定该参数时必须同时指定`Filter.2.Key`参数，格式为：`yyyy-MM-ddTHH:mmZ`，采用 UTC +0 时区。	2019-12-13T22:00Z
Usage	string	否	快照是否被用作创建镜像或云盘。取值范围： image：使用快照创建了自定义镜像。 disk：使用快照创建了云盘。 image_disk：使用快照创建了数据盘和自定义镜像。 none：暂未使用。	none
SourceDiskType	string	否	快照源云盘的云盘类型。取值范围： system：系统盘。 data：数据盘。说明取值不区分大小写。	system
Encrypted	boolean	否	是否过滤加密快照。默认值：false 。	false
ResourceGroupId	string	否	资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。说明不支持默认资源组过滤。	rg-bp67acfmxazb4p****
DryRun	boolean	否	是否只预检此次请求。 true：发送检查请求，不会查询资源状况。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过，则返回对应错误。如果检查通过，会返回错误码 DryRunOperation。 false（默认）：发送正常请求，通过检查后返回 2XX HTTP 状态码并直接查询资源状况。	false
KMSKeyId	string	否	数据盘对应的 KMS 密钥 ID。	0e478b7a-4262-4802-b8cb-00d3fb40****
Category	string	否	快照类型。取值范围： Standard：标准快照。 Flash：本地快照。该参数取值即将被弃用，原本地快照更替为快照极速可用功能。该参数说明如下：如果您在 2020 年 12 月 14 日之前使用过本地快照。您可以正常使用该参数。如果您在 2020 年 12 月 14 日之前未使用过本地快照。您不能使用该参数。 archive：归档快照。	Standard
Tag	array<object>	否	标签列表。
	object	否
key	string	否	资源的标签键。说明为提高兼容性，建议您尽量使用 Tag.N.Key 参数。	SnapshotTest
Key	string	否	快照的标签键。N 的取值范围：1~20。使用一个标签过滤资源，查询到该标签下的资源数量不能超过 1000 个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个，请使用 ListTagResources 接口进行查询。	TestKey
Value	string	否	快照的标签值。N 的取值范围：1~20。	TestValue
value	string	否	资源的标签值。说明为提高兼容性，建议您尽量使用 Tag.N.Value 参数。	SnapshotTest

返回参数

名称	类型	描述	示例值
	object
NextToken	string	下一个查询起始标志。	caeba0bbb2be03f84eb48b699f0a4883
PageSize	integer	输入时设置的每页行数。	10
PageNumber	integer	快照列表的页码。	1
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	快照总个数。	1
Snapshots	array<object>	快照详情集合。
Snapshot	object
Status	string	快照状态。可能值： progressing accomplished failed	accomplished
CreationTime	string	创建时间。按照ISO 8601标准表示，并使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2020-08-20T14:52:28Z
Progress	string	快照创建进度，单位为百分比。	100%
InstantAccess	boolean	是否开启了快照极速可用能力。可能值： true：开启。ESSD 云盘、ESSD Entry 云盘默认开启该能力。 false：关闭。即快照为未开启极速可用能力的标准快照。说明该参数已弃用。ESSD 云盘标准快照已升级为默认极速可用，您无需额外配置，且不产生额外花销。	false
Available	boolean	快照是否可用于创建云盘、回滚云盘、共享快照。可能值： true：可用。 false：不可用。	false
RemainTime	integer	正在创建的快照剩余完成时间，单位为秒。	38
SourceDiskSize	string	源云盘容量，单位：GiB。	40
RetentionDays	integer	自动快照保留天数。	30
SourceDiskType	string	源云盘属性。可能值： system data	system
SourceStorageType	string	原云盘类型。说明该参数即将被弃用，为提高兼容性，建议您尽量使用其他参数。	disk
Usage	string	快照是否被用作创建镜像或云盘。可能值： image disk image_disk none	image
LastModifiedTime	string	快照的最后变更时间。按照ISO 8601标准表示，并使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2020-08-25T14:18:09Z
Encrypted	boolean	该快照是否加密。	false
SnapshotType	string	快照创建类型。可能值： auto 或者 timer：自动创建快照。 user：手动创建快照。 all：所有的快照创建类型。	all
SourceDiskId	string	源云盘 ID。如果快照的源云盘已经被释放，该字段仍旧保留。	d-bp67acfmxazb4ph****
SnapshotName	string	快照显示名称。如果创建时指定了快照显示名称，则返回。	testSnapshotName
InstantAccessRetentionDays	integer	设置快照极速可用功能的保留时间，保留时间到期后自动关闭快照极速可用功能。默认与参数`RetentionDays`的值一致。说明该参数已弃用。ESSD 云盘标准快照已升级为默认极速可用，您无需额外配置，且不产生额外花销。	30
Description	string	描述信息。	testDescription
SnapshotId	string	快照 ID。	s-bp67acfmxazb4p****
RegionId	string	快照所属的地域 ID。	cn-hangzhou
ResourceGroupId	string	资源组 ID。	rg-bp67acfmxazb4p****
Category	string	快照类型。可能值： Standard：标准快照。 Flash：本地快照。该参数取值即将被弃用，原本地快照更替为快照极速可用功能。 archive：归档快照。	standard
KMSKeyId	string	数据盘对应的 KMS 密钥 ID。	0e478b7a-4262-4802-b8cb-00d3fb40****
SnapshotSN	string	快照序列号。	64472-116742336-61976****
ProductCode	string	从云市场镜像继承的产品编号。	jxsc000****
SourceSnapshotId	string	源快照。	s-bp67acfmxazb4p****
SourceRegionId	string	源快照地域。	cn-hangzhou
SnapshotLinkId	string	快照关联的快照链 ID。	sl-bp1grgphbcc9brb5****
Tags	array<object>	标签。
Tag	object
TagValue	string	快照的标签值。	TestValue
TagKey	string	快照的标签键。	TestKey

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "Snapshots": {
    "Snapshot": [
      {
        "Status": "accomplished",
        "CreationTime": "2020-08-20T14:52:28Z",
        "Progress": "100%",
        "InstantAccess": false,
        "Available": false,
        "RemainTime": 38,
        "SourceDiskSize": "40",
        "RetentionDays": 30,
        "SourceDiskType": "system",
        "SourceStorageType": "disk",
        "Usage": "image",
        "LastModifiedTime": "2020-08-25T14:18:09Z",
        "Encrypted": false,
        "SnapshotType": "all",
        "SourceDiskId": "d-bp67acfmxazb4ph****",
        "SnapshotName": "testSnapshotName",
        "InstantAccessRetentionDays": 30,
        "Description": "testDescription",
        "SnapshotId": "s-bp67acfmxazb4p****",
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Category": "standard",
        "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "SnapshotSN": "64472-116742336-61976****",
        "ProductCode": "jxsc000****",
        "SourceSnapshotId": "s-bp67acfmxazb4p****",
        "SourceRegionId": "cn-hangzhou",
        "SnapshotLinkId": "sl-bp1grgphbcc9brb5****",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	指定的 Tag.N.Key 和 Tag.N.Value 不匹配。
400	InvalidTagCount	The specified tags are beyond the permitted range.	指定的标记超出取值范围。
403	InvalidSnapshotIds.Malformed	The amount of specified specified snapshot Ids exceeds the limit.	快照 ID 参数格式不正确。
403	InvalidSnapshotCategory.Malformed	The specified Category is not valid.	指定的快照类型无效。请检查 Category 参数值是否正确。
404	InvalidFilterKey.NotFound	The specified FilterKey is not found.	指定的过滤关键字不存在。
404	InvalidFilterValue	The specified FilterValue exceeds the limit.	输入的过滤值超出限制
404	InvalidUsage	The specifed Usage is not valid.	指定的参数 Usage 值不合法。
404	InvalidSourceDiskType	The specifed SourceDiskType is not valid.	-
404	InvalidStatus.NotFound	The specified Status is not found.	指定的资源状态不存在。
404	InvalidSnapshotType.NotFound	The specfied SnapshotType is not found.	-
404	InvalidSnapshotLinkId.NotFound	The specified snapshot link is not found.	指定的快照链不存在。
500	InternalError	The request processing has failed due to some unknown error.	内部错误，请重试。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-05-22	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-02-01	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-09-18	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情