DescribeSnapshots - 查询快照信息 - 边缘节点服务ENS

调用DescribeSnapshots查询快照信息。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeSnapshots

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
EnsRegionId	string	否	ENS 节点 ID，可通过 DescribeEnsRegions 查询节点 ID。	cn-hangzhou
DiskId	string	否	指定的云盘设备 ID。	d-bp67acfmxazb4p****
SnapshotId	string	否	快照标识编码。取值可以由多个快照 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。	sp-bp67acfmxazb4p****
EnsRegionIds	string	否	ENS 节点 ID 数组。数组长度：1~100。	["cn-suzhou-telecom","cn-chengdu-telecom"]
SnapshotName	string	否	快照的显示名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头，不能以`http://`或`https://`开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。	testSnapshotName
InstanceId	string	否	指定的实例 ID。	i-bp67acfmxazb4p****
PageNumber	integer	否	当前查询页码。	1
PageSize	integer	否	分页查询时每页的行数。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Snapshots	array<object>	快照详情集合。
	object
SnapshotId	string	快照 ID。	s-bp67acfmxazb4p****
CreationTime	string	创建时间。按照 ISO8601 标准表示，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ss。	2020-08-20 14:52:28
Status	string	快照状态。取值： creating：创建中。 available：可用。 deleting：删除中。 error：错误。	available
Size	string	磁盘容量。单位：MiB。	40
SourceDiskId	string	源云盘 ID。如果快照的源云盘已经被释放，该字段仍旧保留。	d-bp67acfmxazb4ph****
SourceDiskType	string	磁盘属性。取值： 1：系统盘。 2：数据盘。	1
SourceDiskCategory	string	磁盘类型。取值： cloud_efficiency：高效云盘。 cloud_ssd：全闪云盘。 local_hdd：本地 HDD 盘。 local_ssd：本地盘 SSD。	cloud_efficiency
SnapshotName	string	快照显示名称。如果创建时指定了快照显示名称，则返回。	testSnapshotName
Description	string	描述信息。	testDescription
EnsRegionId	string	ENS 的节点 ID。	cn-beijing-15
SourceSnapshotId	string	源快照 ID。	s-bpdfer893jfkdqe****
SourceEnsRegionId	string	源 ENS 节点 ID。	cn-hangzhou-27
SnapshotType	string
PageNumber	integer	当前查询页码。	1
PageSize	integer	分页查询时每页的行数。	10
TotalCount	integer	快照总个数。	1
RequestId	string	请求 ID。	9635ED2E-3103-1606-84D4-9F8E816B19F9

示例

正常返回示例

JSON格式

{
  "Snapshots": [
    {
      "SnapshotId": "s-bp67acfmxazb4p****",
      "CreationTime": "2020-08-20 14:52:28",
      "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",
      "SnapshotType": ""
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RequestId": "9635ED2E-3103-1606-84D4-9F8E816B19F9"
}

错误码

HTTP status code	错误码	错误信息	描述
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.
400	InstanceIdNotFound	The input parameter instancdId that is not found.	指定的实例ID不存在。
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.	接口调用出错。
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

变更历史

更多信息，参考变更详情。