Call ModifyBackupPolicy to modify the automatic backup policy - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

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

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 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	Whether to enable the data flashback feature for the instance. Valid values: 1: enables the data flashback feature. You must also enable append-only file (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 Tair (Enterprise Edition) DRAM-based and persistent memory-optimized instances. For more information, see Data flashback.	1
BackupRetentionPeriod	integer	No	The number of days to retain data backup files. Valid values: 7 to 730. Default value: 7.	7

Response elements

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

Examples

Success response

JSON format

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

Error response

JSON format

{
"RequestId" : "8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76”
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.