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

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
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
OsType	string	否	操作系统类型。枚举值： Linux : Linux 操作系统 Windows : Windows 操作系统	Windows
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>	快照信息集合。
	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
DiskStatus	string	快照所属的磁盘状态。枚举值： Available : 使用中 Deleted : 已删除	Available
Creator	string	创建者。	Administrator
ProtocolType	string	协议类型。枚举值： HDX : HDX 协议 ASP : 阿里云自研协议	ASP
OsType	string	操作系统类型。枚举值： Linux : Linux 操作系统 Windows : Windows 操作系统	Windows
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	还原点名称。	数据盘备份
EnvType	string
EnvId	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",
      "DiskStatus": "Available",
      "Creator": "Administrator",
      "ProtocolType": "ASP",
      "OsType": "Windows",
      "VolumeEncryptionEnabled": false,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "DeletionTime": "2020-12-20T14:52:28Z\n",
      "RestorePointId": "rp-btgmaa20wkcju****",
      "RestorePointName": "数据盘备份",
      "EnvType": "",
      "EnvId": ""
    }
  ]
}

错误码

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

变更历史

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