文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 备份与恢复/ 设置Redis恢复到指定时间点策略 - SettingthePolicyforRestoringRedisDatatoaSpecifiedTimePoint
更新时间：2026-05-28 GMT+08:00
查看PDF
分享

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

功能介绍

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

接口约束

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:setRedisPitrPolicy

    write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:setRedisPitrPolicy

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，可以调用7.3.3 查询实例列表和详情接口获取。如果未申请实例，可以调用7.3.1 创建实例接口创建。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

enabled

是

Boolean

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

interval

否

Integer

参数解释：

数据备份的时间间隔，该数据备份控制redis实例可恢复时间点的间隔。

当interval为20min时，可恢复时间点的间隔为20min，interval越小，对性能影响越大，存储空间膨胀越明显。

约束限制：

不涉及。

取值范围：

5～120，单位：分钟

默认取值：

20分钟。

keep_days

否

Integer

参数解释：

指定已生成的备份文件可以保存的天数。

约束限制：

不涉及。

取值范围：

1～7，单位：天

默认取值：

1 天。

响应参数

状态码： 200

无响应参数。

请求示例

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

响应示例

无。

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份与恢复

相关文档