Queries a list of snapshots of a cloud desktop and the details of the snapshots.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
DesktopId | string | No | The cloud desktop ID. | ecd-gx2x1dhsmucyy**** |
DesktopName | string | No | The cloud desktop name. | testName |
SnapshotId | string | No | The snapshot ID. | s-2ze81owrnv9pity4**** |
SnapshotName | string | No | 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 The name cannot start with | test_data_disk |
SourceDiskType | string | No | The type of the source disk of which you want to query snapshots. Valid values:
Note
The value of this parameter is not case-sensitive.
| system |
SnapshotType | string | No | The snapshot type. Valid values:
| user |
Creator | string | No | The user who creates the snapshot. | Administrator |
StartTime | string | No | 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 |
EndTime | string | No | 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 |
NextToken | string | No | 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**** |
MaxResults | integer | No | The maximum number of entries to return on each page.
| 10 |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 time | Summary of changes | Operation | ||||
---|---|---|---|---|---|---|
2023-03-01 | The request parameters of the API has changed | see changesets | ||||
| ||||||
2022-08-19 | The response structure of the API has changed | see changesets | ||||
|