文档首页/ 云数据库 GeminiDB/ API参考/ API v3(推荐)/ 备份与恢复/ 设置Redis恢复到指定时间点策略
更新时间:2024-12-02 GMT+08:00
分享

设置Redis恢复到指定时间点策略

功能介绍

设置Redis恢复到指定时间点策略。

接口约束

  • 该接口只支持GeminiDB Redis集群版。
  • 部分低版本的实例,需要补丁升级以支持Redis指定时间点恢复功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一region下的project ID。获取方法请参见获取项目ID

instance_id

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

enabled

Boolean

标识Redis实例是否开启指定时间点恢复。

  • “true”表示实例开启Redis指定时间点恢复功能。
  • “false”表示实例不启用Redis指定时间点恢复功能。

interval

Integer

数据备份的时间间隔。默认值:20分钟,取值范围:5~120,单位:分钟。

例如,当interval为20分钟时,可恢复时间点的间隔为20分钟。其interval约小,对性能影响越大,存储空间膨胀越明显。

keep_days

Integer

指定已生成的备份文件可以保存的天数。默认值:1 天,取值范围:1~7,单位:天。

响应参数

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

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

响应示例

无。

状态码

请参见状态码

错误码

请参见错误码

相关文档