ModifyBackupPlan--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

ModifyBackupPlan

最近更新时间：2024.09.13 11:12:18首次发布时间：2021.11.15 16:07:16

调用 ModifyBackupPlan 修改目标 Redis 实例的自动备份策略，包括备份周期、开启或关闭自动备份等设置。

请求类型

同步请求。

注意事项

仅主备实例（即 InstanceClass 为 PrimarySecondary）支持调用该接口，单节点实例（即 InstanceClass 取值为 Standalone）不支持备份恢复相关操作，不支持调用该接口。关于两种类型实例的功能特性差异详情，请参见功能特性差异。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
Active	Boolean	是	true	是否启用自动备份。取值范围如下： `true`：启用。 `false`：不启用。
Period	Integer[]	否	[ 1, 2, 3, 4 ]	备份周期。取值范围为 1 到 7 之间的任意整数，多个值间用英文逗号（,）分隔。其中，1 表示每周一进行备份，2 表示每周二进行备份，以此类推。说明当启用自动备份（即 `Active` 取值为 `ture`）时，该参数必填。
BackupHour	Integer	否	7	设置开始执行备份时间段。取值范围为 0 到 23 间的任意整数。其中，0 表示系统会在 `00:00~01:00` 时段内执行备份，1 表示会在 `01:00~02:00` 时段内执行备份，以此类推。说明当启用自动备份（即 `Active` 取值为 `ture`）时，该参数必填。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

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

示例

请求示例

POST https://redis.volcengineapi.com/?Action=ModifyBackupPlan&Version=2020-12-07 HTTP/1.1
Host: redis.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],
	"BackupHour": 7,
	"Active": true
}

返回示例

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

错误码

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