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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:DescribeSnapshots	get	All Resources ``	none	none

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 ID of the cloud computer.	ecd-gx2x1dhsmucyy****
DesktopName	string	No	The name of the cloud computer.	testName
SnapshotId	string	No	The snapshot ID.	s-2ze81owrnv9pity4****
SnapshotName	string	No	The name of the snapshot. The name must be 2 to 127 characters in length. The name must start with a letter. The name can contain letters, digits, underscores (_), and hyphens (-). The name cannot start with `auto` because snapshots whose names start with auto are recognized as automatic snapshots.	test_data_disk
SourceDiskType	string	No	The disk for which you want to create a snapshot. Note The value of this parameter is not case-sensitive. Valid values: Data: the data disk. System: the system disk.	system
SnapshotType	string	No	The category of the snapshots. Default value: all. Valid values: all: all snapshot categories auto: automatic snapshots user: manual snapshots	user
Creator	string	No	The user who creates the snapshot.	Administrator
StartTime	string	No	The beginning of the time range to query. 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. 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 number of entries per page. Maximum value: 100. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	If the NextToken parameter is empty, no next page exists.	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId	string	The request ID.	51592A88-0F2C-55E6-AD2C-2AD9C10D****
Snapshots	array<object>	The snapshots.
Snapshot	object	The snapshot.
CreationTime	string	The point in time at which 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 status of the snapshot. Valid values: PROGRESSING: The snapshot is being created. FAILED: The snapshot fails to be created. ACCOMPLISHED: The snapshot is created.	ACCOMPLISHED
SnapshotType	string	The type of the snapshot. Valid values: AUTO: automatic snapshot USER: manual snapshot	USER
SnapshotName	string	The name of the snapshot.	testSnapshotName
Progress	string	The progress of creating the snapshot. Unit: %.	100%
Description	string	The description of the snapshot.	testDescription
SnapshotId	string	The snapshot ID.	s-2zeipxmnhej803x7****
RemainTime	integer	The remaining time that is required to complete the snapshot creation. Unit: seconds. Note When the `Status` value is `PROGRESSING`, the `RemainTime` value is `-1`. A value of -1 indicates that the system is calculating the remaining time.	30
SourceDiskSize	string	The capacity of the source disk. Unit: GiB.	150
SourceDiskType	string	The type of the source disk. Valid values: SYSTEM: system disk DATA: data disk	SYSTEM
DesktopId	string	The ID of the cloud computer to which the snapshot belongs.	ecd-g03l3tlm8djoj****
DesktopName	string	The name of the cloud computer.	test
DesktopStatus	string	The status of the cloud computer. Valid values: Stopped Starting Rebuilding Running Stopping Expired Deleted Pending	Running
Creator	string	The user who creates the snapshot.	Administrator
ProtocolType	string	The protocol type. Valid values: HDX: High-definition Experience (HDX) protocol ASP: in-house Adaptive Streaming Protocol (ASP)	ASP
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 query the list of KMS keys.	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
DeletionTime	string	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
RestorePointId	string	The ID of the restore point.	rp-btgmaa20wkcju****
RestorePointName	string	The name of the restore point.	DataDiskBackup

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",
      "DiskStatus": "Available",
      "Creator": "Administrator",
      "ProtocolType": "ASP",
      "OsType": "Windows",
      "VolumeEncryptionEnabled": false,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "DeletionTime": "2020-12-20T14:52:28Z\n",
      "RestorePointId": "rp-btgmaa20wkcju****",
      "RestorePointName": "DataDiskBackup"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-04-10	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2025-01-15	The response structure of the API has changed	View Change Details
2023-03-01	The request parameters of the API has changed	View Change Details
2022-08-19	The response structure of the API has changed	View Change Details