查询云盘的快照列表信息。例如快照状态、正在创建的快照剩余完成时间、自动快照保留天数等。
接口说明
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 | 否 | 说明
该参数即将下线，推荐您使用参数 NextToken 与 MaxResults 完成分页查询操作。
| 1 |
| PageSize | integer | 否 | 说明
该参数即将下线，推荐您使用 NextToken 与 MaxResults 完成分页查询操作。
| 10 |
| NextToken | string | 否 | 查询起始标志。由上一次的请求结果中获取。 | caeba0bbb2be03f84eb48b699f0a4883 |
| MaxResults | integer | 否 | 分页查询时每页行数。最大值：100。 默认值：10。 | 10 |
| SnapshotName | string | 否 | 快照名称。 | testSnapshotName |
| Status | string | 否 | 快照状态。取值范围：
| all |
| SnapshotType | string | 否 | 快照创建类型。取值范围：
| all |
| Filter.1.Key | string | 否 | 查询资源时的筛选键，取值必须为 | CreationStartTime |
| Filter.2.Key | string | 否 | 查询资源时的筛选键，取值必须为 | CreationEndTime |
| Filter.1.Value | string | 否 | 查询资源时的筛选值。指定该参数时必须同时指定 | 2019-12-13T17:00Z |
| Filter.2.Value | string | 否 | 查询资源时的筛选值。指定该参数时必须同时指定 | 2019-12-13T22:00Z |
| Usage | string | 否 | 快照是否被用作创建镜像或云盘。取值范围：
| none |
| SourceDiskType | string | 否 | 快照源云盘的云盘类型。取值范围：
说明
取值不区分大小写。
| system |
| Encrypted | boolean | 否 | 是否过滤加密快照。默认值：false 。 | false |
| ResourceGroupId | string | 否 | 资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。 说明
不支持默认资源组过滤。
| rg-bp67acfmxazb4p**** |
| DryRun | boolean | 否 | 是否只预检此次请求。
| false |
| KMSKeyId | string | 否 | 数据盘对应的 KMS 密钥 ID。 | 0e478b7a-4262-4802-b8cb-00d3fb40**** |
| Category | string | 否 | 快照类型。取值范围：
更多信息，请参见12 月 14 日阿里云快照服务升级与新增计费项通知。 | 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 |
返回参数
示例
正常返回示例
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-12-04 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-05-22 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-02-01 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-09-18 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |