You can call this operation to query details of a snapshot or all snapshots of a cloud disk.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeSnapshots

The operation that you want to perform. Set the value to DescribeSnapshots.

RegionId String Yes cn-hangzhou

The ID of the region.

DesktopId String No ecd-gx2x1dhsmucyy****

The ID of the cloud desktop.

SnapshotId String No s-2ze81owrnv9pity4****

The ID of the snapshot.

MaxResults Integer No 10

The number of entries to return on each page.

Default value: 100.

NextToken String No AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****

The query token. Set the value to the NextToken value returned in the last call to the DescribeSnapshots operation.

Response parameters

Parameter Type Example Description
NextToken String AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****

The query token returned in this call.

RequestId String FB550AAB-FB36-4A91-93F6-F4374AF65403

The ID of the request.

Snapshots Array of Snapshot

Details about the snapshots.

CreationTime String 2020-12-20T14:52:28Z

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.

Description String testDescription

The description of the snapshot.

DesktopId String ecd-g03l3tlm8djoj****

The ID of the cloud desktop to which the snapshot belongs.

Progress String 100%

The progress of creating the snapshot. Unit: %.

RemainTime Integer 30

The remaining time that is required to create the snapshot. Unit: seconds.

SnapshotId String s-2zeipxmnhej803x7****

The ID of the snapshot.

SnapshotName String testSnapshotName

The name of the snapshot.

SnapshotType String user

The type of the snapshot. Valid values:

  • AUTO: automatic snapshot
  • USER: manual snapshot
SourceDiskSize String 150

The capacity of the source disk. Unit: GiB.

SourceDiskType String system

The type of the source disk. Valid values:

  • system: system disk
  • data: data disk
Status String accomplished

The status of the snapshot. Valid values:

  • progressing: The snapshot was being created.
  • accomplished: The snapshot was created.
  • failed: The snapshot failed to be created.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeSnapshots
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribeSnapshotsResponse>
      <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****</NextToken>
      <RequestId>FB550AAB-FB36-4A91-93F6-F4374AF65403</RequestId>
      <Snapshots>
            <Status>accomplished</Status>
            <Progress>100%</Progress>
            <Description>testDescription</Description>
            <DesktopId>ecd-g03l3tlm8djoj****</DesktopId>
            <SnapshotName>testSnapshotName</SnapshotName>
            <SnapshotId>s-2zeipxmnhej803x7****</SnapshotId>
            <SourceDiskSize>150</SourceDiskSize>
            <CreationTime>2020-12-20T14:52:28Z</CreationTime>
            <SnapshotType>user</SnapshotType>
            <RemainTime>30</RemainTime>
            <SourceDiskType>system</SourceDiskType>
      </Snapshots>
</DescribeSnapshotsResponse>

JSON format

{
	"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
	"RequestId": "FB550AAB-FB36-4A91-93F6-F4374AF65403",
	"Snapshots": [{
		"Status": "accomplished",
		"Progress": "100%",
		"Description": "testDescription",
		"DesktopId": "ecd-g03l3tlm8djoj****",
		"SnapshotName": "testSnapshotName",
		"SnapshotId": "s-2zeipxmnhej803x7****",
		"SourceDiskSize": "150",
		"CreationTime": "2020-12-20T14:52:28Z",
		"SnapshotType": "user",
		"RemainTime": "30",
		"SourceDiskType": "system"
	}]
}

Error codes

For a list of error codes, visit the API Error Center.