DescribeSnapshots_云服务器 ECS_API文档-阿里云OpenAPI开发者门户

接口说明

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

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

请求示例：

查询杭州地域下 ECS 实例所有云盘的快照信息列表

RegionId:  cn-hangzhou,   //设置华东 1（杭州）地域。
InstanceId:  i-bp1fh7by6d9mw7zr****   //设置待查询的实例 ID。

查询杭州地域下某一云盘的快照信息

RegionId:  cn-hangzhou,   //设置华东 1（杭州）地域。
DiskId:   d-bp10e7ej8z743dmu****   //设置待查询的云盘 ID。

根据快照 ID 查询杭州地域下两个快照的信息

RegionId:  cn-hangzhou,   //设置华东 1（杭州）地域。
SnapshotIds:   ["d-bp10e7ej8z743dmu****", "s-bp19vd1lorzgzt2s****"]   //设置待查询的快照 ID 数组。

查询杭州地域下某一时间节点后创建的快照信息

RegionId:  cn-hangzhou,   //设置华东 1（杭州）地域。
Filter.1.Key:   CreationStartTime,   //设置待查询的快照 ID 数组。
Filter.1.Value:   2024-11-27T00:00Z

流控信息

请求速率为1000/60(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ecs:DescribeSnapshots	Get	Snapshot acs:ecs:{#regionId}:{#accountId}:snapshot/* Snapshot acs:ecs:{#regionId}:{#accountId}:snapshot/{#snapshotId}	无	无

请求参数

字段名称	字段详情
InstanceIdstring	指定的实例 ID，即需要查询实例下云盘的快照信息。示例值:i-bp67acfmxazb4p****参考取值来源: RunInstances StopInstances CreateInstance StartInstances RebootInstances DescribeInstances ModifyManagedInstance RenewReservedInstances DetachInstanceRamRole AttachInstanceRamRole DeregisterManagedInstance PurchaseReservedInstancesOffering
DiskIdstring	指定的云盘设备 ID。示例值:d-bp67acfmxazb4p****参考取值来源: CreateDisk DescribeDisks
SnapshotLinkIdstring	快照链 ID。示例值:sl-bp1grgphbcc9brb5****参考取值来源: DescribeSnapshotLinks
RegionIdstring	云盘所属于的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。示例值:cn-hangzhou参考取值来源: DescribeRegions
SnapshotIdsstring	快照标识编码。取值可以由多个快照 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。示例值:["s-bp67acfmxazb4p**", "s-bp67acfmxazb5p", … "s-bp67acfmxazb6p**"]参考取值来源: CopySnapshot CreateSnapshot DescribeSnapshotGroups
PageNumberinteger<int32>	说明该参数即将下线，推荐您使用参数 NextToken 与 MaxResults 完成分页查询操作。示例值:1取值 >= 1
PageSizeinteger<int32>	说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。示例值:10取值 <= 100
NextTokenstring	查询起始标志。由上一次的请求结果中获取。示例值:caeba0bbb2be03f84eb48b699f0a4883
MaxResultsinteger<int32>	分页查询时每页行数。最大值：100。展开详情示例值:10取值 <= 100
SnapshotNamestring	快照名称。示例值:testSnapshotName参考取值来源: CopySnapshot
Statusstring	快照状态。取值范围：展开详情示例值:all
SnapshotTypestring	快照创建类型。取值范围：展开详情示例值:all
Filter.1.Keystring	查询资源时的筛选键，取值必须为`CreationStartTime`。同时设置`Filter.1.Key`和`Filter.1.Value`可以查询在指定时间点后创建的资源信息。示例值:CreationStartTime
Filter.2.Keystring	查询资源时的筛选键，取值必须为`CreationEndTime`。同时设置`Filter.2.Key`和`Filter.2.Value`可以查询在指定时间点前创建的资源信息。示例值:CreationEndTime
Filter.1.Valuestring	查询资源时的筛选值。指定该参数时必须同时指定`Filter.1.Key`参数，格式为：`yyyy-MM-ddTHH:mmZ`，采用 UTC +0 时区。示例值:2019-12-13T17:00Z
Filter.2.Valuestring	查询资源时的筛选值。指定该参数时必须同时指定`Filter.2.Key`参数，格式为：`yyyy-MM-ddTHH:mmZ`，采用 UTC +0 时区。示例值:2019-12-13T22:00Z
Usagestring	快照是否被用作创建镜像或云盘。取值范围：展开详情示例值:none
SourceDiskTypestring	快照源云盘的云盘类型。取值范围：展开详情示例值:system
Encryptedboolean	是否过滤加密快照。默认值：false 。示例值:false
ResourceGroupIdstring	资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。展开详情示例值:rg-bp67acfmxazb4p****参考取值来源: DescribeSecurityGroups
DryRunboolean	是否只预检此次请求。展开详情示例值:false
KMSKeyIdstring	数据盘对应的 KMS 密钥 ID。示例值:0e478b7a-4262-4802-b8cb-00d3fb40****参考取值来源: DescribeDiskDefaultKMSKeyId
Categorystring	快照类型。取值范围：展开详情示例值:Standard
Tagarray<object>	标签列表。子级条数 <= 20

返回参数

字段名称	字段详情
NextTokenstring	下一个查询起始标志。示例值:caeba0bbb2be03f84eb48b699f0a4883
PageSizeinteger<int32>	说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。示例值:10
PageNumberinteger<int32>	说明该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。示例值:1
RequestIdstring	请求 ID。示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger<int32>	快照总个数。示例值:1
Snapshotsobject

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	诊断
400	InvalidTagCount	The specified tags are beyond the permitted range.	诊断
403	InvalidSnapshotIds.Malformed	The amount of specified specified snapshot Ids exceeds the limit.	诊断
403	InvalidSnapshotCategory.Malformed	The specified Category is not valid.	诊断
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.	诊断
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	变更返回参数
	2024-02-01	变更返回参数
	2023-09-18	变更错误码404 变更返回参数
	2021-06-09	变更错误码404 变更返回参数