Call ApplyAutoSnapshotPolicy to apply an automatic snapshot policy to cloud disks - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Applies an automatic snapshot policy to one or more disks.

Operation description

Each disk supports up to 10 automatic snapshot policies.
If a target disk already has an automatic snapshot policy, this operation adds the new policy without replacing the existing ones.

Note

To avoid unexpected charges, make sure to cancel any automatic snapshot policies that you no longer need.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:ApplyAutoSnapshotPolicy

update

*Disk

acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}

*AutoSnapshotPolicy

acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/{#snapshotpolicyId}

None

Request parameters

Parameter	Type	Required	Description	Example
regionId	string	Yes	The ID of the region where the automatic snapshot policy and target disks are located. You can call the DescribeRegions operation to get the latest list of Alibaba Cloud regions.	cn-hangzhou
autoSnapshotPolicyId	string	Yes	The ID of the automatic snapshot policy.	sp-bp14yziiuvu3s6jn****
diskIds	string	Yes	A JSON array of one or more disk IDs.	["d-bp14k9cxvr5uzy54**", "d-bp1dtj8v7x6u08iw", "d-bp1c0tyj9tfli2r8**"]

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error response

JSON format

{
    "RequestId":"F3CD6886-D8D0-4FEE-B93E-1B73239673DE"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DiskCategory.OperationNotSupported	The type of the specified disk does not support creating a snapshot.	The operation is not supported by the current disk category.
400	PartofDiskCategory.OperationNotSupported	The types of some disks in the disk list do not support creating snapshots.	Some of the specified disks do not support this operation.
400	InvalidAutoSnapshotPolicyId.NotFound	The specified AutoSnapshotPolicyId does not exist.	The specified automatic snapshot policy does not exist.
403	ParameterInvalid	The specified RegionId parameter is invalid.	The specified region ID is invalid.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	InvalidAccountStatus.SnapshotServiceUnavailable	Snapshot service has not been opened yet.	The operation is not supported while the snapshot service is not activated.
403	InvalidOperation.SnapshotAlreadyCreatedUnsupported	The current disk already has snapshots created by non-promotional activities. Snapshot policies bound to promotional activities are not supported.	The current disk already has snapshots created by non-promotional activities. Snapshot policies bound to promotional activities are not supported.
403	QuotaExceed.AppliedAutoSnapshotPolicyQuota	The number of auto snapshot policies applied to the specified disk %s has exceeded the quota %s. Please cancel any unused policies and try again.	The number of auto snapshot policies applied to the specified disk has exceeded the quota. Please cancel any unused policies and try again.
403	InvalidOperation.AutoSnapshotPolicyConflict	The disk %s cannot apply the auto snapshot policy of promotional activities and other policies at the same time.	The disk cannot apply the auto snapshot policy of promotional activities and other policies at the same time.
404	ParameterInvalid	The specified automatic snapshot policy does not exist.
404	InvalidDiskId.NotFound	The specified disk does not exist in the region.	The specified disk does not exist in the current region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.