ModifyCrossRegionBackupPolicy--云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

ModifyCrossRegionBackupPolicy

最近更新时间：2025.06.06 10:53:59首次发布时间：2025.06.06 10:13:03

调用 ModifyCrossRegionBackupPolicy 接口设置跨地域备份策略。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	是	vedbm-gzwdsf9b****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询实例 ID。
CrossRegionBackup	Boolean	否	true	是否开启跨地域备份。取值为 `true`，表示开启跨地域备份。注意开启跨地域备份后，不支持关闭，请谨慎操作。
TargetRegion	String	否	cn-shanghai	跨地域备份的目的地域 ID。当前仅中国内地地域支持跨地域备份，支持以下取值： `cn-beijing`：华北 2（北京）。 `cn-shanghai`：华东 2（上海）。 `cn-guangzhou`：华南1（广州）。说明目标地域 ID 不能与原地域 ID 相同。您可调用 DescribeDBInstanceDetail 接口查询实例原地域 ID。开启跨地域备份功能后，不支持变更目标地域。
Retention	integer	否	7	跨地域备份保留天数，取值默认为 7 天，取值范围 7~365 天。

返回参数

null

请求示例

POST /?Action=ModifyCrossRegionBackupPolicy&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host:vedbm.cn-beijing.volcengineapi.com
X-Date: 20220316T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220316/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****

{
    "InstanceId": "vedbm-gzwdsf9b****",
    "BackupEnabled": true,
    "CrossBackupRegion": "cn-shanghai"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202503201717122FD7BF12E55548C8A3EF-91b659",
        "Action": "ModifyCrossRegionBackupPolicy",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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