文档

DescribeSnapshots - 查询快照信息

调用DescribeSnapshots查询快照信息。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
EnsRegionIdstring

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

cn-hangzhou
DiskIdstring

指定的云盘设备 ID。

d-bp67acfmxazb4p****
InstanceIdstring

指定的实例 ID。

i-bp67acfmxazb4p****
SnapshotIdstring

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

sp-bp67acfmxazb4p****
PageNumberinteger

当前查询页码。

1
PageSizeinteger

分页查询时每页的行数。

10

返回参数

名称类型描述示例值
object

Schema of Response

Snapshotsobject []

快照详情集合。

SnapshotIdstring

快照 ID。

s-bp67acfmxazb4p****
CreationTimestring

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

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

快照状态。取值:

  • creating:创建中。
  • available:可用。
  • deleting:删除中。
  • error:错误。
available
Sizestring

磁盘容量。单位:MiB。

40
SourceDiskIdstring

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

d-bp67acfmxazb4ph****
SourceDiskTypestring

磁盘属性。取值:

  • 1:系统盘。
  • 2:数据盘。
1
SourceDiskCategorystring

磁盘类型。取值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:全闪云盘。
  • local_hdd:本地 HDD 盘。
  • local_ssd:本地盘 SSD。
cloud_efficiency
SnapshotNamestring

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

testSnapshotName
Descriptionstring

描述信息。

testDescription
EnsRegionIdstring

ENS 的节点 ID。

cn-beijing-15
SourceSnapshotIdstring

源快照 ID

s-bpdfer893jfkdqe****
SourceEnsRegionIdstring

源 ENS 节点 ID

cn-hangzhou-27
PageNumberinteger

当前查询页码。

1
PageSizeinteger

分页查询时每页的行数。

10
TotalCountinteger

快照总个数。

1
RequestIdstring

请求 ID。

9635ED2E-3103-1606-84D4-9F8E816B19F9

示例

正常返回示例

JSON格式

{
  "Snapshots": [
    {
      "SnapshotId": "s-bp67acfmxazb4p****",
      "CreationTime": "2020-08-20T14:52:28Z",
      "Status": "available",
      "Size": "40",
      "SourceDiskId": "d-bp67acfmxazb4ph****",
      "SourceDiskType": "1",
      "SourceDiskCategory": "cloud_efficiency",
      "SnapshotName": "testSnapshotName",
      "Description": "testDescription",
      "EnsRegionId": "cn-beijing-15",
      "SourceSnapshotId": "s-bpdfer893jfkdqe****",
      "SourceEnsRegionId": "cn-hangzhou-27"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RequestId": "9635ED2E-3103-1606-84D4-9F8E816B19F9"
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400InstanceIdNotFoundThe input parameter instancdId that is not found.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400CallInterfaceCall Interface Happen Error.接口调用出错。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
2024-01-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-12-21OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)
文档反馈