All Products
Search
Document Center

Elastic Desktop Service:DescribeSnapshots

Last Updated:Jan 18, 2023

Queries one or more snapshots of a cloud desktop.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter Type Required Description Example
RegionId string Yes

The ID of the region. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DesktopId string No

The ID of the cloud desktop.

ecd-gx2x1dhsmucyy****
DesktopName string No
SnapshotId string No

The ID of the snapshot.

s-2ze81owrnv9pity4****
SnapshotName string No
SourceDiskType string No
SnapshotType string No
StartTime string No
EndTime string No
NextToken string No

The token that determines the start point of the query. Set the value to the value of NextToken that is returned from the last call.

8051af8d01b5479bec9f5ddf02e4a8fbd0ab6e7e43f8****
MaxResults integer No

The number of entries to return on each page.

  • Maximum value: 100.
  • Default value: 10.
10

Response parameters

Parameter Type Description Example
object

The information that is returned.

NextToken string

The token that is used to start the next query. If this parameter is empty, all results are returned.

AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId string

The ID of the request.

FB550AAB-FB36-4A91-93F6-F4374AF65403
Snapshots array

Details of the snapshots.

object

Details of the snapshot.

CreationTime string

The time when the snapshot was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2020-12-20T14:52:28Z
Status string

The state of the snapshot.

ACCOMPLISHED
SnapshotType string

The type of snapshot.

USER
SnapshotName string

The name of the snapshot.

testSnapshotName
Progress string

The progress of the snapshot creation. Unit: percentage (%).

100%
Description string

The description of the snapshot.

testDescription
SnapshotId string

The ID of the snapshot.

s-2zeipxmnhej803x7****
RemainTime integer

The remaining time for the snapshot creation. Unit: seconds.

Note If the value of the Status parameter is PROGRESSING and the value of the RemainTime parameter is -1, the system is calculating the remaining time for snapshot creation.
30
SourceDiskSize string

The size of the source disk. Unit: GiB.

150
SourceDiskType string

The type of the source disk. Valid values:

  • SYSTEM: the system disk
  • DATA: the data disk
SYSTEM
DesktopId string

The ID of the cloud desktop to which the snapshot belongs.

ecd-g03l3tlm8djoj****
DesktopName string
DesktopStatus string
Creator string
ProtocolType string
VolumeEncryptionEnabled boolean

Indicates whether disk encryption is enabled.

false
VolumeEncryptionKey string

The ID of the Key Management Service (KMS) key that is used when disk encryption is enabled. You can call the ListKeys operation to obtain a list of KMS keys.

08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
DeletionTime string

Example

Normal return example

JSONFormat

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

Error codes

For a list of error codes, visit the API error center.

Change history

Change time Summary of changes Operate
2022-08-19 The response structure of the API operation has changed
Change item Change content
Output Parameters The response structure of the API operation has changed