You need to enable JavaScript to run this app.
缓存数据库 Redis 企业版

缓存数据库 Redis 企业版

请输入
  • 文档首页
    • 缓存数据库 Redis 企业版API 参考备份恢复ModifyBackupPlan
复制全文
我的收藏
备份恢复
ModifyBackupPlan
复制全文
我的收藏
ModifyBackupPlan

调用 ModifyBackupPlan 修改目标 Redis 企业版实例的自动备份策略，包括开始执行备份时间段、开启或关闭自动备份等设置。

请求类型

同步请求。

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

参数
类型
是否必选
示例值
描述
InstanceId
String
是
redis-cn0212gzmh2xs****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。

Active
Boolean
是
true

是否启用自动备份。取值范围如下：

  • true：启用。
  • false：不启用。
Period
Integer[]
否
[1, 2, 3, 4, 5, 6, 7]

备份周期。
企业版实例固定为周一到周日每天备份一次，该参数取值必须为[1,2,3,4,5,6,7]。

说明

当启用自动备份（即 Active 取值为 true）时，该参数必填。

BackupHour
Integer
否
7

设置开始执行备份时间段（UTC+8）。取值范围为 0 到 23 间的任意整数。其中，0 表示系统会在 00:00~00:59 时段内执行备份，1 表示会在 01:00~01:59 时段内执行备份，以此类推。

说明

当启用自动备份（即 Active 取值为 true）时，该参数必填。

ClientToken
String
否
WbiAlPqJM6tMoSOYhT****
用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例 

POST https://redis.cn-beijing.volcengineapi.com/?Action=ModifyBackupPlan&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "redis-cn0212gzmh2xs****",
    "Period": [
        1,
        2,
        3,
        4,
        5,
        6,
        7
    ],
    "BackupHour": 7,
    "Active": true
}

返回示例 

{
    "ResponseMetadata": {
        "RequestId": "202204151625070102040572200263****",
        "Action": "ModifyBackupPlan",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情，请参见错误码。

最近更新时间：2025.08.14 15:34:21
这个页面对您有帮助吗？
有用
有用
无用
无用