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

文档中心

立即注册

导航

ModifyCrossRegionBackupPolicy

最近更新时间：2025.06.25 10:58:00首次发布时间：2025.06.24 23:01:40

调用 ModifyCrossRegionBackupPolicy 接口修改目标 Redis 实例的跨地域备份策略。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
Active	Boolean	是	true	是否开启跨地域备份功能，取值范围如下： `true`：开启跨地域备份。 `false`：不开启跨地域备份。
CrossBackupRegion	String	否	cn-shanghai	跨地域备份的目的地域 ID。说明当开启跨地域备份功能（即 `Active` 为 `true`）时，该参数必填。当关闭跨地域备份功能（即 `Active` 为 `true`）时，该参数不生效。
ClientToken	String	否	WbiAlPqJM6tMoSOYhTOYhT	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

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

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=ModifyCrossRegionBackupPolicy&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****",
    "Active": true,
    "CrossBackupRegion": "cn-shanghai"
}

返回示例

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

错误码

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