首页 无影云桌面 API参考(云桌面管控) API目录 快照 DescribeSnapshots - 查询云桌面的快照列表和详细信息

DescribeSnapshots - 查询云桌面的快照列表和详细信息

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

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。可以调用DescribeRegions获取无影云桌面支持的地域列表。

cn-hangzhou
DesktopIdstring

云桌面ID。

ecd-gx2x1dhsmucyy****
DesktopNamestring
SnapshotIdstring

快照ID。

s-2ze81owrnv9pity4****
SnapshotNamestring
SourceDiskTypestring
SnapshotTypestring
StartTimestring
EndTimestring
NextTokenstring

查询凭证(Token),取值为上一次API调用返回的NextToken参数值。

8051af8d01b5479bec9f5ddf02e4a8fbd0ab6e7e43f8****
MaxResultsinteger

分页查询时每页行数。

  • 最大值:100。
  • 默认值:10。
10

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

下一个查询开始的Token,NextToken为空表示没有下一个。

AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestIdstring

请求ID。

FB550AAB-FB36-4A91-93F6-F4374AF65403
Snapshotsarray

快照信息集合。

object

快照信息。

CreationTimestring

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

2020-12-20T14:52:28Z
Statusstring

快照状态。

ACCOMPLISHED
SnapshotTypestring

快照创建类型。

USER
SnapshotNamestring

快照名称。

testSnapshotName
Progressstring

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

100%
Descriptionstring

快照描述信息。

testDescription
SnapshotIdstring

快照ID。

s-2zeipxmnhej803x7****
RemainTimeinteger

正在创建的快照剩余完成时间。单位为秒。

说明StatusPROGRESSING时,RemainTime的值显示为-1,表示正在计算剩余时间。
30
SourceDiskSizestring

源磁盘容量。单位:GiB。

150
SourceDiskTypestring

源磁盘类型。可能值:

  • SYSTEM:系统盘。
  • DATA:数据盘。
SYSTEM
DesktopIdstring

快照所属的云桌面ID。

ecd-g03l3tlm8djoj****
DesktopNamestring
DesktopStatusstring
Creatorstring
ProtocolTypestring
VolumeEncryptionEnabledboolean

是否开启磁盘加密。

false
VolumeEncryptionKeystring

开启磁盘加密的情况下使用的KMS的密钥ID。可通过ListKeys接口获取。

08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
DeletionTimestring

示例

正常返回示例

JSON格式

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
  "RequestId": "FB550AAB-FB36-4A91-93F6-F4374AF65403",
  "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": "",
      "DesktopStatus": "",
      "Creator": "",
      "ProtocolType": "",
      "VolumeEncryptionEnabled": true,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "DeletionTime": ""
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-08-19OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 无影云桌面 相关技术圈