Creates an automatic snapshot policy in a specific region. Automatic snapshot policies allow Elastic Compute Service (ECS) to create snapshots for a disk on a regular basis to back up data. The policies can be applied to both system disks and data disks. If cross-region snapshot replication is enabled and no encryption parameters are configured, encrypted snapshots are copied to the destination region and snapshot copies are encrypted by using the default service customer master key (CMK) that was created by Key Management Service (KMS) in the destination region.
Operation description
Usage notes
When you call this operation to create an automatic snapshot policy, you can specify the days of the week on which to create automatic snapshots, the retention period of the automatic snapshots, and whether to enable cross-region replication for the snapshots in the policy to meet your diverse data backup requirements. After the automatic snapshot policy is created, call the ApplyAutoSnapshotPolicy operation to apply the policy to disks. If you want to modify the automatic snapshot policy, call the ModifyAutoSnapshotPolicyEx operation.
Take note of the following items:
- You can create up to 100 automatic snapshot policies per region for a single Alibaba Cloud account.
- If an automatic snapshot is being created when the time scheduled for creating another automatic snapshot is due, the new snapshot task is skipped. This may occur when a disk contains a large volume of data. For example, you have scheduled snapshots to be created at 09:00:00, 10:00:00, 11:00:00, and 12:00:00 for a disk. The system starts to create a snapshot for the disk at 09:00:00. The process takes 80 minutes to complete because the disk contains a large volume of data and ends at 10:20:00. In this case, the system does not create a snapshot at 10:00, but creates a snapshot at 11:00.
- For information about how to copy a snapshot from one region to another region, see the "Background information" section in Copy a snapshot.
Debugging
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| regionId | string | Yes | The ID of the region in which to create the automatic snapshot policy. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| autoSnapshotPolicyName | string | No | The name of the automatic snapshot policy. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-). By default, this parameter is left empty. | TestName |
| timePoints | string | Yes | The points in time of the day at which to create automatic snapshots. The time must be in UTC+8. Unit: hours. Valid values: 0 to 23, which correspond to the 24 on-the-hour points in time from 00:00:00 to 23:00:00. 1 indicates 01:00:00. Format description:
| ["0", "1", … "23"] |
| repeatWeekdays | string | Yes | The days of the week on which to create automatic snapshots. Valid values: 1 to 7, which correspond to Monday to Sunday. 1 indicates Monday. Format description:
| ["1","2"] |
| retentionDays | integer | Yes | The retention period of the automatic snapshot. Unit: days. Valid values:
Default value: -1. | 30 |
| EnableCrossRegionCopy | boolean | No | Specifies whether to enable cross-region replication for snapshots.
| false |
| TargetCopyRegions | string | No | The destination region to which to copy the snapshot. You can specify only a single destination region. | ["cn-hangzhou"] |
| StorageLocationArn | string | No | Note
This parameter is not publicly available.
| null |
| CopiedSnapshotsRetentionDays | integer | No | The retention period of the snapshot copy in the destination region. Unit: days. Valid values:
Default value: -1. | 30 |
| Tag | object [] | No | The tags to add to the snapshot. | |
| Key | string | No | The key of tag N to add to the snapshot. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun. | TestKey |
| Value | string | No | The value of tag N to add to the snapshot. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain http:// or https://. The tag value cannot start with acs:. | TestValue |
| ResourceGroupId | string | No | The resource group ID. | rg-aek2kkmhmhs**** |
| CopyEncryptionConfiguration | object | No | The encryption parameters for cross-region snapshot replication. | |
| Encrypted | boolean | No | Specifies whether to enable cross-region snapshot replication and encryption. Valid values:
Default value: false. | false |
| KMSKeyId | string | No | The ID of the KMS key used in cross-region snapshot replication and encryption. | 0e478b7a-4262-4802-b8cb-00d3fb40826X |
| Arn | object [] | No | This parameter is not publicly available. | |
| RoleType | string | No | This parameter is not publicly available. | hide |
| Rolearn | string | No | This parameter is not publicly available. | hide |
| AssumeRoleFor | long | No | This parameter is not publicly available. | 1000000000 |
Response parameters
Examples
Sample success responses
JSONformat
{
"AutoSnapshotPolicyId": "sp-bp12m37ccmxvbmi5****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}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 | InvalidSnapshotPolicyName.Malformed | The specified autoSnapshotPolicyName is wrongly formed. | - |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | The specified tag key already exists. Tag keys must be unique. |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | The specified Tag.N.Key parameter is invalid. |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | The specified tag value is invalid. |
| 400 | InvalidParameter.EncryptedIllegal | The specified parameter Encrypted must be true when kmsKeyId is not empty. | The encryption feature is not enabled after a Key Management Service (KMS) key ID is specified. |
| 400 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | The customer master key (CMK) is not enabled when KMSKeyId is specified for an encrypted disk. You can call the DescribeKey operation of KMS to query information about the specified CMK. |
| 400 | InvalidParameter.KmsNotEnabled | Failed to perform this operation because KMS is not activated. | You need to activate KMS key management service. |
| 400 | InvalidParameter.Encrypted.KmsNotEnable | Failed to perform this operation because KMS is not activated. | You need to activate KMS key escrow service. |
| 400 | InvalidParam.EncryptedMismatch | Creating encrypted disks with shared encrypted image requires replacing encryption keys. | You must change the encryption key to create a cloud disk after sharing an encrypted image. |
| 403 | ParameterInvalid | The specified RegionId parameter is invalid. | The specified region ID is invalid. |
| 403 | ParameterInvalid | The specified RepeatWeekDays parameter is invalid. | The specified RepeatWeekdays parameter is invalid. |
| 403 | ParameterInvalid | The specified TimePoints parameter is invalid. | The specified TimePoints parameter is invalid. |
| 403 | ParameterInvalid | The specified RetentionDays parameter is invalid. | The specified RetentionDays parameter is invalid. |
| 403 | AutoSnapshotPolicy.QuotaExceed | The maximum number of automatic snapshot policy has been reached. | The maximum number of automatic snapshot policy is exceeded. |
| 403 | InvalidAccountStatus.NotEnoughBalance | Your account does not have enough balance. | Your account balance is insufficient. Add funds to your account and try again. |
| 403 | InvalidAccountStatus.SnapshotServiceUnavailable | Snapshot service has not been opened yet. | The operation is not supported while the snapshot service is not activated. |
| 403 | InvalidParameter.TargetCopyRegions | The specified TargetCopyRegions is invalid. | - |
| 403 | InvalidParameter.CopiedSnapshotsRetentionDays | The specified CopiedSnapshotsRetentionDays is invalid. | - |
| 403 | InvalidParameter.KMSKeyId.CMKUnauthorized | The CMK needs to be added ECS tag. | - |
| 403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service have no right to access your KMS. | ECS is not authorized to access your KMS resources. |
| 403 | InvalidOperation.KMSKeyIdNotFound | The specified KMSKeyId not found, %s. | The associated KMS encryption key cannot be found. Verify that the KMS encryption key is valid. |
| 403 | Abs.InvalidAction.RegionNotSupport | This region does not support this action. | The operation is not supported in the region. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2024-03-21 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
| 2024-02-28 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||
|