ModifyBackupPolicy -

Modifies the automatic backup policy of an ApsaraDB for Redis instance.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:ModifyBackupPolicy	update	DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}	kvstore:EnableBackupLog	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	r-bp1zxszhcgatnx****
PreferredBackupTime	string	Yes	The time range to back up data. Specify the time in the HH:mmZ-HH:mmZ format. The time is displayed in UTC. Note The beginning and end of the time range must be on the hour. The duration must be an hour.	07:00Z-08:00Z
PreferredBackupPeriod	string	Yes	The days of the week to back up data. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Note Separate multiple options with commas (,).	Tuesday
EnableBackupLog	integer	No	Enables or disables the data flashback feature for the instance. Valid values: 1: enables the data flashback feature. You must also enable AOF persistence by setting `appendonly` to `yes` in the parameter settings of the instance. Then, you can use the data flashback feature. 0 (default): disables the data flashback feature. Note This parameter is available only for ApsaraDB for Redis Enhanced Edition (Tair) DRAM-based and persistent memory-optimized instances. For more information, see Data flashback.	1
BackupRetentionPeriod	integer	No	The number of days for which you want to retain data backup files. Valid values: 7 to 730. Default value: 7.	7

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	8D0C0AFC-E9CD-47A4-8395-5C31BF9B****

Examples

Sample success responses

JSONformat

{
  "RequestId": "8D0C0AFC-E9CD-47A4-8395-5C31BF9B****"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-05-16	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-01-30	The request parameters of the API has changed	View Change Details
2023-04-03	The internal configuration of the API is changed, but the call is not affected	View Change Details