DescribeSnapshots_云服务器 ECS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

InstanceIdDiskIdSnapshotIds不是必需的请求参数,但是可以构建过滤器逻辑,参数之间为逻辑与(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

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
InstanceIdstring

指定的实例 ID,即需要查询实例下云盘的快照信息。

示例值:i-bp67acfmxazb4p****
DiskIdstring

指定的云盘设备 ID。

示例值:d-bp67acfmxazb4p****
SnapshotLinkIdstring

快照链 ID。

示例值:sl-bp1grgphbcc9brb5****
RegionIdstring

云盘所属于的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

示例值:cn-hangzhou
SnapshotIdsstring

快照标识编码。取值可以由多个快照 ID 组成一个 JSON 数组,最多支持 100 个 ID,ID 之间用半角逗号(,)隔开。

示例值:["s-bp67acfmxazb4p****", "s-bp67acfmxazb5p****", … "s-bp67acfmxazb6p****"]
PageNumberinteger<int32>
说明 该参数即将下线,推荐您使用参数 NextToken 与 MaxResults 完成分页查询操作。
示例值:1取值 >= 1
PageSizeinteger<int32>
说明 该参数即将下线,推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
示例值:10取值 <= 100
NextTokenstring

查询起始标志。由上一次的请求结果中获取。

示例值:caeba0bbb2be03f84eb48b699f0a4883
MaxResultsinteger<int32>

分页查询时每页行数。最大值:100。展开详情

示例值:10取值 <= 100
SnapshotNamestring

快照名称。

示例值:testSnapshotName
Statusstring

快照状态。取值范围: 展开详情

示例值:all
SnapshotTypestring

快照创建类型。取值范围: 展开详情

示例值:all
Filter.1.Keystring

查询资源时的筛选键,取值必须为CreationStartTime。同时设置Filter.1.KeyFilter.1.Value可以查询在指定时间点后创建的资源信息。

示例值:CreationStartTime
Filter.2.Keystring

查询资源时的筛选键,取值必须为CreationEndTime。同时设置Filter.2.KeyFilter.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****
DryRunboolean

是否只预检此次请求。展开详情

示例值:false
KMSKeyIdstring

数据盘对应的 KMS 密钥 ID。

示例值:0e478b7a-4262-4802-b8cb-00d3fb40****
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

返回示例

变更历史

暂无变更历史
2024年08月20日