DescribeSnapshots - WUYING Workspace - Alibaba Cloud Documentation Center

Queries the snapshots that are created based on a cloud computer 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.

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 most recent region list.	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 type of the disk for which the snapshot is created. Note The value of this parameter is not case-sensitive. Valid values: Data: data disk System: 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 maximum number of entries to return on each page. Valid values: 1 to 100 Default value: 10	10

Response parameters

Parameter	Type	Description	Example
	object	Schema of response.
NextToken	string	If the NextToken parameter is empty, no next page exists.	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId	string	The request ID.	51592A88-0F2C-55E6-AD2C-2AD9C10D****
Snapshots	object []	Details of the queried snapshots.
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

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 time

Summary of changes

Operation

2023-03-01

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Creator

2022-08-19

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.