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

设置自动备份策略 - ConfiguringanAutomatedBackupPolicy

功能介绍

设置自动备份策略。

接口约束

该接口支持如下数据库实例。
  • GeminiDB Cassandra
  • GeminiDB Influx
  • GeminiDB Redis

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:setBackupPolicy

    Write

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

    nosql:backup:list

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/backups/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参数

参数

是否必选

参数类型

描述

backup_policy

是

object

参数解释:

备份策略对象，包括备份保留的天数和备份开始时间。详情请参考表4。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。
表4 BackupPolicy

参数

是否必选

参数类型

描述

keep_days

是

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

0～35。取0值，表示关闭自动备份策略。

默认取值:

不涉及。

start_time

否

String

参数解释:

备份时间段。

约束限制:

  • 自动备份将在该时间段内触发。开启自动备份策略时，该参数必选；关闭自动备份策略时，不传该参数。
  • HH取值必须比hh大1。
  • mm和MM取值必须相同，且取值必须为00、15、30、45。
  • 格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。

取值范围:

不涉及。

默认取值:

不涉及。

period

否

String

参数解释:

备份周期配置。

自动备份将在每星期指定的天进行。

约束限制:

启用自动备份策略时，此参数必选。如果自动备份策略关闭，则不需要传递该参数。

格式为半角逗号隔开的数字，数字代表星期。

取值范围:

  • 表4中参数keep_days取值为0天，不传该参数。
  • 表4中参数keep_days取值为1～6天，参数备份周期配置全选，取值为：1,2,3,4,5,6,7。
  • 表4中参数keep_days取值为7～35天，参数备份周期配置至少选择一周中的一天，示例：1,2,3,4。

默认取值:

不涉及。

响应参数

状态码：204

无响应参数。

请求示例

  • 开启或修改自动备份策略，备份周期为"1,2,3,4,5,6"，备份时间段为"01:00-02:00",备份保留天数为7天： 
    PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy
{
   "backup_policy" : { 
   "period" : "1,2,3,4,5,6", 
   "start_time" : "01:00-02:00", 
   "keep_days" : 7 
   }
 }
  • 关闭自动备份策略： 
    PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy
{
 
   "backup_policy" : { 
     "keep_days" : 0 
   }
 }

响应示例

状态码： 204

No Content

{ }

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份与恢复

相关文档