文档

DescribeSnapshots - 查询实例或云盘快照列表

更新时间:

调用DescribeSnapshots查询一台ECS实例或一块云盘所有的快照列表。

接口说明

InstanceIdDiskIdSnapshotIds不是必需的请求参数,但是可以构建过滤器逻辑,参数之间为逻辑与(And)关系。

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeSnapshotsRead
  • Snapshot
    acs:ecs:{#regionId}:{#accountId}:snapshot/*
  • Snapshot
    acs:ecs:{#regionId}:{#accountId}:snapshot/{#snapshotId}

请求参数

名称类型必填描述示例值
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

快照列表的页码。起始值:1。

默认值:1 。

1
PageSizeinteger

分页查询时设置的每页行数。最大值:100。

默认值:10 。

10
NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a4883
MaxResultsinteger

分页查询时每页行数。最大值:100。

默认值:10。

10
SnapshotNamestring

快照名称。

testSnapshotName
Statusstring

快照状态。取值范围:

  • progressing:正在创建的快照。
  • accomplished:创建成功的快照。
  • failed:创建失败的快照。
  • all(默认):所有快照状态。
all
SnapshotTypestring

快照创建类型。取值范围:

  • auto:自动创建快照。
  • user:手动创建快照。
  • all(默认):所有的快照创建类型。
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

快照是否被用作创建镜像或云盘。取值范围:

  • image:使用快照创建了自定义镜像。
  • disk:使用快照创建了云盘。
  • image_disk:使用快照创建了数据盘和自定义镜像。
  • none:暂未使用。
none
SourceDiskTypestring

快照源云盘的云盘类型。取值范围:

  • System:系统盘。
  • Data:数据盘。
说明 取值不区分大小写。
Data
Encryptedboolean

是否过滤加密快照。默认值:false 。

false
ResourceGroupIdstring

资源组 ID。使用该参数过滤资源时,资源数量不能超过 1000 个。

说明 不支持默认资源组过滤。
rg-bp67acfmxazb4p****
DryRunboolean

是否只预检此次请求。

  • true:发送检查请求,不会查询资源状况。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码 DryRunOperation。
  • false(默认):发送正常请求,通过检查后返回 2XX HTTP 状态码并直接查询资源状况。
false
KMSKeyIdstring

数据盘对应的 KMS 密钥 ID。

0e478b7a-4262-4802-b8cb-00d3fb40****
Categorystring

快照类型。取值范围:

  • Standard:普通快照。
  • Flash:本地快照。

原本地快照更替为快照极速可用功能。该参数说明如下:

  • 如果您在 2020 年 12 月 14 日之前使用过本地快照。您可以正常使用该参数。
  • 如果您在 2020 年 12 月 14 日之前未使用过本地快照。您不能使用该参数。

更多信息,请参见12 月 14 日阿里云快照服务升级与新增计费项通知

说明 该参数即将被弃用,为提高兼容性,建议您尽量使用其他参数。
Standard
Tagobject []

标签列表。

keystring

资源的标签键。

说明 为提高兼容性,建议您尽量使用 Tag.N.Key 参数。
SnapshotTest
Keystring

快照的标签键。N 的取值范围:1~20。

使用一个标签过滤资源,查询到该标签下的资源数量不能超过 1000 个;使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个,请使用 ListTagResources 接口进行查询。

TestKey
Valuestring

快照的标签值。N 的取值范围:1~20。

TestValue
valuestring

资源的标签值。

说明 为提高兼容性,建议您尽量使用 Tag.N.Value 参数。
SnapshotTest

返回参数

名称类型描述示例值
object
NextTokenstring

下一个查询起始标志。

caeba0bbb2be03f84eb48b699f0a4883
PageSizeinteger

输入时设置的每页行数。

10
PageNumberinteger

快照列表的页码。

1
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger

快照总个数。

1
Snapshotsobject []

快照详情集合。

Statusstring

快照状态。可能值:

  • progressing
  • accomplished
  • failed
accomplished
CreationTimestring

创建时间。按照ISO 8601标准表示,并使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2020-08-20T14:52:28Z
Progressstring

快照创建进度,单位为百分比。

100%
InstantAccessboolean

是否开启了快照极速可用能力。可能值:

  • true:开启。ESSD 云盘默认开启该能力。
  • false:关闭。即快照为未开启极速可用能力的普通快照。
false
Availableboolean

快照是否可用于创建云盘、回滚云盘。可能值:

  • true:可用。
  • false:不可用。
false
RemainTimeinteger

正在创建的快照剩余完成时间,单位为秒。

38
SourceDiskSizestring

源云盘容量,单位:GiB。

40
RetentionDaysinteger

自动快照保留天数。

30
SourceDiskTypestring

源云盘属性。可能值:

  • system
  • data
system
SourceStorageTypestring

原云盘类型。

说明 该参数即将被弃用,为提高兼容性,建议您尽量使用其他参数。
disk
Usagestring

快照是否被用作创建镜像或云盘。可能值:

  • image
  • disk
  • image_disk
  • none
image
LastModifiedTimestring

快照的最后变更时间。按照ISO 8601标准表示,并使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2020-08-25T14:18:09Z
Encryptedboolean

该快照是否加密。

false
SnapshotTypestring

快照创建类型。可能值:

  • auto 或者 timer:自动创建快照。
  • user:手动创建快照。
  • all:所有的快照创建类型。
all
SourceDiskIdstring

源云盘 ID。如果快照的源云盘已经被释放,该字段仍旧保留。

d-bp67acfmxazb4ph****
SnapshotNamestring

快照显示名称。如果创建时指定了快照显示名称,则返回。

testSnapshotName
InstantAccessRetentionDaysinteger

设置快照极速可用功能的保留时间,保留时间到期后自动关闭快照极速可用功能。

默认与参数RetentionDays的值一致。

说明 该参数已弃用。ESSD 云盘普通快照已升级为默认极速可用,您无需额外配置,且不产生额外花销。
30
Descriptionstring

描述信息。

testDescription
SnapshotIdstring

快照 ID。

s-bp67acfmxazb4p****
RegionIdstring

快照所属的地域 ID。

cn-hangzhou
ResourceGroupIdstring

资源组 ID。

rg-bp67acfmxazb4p****
Categorystring

快照类型。

说明 该参数即将被弃用,为提高兼容性,建议您尽量使用参数InstantAccess
standard
KMSKeyIdstring

数据盘对应的 KMS 密钥 ID。

0e478b7a-4262-4802-b8cb-00d3fb40****
SnapshotSNstring

快照序列号。

64472-116742336-61976****
ProductCodestring

从云市场镜像继承的产品编号。

jxsc000****
SourceSnapshotIdstring

源快照。

s-bp67acfmxazb4p****
SourceRegionIdstring

源快照地域。

cn-hangzhou
SnapshotLinkIdstring

快照关联的快照链 ID。

sl-bp1grgphbcc9brb5****
Tagsobject []

标签。

TagValuestring

快照的标签值。

TestValue
TagKeystring

快照的标签键。

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

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

变更历史

变更时间变更内容概要操作
2024-05-22OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2024-02-01OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-09-18OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
    删除错误码:403
    删除错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)