ModifyAutoSnapshotPolicyEx - Elastic Compute Service - Alibaba Cloud Documentation Center

Modifies an automatic snapshot policy. After an automatic snapshot policy is modified, the modifications immediately take effect on the disks that are associated with the policy. If cross-region replication for snapshots is enabled and no encryption parameters are configured, the generated encrypted snapshot copies are encrypted by using the Key Management Service (KMS) encryption keys in the region to which the snapshots are copied.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
regionId	string	Yes	The ID of the automatic snapshot policy. You can call the DescribeAutoSnapshotPolicyEx operation to query available automatic snapshot policies.	cn-hangzhou
autoSnapshotPolicyId	string	Yes	The name of the automatic snapshot policy. If this parameter is not specified, the original name of the automatic snapshot policy is retained.	sp-bp12m37ccmxvbmi5****
autoSnapshotPolicyName	string	No	The points in time of the day at which to create automatic snapshots. The time must be in UTC+8. Unit: hours. Valid values are 0 to 23, which correspond to the 24 points in time on the hour from 00:00:00 to 23:00:00. For example, a value of 1 indicates 01:00:00. To schedule multiple automatic snapshots to be created in a day, you can specify multiple hours. You can specify up to 24 points in time. You must set this parameter to a JSON array such as `["0", "1", ... "23"]`. Separate the points in time with commas (,).	SPTestName
timePoints	string	No	The days of the week on which to create automatic snapshots. Valid values are 1 to 7, which correspond to the days of the week. For example, a value of 1 indicates Monday. To schedule multiple automatic snapshots to be created in a week, you can specify multiple days. You can specify up to seven days over a one-week period. You must set this parameter to a JSON array such as `["1", "2" ... "7"]`. Separate the values in the array with commas (,).	["0", "1"]
repeatWeekdays	string	No	The retention period of the automatic snapshot. Unit: days. Valid values: -1: The automatic snapshot is permanently retained. 1 to 65536: The auto snapshot is retained for the specified number of days. Default value: -1.	["1", "7"]
retentionDays	integer	No	Specifies whether to enable cross-region replication for the automatic snapshot. true: enables cross-region replication for the automatic snapshot. false: disables cross-region replication for the automatic snapshot.	30
EnableCrossRegionCopy	boolean	No	The destination region to which to copy the snapshot. You can specify only a single destination region.	false
TargetCopyRegions	string	No	The retention period of the snapshot copy in the destination region. Unit: days. Valid values: -1: The snapshot is permanently retained. 1 to 65535: The automatic snapshot is retained for the specified number of days. Default value: -1.	["cn-hangzhou"]
CopiedSnapshotsRetentionDays	integer	No	The ID of the request.	30
CopyEncryptionConfiguration	object	No	The encryption configurations for cross-region snapshot replication.
Encrypted	boolean	No	Specifies whether to enable encryption for cross-region snapshot replication. Valid values: true false Default value: false.	false
KMSKeyId	string	No	The ID of the KMS key used for encryption in cross-region snapshot replication.	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

Parameter	Type	Description	Example

The current API has no return parameters

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
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 AutoSnapshotPolicyId is invalid.	The specified automatic snapshot policy ID is invalid.
403	ParameterInvalid	The specified RetentionDays parameter is invalid.	The specified RetentionDays parameter is invalid.
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	Abs.InvalidAction.RegionNotSupport	This region does not support this action.	The operation is not supported in the region.
404	ParameterInvalid	The specified automatic snapshot policy does not exist.	The specified automatic snapshot policy does not exist.
404	ParameterInvalid	The specified automatic snapshot policy does not exist in the region.	The specified automatic snapshot policy does not exist.
404	InvalidParameter.KMSKeyId.NotFound	The specified KMSKeyId does not exist.	The specified KMSKeyId parameter does not exist.

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

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change
	delete Error Codes: 403
	delete Error Codes: 404

2024-02-29

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 404

2024-02-28

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 404

2024-02-28

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 403 change
	Error Codes 404 change
	Added Error Codes: 400
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: CopyEncryptionConfiguration