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.
|
10 |
Response parameters
Example
Normal return example
JSON
Format
{
"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 | |||
|