You can call this operation to create a snapshot for the system disk or data disk of a cloud desktop.

Description

The cloud desktop for whose disk you want to create a snapshot must be in the Running or Stopped state.

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 CreateSnapshot

The operation that you want to perform. Set the value to CreateSnapshot.
DesktopId String Yes ecd-gx2x1dhsmucyy****"

The ID of the cloud desktop.
RegionId String Yes cn-hangzhou

The ID of the region.
SnapshotName String Yes testSnapshotName

The name of the snapshot. The name must be 2 to 128 characters in length.

It cannot start with auto because snapshots whose names start with auto are recognized as automatic snapshots.

SourceDiskType String Yes system

The type of the disk for which to create a snapshot. Valid values:

  • system: system disk
  • data: data disk
Description String No testDescription

The description of the snapshot. The description can be up to 128 characters in length.

Response parameters

Parameter Type Example Description
RequestId String 3EB7FCEE-D731-4948-85A3-4B2C341CA983

The ID of the request.
SnapshotId String s-2ze81owrnv9pity4****

The ID of the snapshot.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=CreateSnapshot
&Description=testDescription
&DesktopId=ecd-gx2x1dhsmucyy****"
&RegionId=cn-hangzhou
&SnapshotName=testSnapshotName
&SourceDiskType=system
&<Common request parameters>

Sample success responses

XML format 

<CreateSnapshotResponse>
      <SnapshotId>s-2ze81owrnv9pity4****</SnapshotId>
      <RequestId>3EB7FCEE-D731-4948-85A3-4B2C341CA983</RequestId>
</CreateSnapshotResponse>

JSON format 

{
	"SnapshotId": "s-2ze81owrnv9pity4****",
	"RequestId": "3EB7FCEE-D731-4948-85A3-4B2C341CA983"
}

Error codes

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