Setting the Policy for Restoring Redis Data to a Specified Time Point

Function

This API is used to set the policy for restoring Redis data to a specified time point.

Constraints

This API supports only GeminiDB Redis instances in a proxy cluster.
Some instances of earlier versions need to be upgraded to use this API.

URI

PUT /v3/{project_id}/redis/instances/{instance_id}/pitr/policy

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
enabled	Yes	Boolean	Whether to enable point-in-time restoration for a Redis instance. true: indicates that the point-in-time restoration is enabled for the instance. false: indicates that the point-in-time restoration is disabled for the instance.
interval	No	Integer	Interval for backing up data. The default value is 20, in minutes, and the value ranges from 5 to 120. For example, if interval is set to 20 minutes, data will be recovered every 20 minutes. Shorter intervals may affect performance and demand additional storage.
keep_days	No	Integer	Backup retention days. The default value is 1, in days, and the value ranges from 1 to 7.

Response Parameters

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/instances/e73893ef73754465a8bd2e0857bbf13ein12/pitr/policy 
  
 { 
   "enabled" : true, 
   "interval" : 20, 
   "keep_days" : 7 
 }