All Products
Search
Document Center

Elastic Desktop Service:CreateAutoSnapshotPolicy

Last Updated:Nov 14, 2025

Creates an automatic snapshot policy. WUYING WorkSpace automatically creates snapshots based on the time specified by the cron expression in the automatic snapshot policy.

Operation description

You can call the operation to create an automatic snapshot policy based on a CRON expression. Then, the system automatically creates snapshots of a cloud desktop based on the policy.

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:CreateAutoSnapshotPolicycreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
PolicyNamestringYes

The name of the automatic snapshot policy. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-). This parameter is empty by default.

test_auto_policy
RetentionDaysintegerYes

The retention period of the automatic snapshots. Unit: days. Valid values: 1 to 180.

30
CronExpressionstringYes

The CRON expression for periodic scheduling.

0 0 2 ? * 1-7

Response parameters

ParameterTypeDescriptionExample
object
PolicyIdstring

The ID of the automatic snapshot policy.

sp-3hpa78d0qyt99****
RequestIdstring

The request ID.

51592A88-0F2C-55E6-AD2C-2AD9C10D****

Examples

Sample success responses

JSONformat

{
  "PolicyId": "sp-3hpa78d0qyt99****",
  "RequestId": "51592A88-0F2C-55E6-AD2C-2AD9C10D****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-09-12The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-02-04The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-03-02The internal configuration of the API is changed, but the call is not affectedView Change Details