DescribeSnapshots - 查询云电脑快照信息_无影云电脑企业版-阿里云帮助中心

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

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
DesktopId	string	否	云电脑 ID。	ecd-gx2x1dhsmucyy****
SnapshotId	string	否	快照 ID。	s-2ze81owrnv9pity4****
MaxResults	integer	否	分页查询时，每页最大行数。默认值：100。	10
NextToken	string	否	下一个查询开始的 Token，NextToken 为空表示没有下一个。	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
ClientId	string	是	客户端生成的唯一 ID。	16dad2b6-3c6d-4e4c-b057-78ecb13c****
SessionId	string	是	会话 ID。	a99b9aca-bac5-4da2-819e-400ce98f****
LoginToken	string	是	登录凭证。	v16abfb945208fc5745061668654680853da4a25202d1a394fcad57bba484e9827ad43ea7d10fb6bf13d44a4adc0e9****

返回参数

名称	类型	描述	示例值
	object
NextToken	string	下一个查询开始的 Token，NextToken 为空表示没有下一个。	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId	string	请求 ID。	51592A88-0F2C-55E6-AD2C-2AD9C10D****
Snapshots	array<object>	快照信息集合。
Snapshot	object
CreationTime	string	快照创建时间。按照 ISO8601 标准表示，并使用 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	正在创建的快照剩余完成时间。单位：秒。	30
SourceDiskSize	string	源磁盘容量。单位：GiB。	150
SourceDiskType	string	源磁盘类型。枚举值： SYSTEM：系统盘。 DATA：数据盘。	SYSTEM
DesktopId	string	快照所属的云电脑 ID。	ecd-g03l3tlm8djoj****
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****",
      "RestorePointId": "rp-btgmaa20wkcju****",
      "RestorePointName": "数据盘备份"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2025-01-15	OpenAPI 返回结构发生变更	查看变更详情