All Products
Search
Document Center

WUYING Workspace:DescribeSnapshots

Last Updated:Mar 26, 2024

Queries a list of snapshots of a cloud desktop and the details of the snapshots.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
DesktopIdstringNo

The cloud desktop ID.

ecd-gx2x1dhsmucyy****
DesktopNamestringNo

The cloud desktop name.

testName
SnapshotIdstringNo

The snapshot ID.

s-2ze81owrnv9pity4****
SnapshotNamestringNo

The snapshot name. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.

The name cannot start with auto because snapshots whose names start with auto are recognized as automatic snapshots.

test_data_disk
SourceDiskTypestringNo

The type of the source disk of which you want to query snapshots. Valid values:

  • System: system disk
  • Data: data disk
Note The value of this parameter is not case-sensitive.
system
SnapshotTypestringNo

The snapshot type.

Valid values:

  • auto: automatic snapshot
  • user: manual snapshot
  • all (default): all types of snapshots
user
CreatorstringNo

The user who creates the snapshot.

Administrator
StartTimestringNo

The beginning of the time range to query. The query is performed based on the time when the system created a snapshot. Specify the time in the ISO 8601 standard in the yyyy-mm-ddthh:mm:ssz format. The time must be in UTC.

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

The end of the time range to query. The query is performed based on the time when the system stopped creating a snapshot. Specify the time in the ISO 8601 standard in the yyyy-mm-ddthh:mm:ssz format. The time must be in UTC.

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

The pagination token that is used in the next request to retrieve a new page of results. You must specify the token that is obtained from the previous query as the value of NextToken.

8051af8d01b5479bec9f5ddf02e4a8fbd0ab6e7e43f8****
MaxResultsintegerNo

The maximum number of entries to return on each page.

  • Valid values: 1 to 100
  • Default value: 10
10

Response parameters

ParameterTypeDescriptionExample
object

The information returned.

NextTokenstring

If the NextToken parameter is empty, no next page exists.

AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestIdstring

The request ID.

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

The queried snapshots.

CreationTimestring

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
Statusstring

The state of the snapshot. Valid values:

  • PROGRESSING: The snapshot is being created.
  • FAILED: The snapshot failed to be created.
  • ACCOMPLISHED: The snapshot is created.
ACCOMPLISHED
SnapshotTypestring

The snapshot type. Valid values:

  • AUTO: automatic snapshot
  • USER: manual snapshot
USER
SnapshotNamestring

The snapshot name.

testSnapshotName
Progressstring

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

100%
Descriptionstring

The snapshot description.

testDescription
SnapshotIdstring

The snapshot ID.

s-2zeipxmnhej803x7****
RemainTimeinteger

The remaining time required to create the snapshot. 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 required to create the snapshot.
30
SourceDiskSizestring

The size of the source disk. Unit: GiB.

150
SourceDiskTypestring

The type of the source disk. Valid values:

  • SYSTEM: system disk
  • DATA: data disk
SYSTEM
DesktopIdstring

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

ecd-g03l3tlm8djoj****
DesktopNamestring

The cloud desktop name.

test
DesktopStatusstring

The cloud desktop state. Valid values:

  • Pending: The cloud desktop is pending.
  • Starting: The cloud desktop is being started.
  • Running: The cloud desktop is running.
  • Stopping: The cloud desktop is being stopped.
  • Rebuilding: The cloud desktop is being recreated.
  • Stopped: The cloud desktop is stopped.
  • Expired: The cloud desktop expired.
  • Deleted: The cloud desktop is deleted.
Running
Creatorstring

The user that creates the cloud desktop.

Administrator
ProtocolTypestring

The protocol. Valid values:

  • ASP
  • HDX
ASP
VolumeEncryptionEnabledboolean

Indicates whether disk encryption is enabled.

false
VolumeEncryptionKeystring

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****
DeletionTimestring

The time when the snapshot was deleted. 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

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-03-01The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Creator
2022-08-19The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.