调用DescribeSnapshots查询一台云桌面的快照列表和快照的详细信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeSnapshots

系统规定参数。取值：DescribeSnapshots。
RegionId String 是 cn-hangzhou

地域ID。
DesktopId String 否 ecd-gx2x1dhsmucyy****

云桌面ID。
SnapshotId String 否 s-2ze81owrnv9pity4****

快照ID。
MaxResults Integer 否 10

分页查询时每页行数。

默认值：100。
NextToken String 否 AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****

查询凭证（Token），取值为上一次API调用返回的NextToken参数值。

返回数据

名称 类型 示例值 描述
NextToken String AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****

本次调用返回的查询凭证值。
RequestId String FB550AAB-FB36-4A91-93F6-F4374AF65403

请求ID。
Snapshots Array of Snapshot

快照信息集合。
CreationTime String 2020-12-20T14:52:28Z

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

Description String testDescription

快照描述信息。
DesktopId String ecd-g03l3tlm8djoj****

快照所属的云桌面ID。
Progress String 100%

快照创建进度。单位为百分比。
RemainTime Integer 30

正在创建的快照剩余完成时间。单位为秒。
SnapshotId String s-2zeipxmnhej803x7****

快照ID。
SnapshotName String testSnapshotName

快照名称。
SnapshotType String user

快照创建类型。可能值：

  • AUTO：自动创建快照。
  • USER：手动创建快照。
SourceDiskSize String 150

源磁盘容量。单位：GiB。
SourceDiskType String system

源磁盘类型。可能值：

  • system：系统盘。
  • data：数据盘。
Status String accomplished

快照状态。可能值：

  • progressing：创建中。
  • accomplished：完成创建。
  • failed：创建失败。

示例

请求示例

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeSnapshots
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeSnapshotsResponse>
      <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****</NextToken>
      <RequestId>FB550AAB-FB36-4A91-93F6-F4374AF65403</RequestId>
      <Snapshots>
            <Status>accomplished</Status>
            <Progress>100%</Progress>
            <Description>testDescription</Description>
            <DesktopId>ecd-g03l3tlm8djoj****</DesktopId>
            <SnapshotName>testSnapshotName</SnapshotName>
            <SnapshotId>s-2zeipxmnhej803x7****</SnapshotId>
            <SourceDiskSize>150</SourceDiskSize>
            <CreationTime>2020-12-20T14:52:28Z</CreationTime>
            <SnapshotType>user</SnapshotType>
            <RemainTime>30</RemainTime>
            <SourceDiskType>system</SourceDiskType>
      </Snapshots>
</DescribeSnapshotsResponse>

JSON 格式 

{
	"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
	"RequestId": "FB550AAB-FB36-4A91-93F6-F4374AF65403",
	"Snapshots": [{
		"Status": "accomplished",
		"Progress": "100%",
		"Description": "testDescription",
		"DesktopId": "ecd-g03l3tlm8djoj****",
		"SnapshotName": "testSnapshotName",
		"SnapshotId": "s-2zeipxmnhej803x7****",
		"SourceDiskSize": "150",
		"CreationTime": "2020-12-20T14:52:28Z",
		"SnapshotType": "user",
		"RemainTime": "30",
		"SourceDiskType": "system"
	}]
}

错误码

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