文档中心

云数据库 SQL Server 版

备份恢复

ModifyCrossBackupPolicy - 修改跨地域备份策略

ModifyCrossBackupPolicy - 修改跨地域备份策略

调用 ModifyCrossBackupPolicy 接口修改跨地域备份策略。

调试

API Explorer

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

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ModifyCrossBackupPolicy

要执行的操作，取值：ModifyCrossBackupPolicy。

Version string 必选示例值：2022-01-01

API 的版本，取值：2022-01-01。

InstanceId string 必选示例值：mssql-1be522b5****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询实例 ID。

BackupEnabled boolean 可选示例值：true

是否开启跨地域备份，取值如下：

true：表示开启跨地域备份。

false：（默认值）表示关闭跨地域备份。

CrossBackupRegion string 可选示例值：cn-shanghai

跨地域备份的目的地域 ID。

说明

当 BackupEnabled 取值为 true 时，该参数必选。

Retention integer 可选示例值：14

跨地域备份保留天数，取值范围为 7~1825 天，默认值为 7。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

InstanceId string 示例值：mssql-1be522b5****

实例 ID。

BackupEnabled boolean 示例值：true

是否开启跨地域备份，取值如下：

true：表示开启跨地域备份。

false：表示关闭跨地域备份。

CrossBackupRegion string 示例值：cn-shanghai

跨地域备份的目的地域 ID。

Retention integer 示例值：7

跨地域备份保留天数。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is not valid.	参数 {parameter1} 值无效。

最近更新时间：2025.12.01 18:11:12

这个页面对您有帮助吗？

有用

有用

无用

无用