All Products
Search
Document Center

Elastic Desktop Service:CreateSnapshot

Last Updated:Oct 17, 2024

Create a snapshot for a disk of a cloud computer to back up or restore the data on the disk.

Operation description

The cloud computer must be in the Running or Stopped state.

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DesktopIdstringYes

The ID of the cloud computer.

ecd-gx2x1dhsmucyy****"
SnapshotNamestringYes

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.

testSnapshotName
DescriptionstringNo

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

testDescription
SourceDiskTypestringYes

The type of the disk for which you want to create a snapshot.

Valid values:

  • system: system disk

  • data: data disk

system

Response parameters

ParameterTypeDescriptionExample
object

The object returned.

SnapshotIdstring

The ID of the snapshot.

s-2ze81owrnv9pity4****
RequestIdstring

The ID of the region.

3EB7FCEE-D731-4948-85A3-4B2C341CA983

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2024-02-05The internal configuration of the API is changed, but the call is not affectedView Change Details
2022-11-22The internal configuration of the API is changed, but the call is not affectedView Change Details