All Products
Search
Document Center

Elastic Compute Service:ApplyAutoSnapshotPolicy

Last Updated:Nov 14, 2024

Applies an automatic snapshot policy to one or more disks. You can call this operation to replace the automatic snapshot policy of a disk.

Operation description

  • Each disk can have only one automatic snapshot policy.
  • Each automatic snapshot policy can be applied to multiple disks.

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:
    • The required resource types are displayed in bold characters.
    • 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
ecs:ApplyAutoSnapshotPolicyupdate
*Disk
acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}
*AutoSnapshotPolicy
acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/{#snapshotpolicyId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
regionIdstringYes

The region ID of the automatic snapshot policy and the disks. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
autoSnapshotPolicyIdstringYes

The ID of the automatic snapshot policy.

sp-bp14yziiuvu3s6jn****
diskIdsstringYes

The IDs of disks. The value is a JSON array that consists of disk IDs. Separate the disk IDs with commas (,).

["d-bp14k9cxvr5uzy54****", "d-bp1dtj8v7x6u08iw****", "d-bp1c0tyj9tfli2r8****"]

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400DiskCategory.OperationNotSupportedThe type of the specified disk does not support creating a snapshot.The operation is not supported by the current disk category.
400PartofDiskCategory.OperationNotSupportedThe types of some disks in the disk list do not support creating snapshots.Some of the specified disks do not support this operation.
403ParameterInvalidThe specified RegionId parameter is invalid.The specified region ID is invalid.
403ParameterInvalidThe specified AutoSnapshotPolicyId parameter is invalid.The specified AutoSnapshotPolicyId parameter is invalid.
403ParameterInvalidThe specified DiskIds are invalid.The specified disk ID is invalid.
403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.Your account balance is insufficient. Add funds to your account and try again.
403InvalidAccountStatus.SnapshotServiceUnavailableSnapshot service has not been opened yet.The operation is not supported while the snapshot service is not activated.
404ParameterInvalidThe specified automatic snapshot policy does not exist.The specified automatic snapshot policy does not exist.
404ParameterInvalidThe specified automatic snapshot policy does not exist in the region.The specified automatic snapshot policy does not exist.
404InvalidDiskId.NotFoundThe specified disk does not exist in the region.The specified disk does not exist in the current region.

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

Change history

Change timeSummary of changesOperation
2024-09-20The Error code has changedView Change Details