文档首页/ 云数据库 RDS/ API参考/ API v3(推荐)/ 备份与恢复/ 修改实例稀疏备份策略 - UpdateSparseBackupPolicy
更新时间:2026-07-02 GMT+08:00
分享

修改实例稀疏备份策略 - UpdateSparseBackupPolicy

功能介绍

修改实例稀疏备份策略。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

rds:instance:modifyBackupPolicy

permission_management

instance

g:EnterpriseProjectId

rds:BackupEnabled

g:ResourceTag/<tag-key>

-

-

接口约束

  • 该接口仅支持PostgreSQL引擎。
  • 不支持单独设置稀疏备份策略的start_time。稀疏备份策略的start_time与该实例基础备份策略的start_time相同,获取方法请参见查询自动备份策略 - ShowBackupPolicy

URI

  • URI格式

    POST /v3/{project_id}/instances/{instance_id}/backups/sparse-policy

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    参数解释:

    租户在某一region下的project ID。

    获取方法请参见获取项目ID

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

    instance_id

    String

    参数解释:

    实例ID。

    可调用查询数据库实例列表接口,通过表4中的“id”获取。

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

请求消息

表2 参数说明

参数

是否必选

参数类型

描述

policies

Array of Object

参数解释:

备份策略集。

详情请参见表3

约束限制:

不涉及。

表3 policies字段说明

参数

是否必选

参数类型

描述

id

String

参数解释:

备份策略ID。

约束限制:

备份策略可能关联多个已生成的备份集,修改、删除策略会对该策略所关联的已生成的备份集生效。如果修改某策略的备份保留天数小于原保留天数或删除某策略,可能会导致关联该条策略的现有全量备份过期删除,请检查策略后再次确认。

取值范围:

  • 不填写ID时,表示新增一条备份策略。
  • 填写当前存在的备份策略ID时,表示修改或删除该条备份策略的内容,ID获取方法请参见查询稀疏备份策略 - ListSparseBackupPolicy
    • 如您要删除该备份策略,请填写其keep_days为0,period为null,同时必须填写reserve_backups来说明是否保留已生成的与该条备份策略关联的自动备份。
    • 如您要修改该备份策略,至少需要填写period、keep_days其中之一。

默认取值

不涉及。

period

String

参数解释:

备份周期配置。

约束限制:

该字段为UTC时区的Cron表达式,和备份时间段start_time共同作用。实例基础备份策略的start_time获取方法请参见查询自动备份策略 - ShowBackupPolicy,稀疏备份策略的start_time与基础备份策略一致。

比如当地时区为UTC+08:00,接口查询到的start_time为21:00-22:00时,对应的备份时间是当地时间05:00-06:00。当您设置稀疏备份策略的period为1 * *,意为该条策略将在UTC时区的每月1号21:00-22:00执行任务,也即您所在的UTC+08:00时区的每月2号05:00-06:00执行任务。

新增策略时,该字段必填。

取值范围:

格式必须为“日期 月份 星期”形式的Cron表达式,时区为UTC时区,且需要符合周策略、月策略或者年策略的形式,规则如下:

  • 周策略

    日期需填写*,月份需填写*。星期支持填写1~7(1表示星期一,2表示星期二,依次类推),支持填写多个数字,需以逗号隔开。

    取值示例:

    * * 6 表示每周六执行任务。

    * * 1,2,3 表示每周一、二、三执行任务。

  • 月策略

    月份需填写*,星期需填写*。日期支持填写1~28和特殊字符L(表示最后一天),支持填写多个数字,需以逗号隔开。

    取值示例:

    1,2 * * 表示每月1号、2号执行任务。

    L * * 表示每月的最后一天执行任务。

  • 年策略

    星期需填写*。日期支持填写1~31,月份支持填写1~12,日期和月份的组合需要为有效的日期。

    取值示例:

    15 3 * 表示每年的3月15日执行任务。

默认取值

不涉及。

keep_days

Integer

参数解释:

备份文件可以保存的天数。

约束限制:

新增策略时,该字段必填。

取值范围:

0~3660。取0值时,表示删除该条备份策略。

默认取值

不涉及。

reserve_backups

Boolean

参数解释:

删除备份策略时是否保留备份集。

约束限制:

仅在keep_days填写0时生效,删除备份策略时,该字段必填。

备份策略可能关联多个已生成的备份集,如果设置本字段为false,所有关联此策略的备份数据都会被立即清理,请谨慎操作。

取值范围:

  • true:表示保留该条备份策略关联的自动备份。
  • false:表示删除该条备份策略的同时,立即删除该条策略关联的自动备份。

默认取值

不涉及。

请求示例

修改实例稀疏备份策略。

POST https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/a2471f32101d4b57ae2a09f489ac16cein03/backups/sparse-policy

{
    "policies": [
        {
            "period": "3 7 *",
            "keep_days": 7
        }
    ]
}

响应消息

  • 正常响应要素说明

    无。

  • 正常响应样例

    无。

状态码

错误码

请参见错误码

相关文档