文档

DescribeSnapshots - 查询云电脑的快照列表和详细信息

更新时间:

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

调试

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

授权信息

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

请求参数

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

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

cn-hangzhou
DesktopIdstring

云电脑 ID。

ecd-gx2x1dhsmucyy****
DesktopNamestring

云电脑名称。

testName
SnapshotIdstring

快照 ID。

s-2ze81owrnv9pity4****
SnapshotNamestring

快照的显示名称。长度为 2~127 个英文或中文字符。必须以大小写字母或中文开头。可以包含数字、下划线(_)或者短划线(-)。为防止和自动快照的名称冲突,不能以auto开头。

test数据盘
SourceDiskTypestring

需制作快照的磁盘的云盘类型。

说明 取值不区分大小写。
枚举值:
  • Data数据盘
  • System系统盘
system
SnapshotTypestring

快照类型。

枚举值:
  • all所有快照类型 [默认值]
  • auto自动快照
  • user手动创建的快照
user
Creatorstring

创建者。

Administrator
StartTimestring

快照创建的开始时间。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为yyyy-mm-ddthh:mm:ssz

2020-11-30T06:32:31Z
EndTimestring

快照创建的结束时间。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为yyyy-mm-ddthh:mm:ssz

2020-11-31T06:32:31Z
NextTokenstring

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

8051af8d01b5479bec9f5ddf02e4a8fbd0ab6e7e43f8****
MaxResultsinteger

分页查询时每页行数。

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

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

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

AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestIdstring

请求 ID。

51592A88-0F2C-55E6-AD2C-2AD9C10D****
Snapshotsobject []

快照信息集合。

CreationTimestring

快照的创建时间。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为yyyy-mm-ddthh:mm:ssz

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

快照状态。

枚举值:
  • PROGRESSING创建中
  • FAILED创建失败
  • ACCOMPLISHED创建完毕
ACCOMPLISHED
SnapshotTypestring

快照创建类型。

枚举值:
  • AUTO自动创建快照
  • USER手动创建快照
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

云电脑名称。

test
DesktopStatusstring

云电脑状态。

枚举值:
  • Stopped已关机
  • Starting启动中
  • Rebuilding重建中
  • Running运行中
  • Stopping停止中
  • Expired已过期
  • Deleted已删除
  • Pending等待中
Running
Creatorstring

创建者。

Administrator
ProtocolTypestring

协议类型。

枚举值:
  • HDXHDX协议
  • ASP阿里云自研协议
ASP
VolumeEncryptionEnabledboolean

是否开启磁盘加密。

false
VolumeEncryptionKeystring

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

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

快照创建时间。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为yyyy-mm-ddthh:mm:ssz

2020-12-20T14:52:28Z

示例

正常返回示例

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"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-03-01OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Creator
2022-08-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈