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

查询Redis恢复到指定时间点策略 - QueryingthePolicyforRestoringRedisDatatoaSpecifiedTimePoint

功能介绍

查询Redis恢复到指定时间点策略。

接口约束

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:getRedisPitrPolicy

    read

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

    nosql:instance:getRedisPitrPolicy

    -

URI

GET /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。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

enabled

Boolean

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

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

interval

Integer

数据备份的时间间隔，仅在开启时返回。

keep_days

Integer

指定已生成的备份文件可以保存的天数，仅在开启时返回。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/redis/instances/e73893ef73754465a8bd2e0857bbf13ein12/pitr/policy

响应示例

状态码： 200

Success

{ 
   "enabled" : true, 
   "interval" : 20, 
   "keep_days" : 7 
 }

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份与恢复