DescribeSnapshots - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries the snapshots that are created based on a cloud computer and the details of the snapshots.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.	cn-hangzhou
DesktopId	string	No	The cloud computer ID.	ecd-gx2x1dhsmucyy****
SnapshotId	string	No	The snapshot ID.	s-2ze81owrnv9pity4****
MaxResults	integer	No	The number of entries per page. Default value: 100.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
ClientId	string	Yes	The client ID. The system generates a unique ID for each client.	16dad2b6-3c6d-4e4c-b057-78ecb13c****
SessionId	string	Yes	The session ID.	a99b9aca-bac5-4da2-819e-400ce98f****
LoginToken	string	Yes	The logon token.	v16abfb945208fc5745061668654680853da4a25202d1a394fcad57bba484e9827ad43ea7d10fb6bf13d44a4adc0e9****

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.If NextToken is empty, no next page exists.	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId	string	The request ID.	51592A88-0F2C-55E6-AD2C-2AD9C10D****
Snapshots	array<object>	The snapshots.
Snapshot	object
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 snapshot status. Valid values: PROGRESSING: The snapshot is being created. FAILED: The snapshot failed to be created. ACCOMPLISHED: The snapshot is created.	ACCOMPLISHED
SnapshotType	string	The snapshot type. Valid values: AUTO: an automatic snapshot. USER: a manual snapshot.	USER
SnapshotName	string	The snapshot name.	testSnapshotName
Progress	string	The progress of creating the cloud computer.	100%
Description	string	The snapshot description.	testDescription
SnapshotId	string	The snapshot ID.	s-2zeipxmnhej803x7****
RemainTime	integer	The remaining time required to complete snapshot creation. Unit: seconds.	30
SourceDiskSize	string	The size of the source disk. Unit: GiB.	150
SourceDiskType	string	The type of the source disk. Valid values: SYSTEM: a system disk. DATA: a data disk.	SYSTEM
DesktopId	string	The ID of the cloud computer to which the snapshot belongs.	ecd-g03l3tlm8djoj****
RestorePointId	string	The ID of the restore point.	rp-btgmaa20wkcju****
RestorePointName	string	The name of the restore point.	Data Disk Backup

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****",
      "RestorePointId": "rp-btgmaa20wkcju****",
      "RestorePointName": "Data Disk Backup\n"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-01-15	The response structure of the API has changed	View Change Details