ModifyCrossBackupPolicy--云数据库 SQL Server 版-火山引擎

文档中心

立即注册

导航

ModifyCrossBackupPolicy

最近更新时间：2025.06.04 11:23:26首次发布时间：2025.06.03 10:21:05

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

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
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	跨地域备份保留天数。

请求示例

POST /?Action=ModifyCrossBackupPolicy&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.cn-beijing.volcengineapi.com
X-Date: 20230131T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****

{
    "InstanceId": "mssql-04a911******",
    "BackupEnabled": true,
    "CrossBackupRegion": "cn-shanghai",
    "Retention": 14
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202505131134570CAA14043DFE7FEFD9D2-0b0eeb",
        "Action": "ModifyCrossBackupPolicy",
        "Version": "2022-01-01",
        "Service": "rds_mssql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BackupEnabled": true,
        "CrossBackupRegion": "cn-shanghai",
        "InstanceId": "mssql-04a911******",
        "Retention": 14
    }
}

错误码

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