调用DescribeSnapshots查询云桌面的快照列表和详细信息_无影云电脑企业版(EDS)-阿里云帮助中心

查询一台云电脑的快照列表和快照的详细信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ecd:DescribeSnapshots	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
DesktopId	string	否	云电脑 ID。	ecd-gx2x1dhsmucyy****
DesktopName	string	否	云电脑名称。	testName
SnapshotId	string	否	快照 ID。	s-2ze81owrnv9pity4****
SnapshotName	string	否	快照的显示名称。长度为 2~127 个英文或中文字符。必须以大小写字母或中文开头。可以包含数字、下划线（_）或者短划线（-）。为防止和自动快照的名称冲突，不能以`auto`开头。	test数据盘
SourceDiskType	string	否	需制作快照的磁盘。说明取值不区分大小写。枚举值： Data：数据盘。 System：系统盘。	system
SnapshotType	string	否	快照类型。枚举值： all：所有快照类型 [默认值]。 auto：自动快照。 user：手动创建的快照。	user
Creator	string	否	创建者。	Administrator
StartTime	string	否	快照创建的开始时间。按照ISO 8601标准表示，并使用 UTC+0 时间，格式为`yyyy-mm-ddthh:mm:ssz`。	2020-11-30T06:32:31Z
EndTime	string	否	快照创建的结束时间。按照ISO 8601标准表示，并使用 UTC+0 时间，格式为`yyyy-mm-ddthh:mm:ssz`。	2020-11-31T06:32:31Z
NextToken	string	否	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	8051af8d01b5479bec9f5ddf02e4a8fbd0ab6e7e43f8****
MaxResults	integer	否	分页查询时每页行数。最大值：100。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
NextToken	string	下一个查询开始的 Token，NextToken 为空表示没有下一个。	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId	string	请求 ID。	51592A88-0F2C-55E6-AD2C-2AD9C10D****
Snapshots	array<object>	快照信息集合。
Snapshot	object	快照信息。
CreationTime	string	快照的创建时间。按照ISO 8601标准表示，并使用 UTC+0 时间，格式为`yyyy-mm-ddthh:mm:ssz`。	2020-12-20T14:52:28Z
Status	string	快照状态。枚举值： PROGRESSING：创建中。 FAILED：创建失败。 ACCOMPLISHED：创建完毕。	ACCOMPLISHED
SnapshotType	string	快照创建类型。枚举值： AUTO：自动创建快照。 USER：手动创建快照。	USER
SnapshotName	string	快照名称。	testSnapshotName
Progress	string	快照创建进度。单位为百分比。	100%
Description	string	快照描述信息。	testDescription
SnapshotId	string	快照 ID。	s-2zeipxmnhej803x7****
RemainTime	integer	正在创建的快照剩余完成时间。单位为秒。说明当`Status`为`PROGRESSING`时，`RemainTime`的值显示为`-1`，表示正在计算剩余时间。	30
SourceDiskSize	string	源磁盘容量。单位：GiB。	150
SourceDiskType	string	源磁盘类型。枚举值： SYSTEM：系统盘。 DATA：数据盘。	SYSTEM
DesktopId	string	快照所属的云电脑 ID。	ecd-g03l3tlm8djoj****
DesktopName	string	云电脑名称。	test
DesktopStatus	string	云电脑状态。枚举值： Stopped：已关机。 Starting：启动中。 Rebuilding：重建中。 Running：运行中。 Stopping：停止中。 Expired：已过期。 Deleted：已删除。 Pending：等待中。	Running
Creator	string	创建者。	Administrator
ProtocolType	string	协议类型。枚举值： HDX：HDX协议。 ASP：阿里云自研协议。	ASP
VolumeEncryptionEnabled	boolean	是否开启磁盘加密。	false
VolumeEncryptionKey	string	开启磁盘加密的情况下使用的 KMS 的密钥 ID。可通过 ListKeys 接口获取。	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
DeletionTime	string	快照创建时间。按照ISO 8601标准表示，并使用 UTC+0 时间，格式为`yyyy-mm-ddthh:mm:ssz`。	2020-12-20T14:52:28Z
RestorePointId	string	还原点 ID。	rp-btgmaa20wkcju****
RestorePointName	string	还原点名称。	数据盘备份

示例

正常返回示例

JSON格式

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
  "RequestId": "51592A88-0F2C-55E6-AD2C-2AD9C10D****",
  "Snapshots": [
    {
      "CreationTime": "2020-12-20T14:52:28Z",
      "Status": "ACCOMPLISHED",
      "SnapshotType": "USER",
      "SnapshotName": "testSnapshotName",
      "Progress": "100%",
      "Description": "testDescription",
      "SnapshotId": "s-2zeipxmnhej803x7****",
      "RemainTime": 30,
      "SourceDiskSize": "150",
      "SourceDiskType": "SYSTEM",
      "DesktopId": "ecd-g03l3tlm8djoj****",
      "DesktopName": "test",
      "DesktopStatus": "Running",
      "Creator": "Administrator",
      "ProtocolType": "ASP",
      "VolumeEncryptionEnabled": false,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "DeletionTime": "2020-12-20T14:52:28Z\n",
      "RestorePointId": "rp-btgmaa20wkcju****",
      "RestorePointName": "数据盘备份"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2025-01-15	OpenAPI 返回结构发生变更	查看变更详情
2023-03-01	OpenAPI 入参发生变更	查看变更详情
2022-08-19	OpenAPI 返回结构发生变更	查看变更详情