云数据库 SQL Server 开启、关闭跨地域备份策略-备份相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： sqlserver.tencentcloudapi.com 。

本接口(ModifyCrossBackupStrategy)用于开启、关闭地域备份策略。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyCrossBackupStrategy。
Version	是	String	公共参数，本接口取值：2018-03-28。
Region	是	String	公共参数，详见产品支持的地域列表。
CrossBackupEnabled	是	String	跨地域备份开关(数据备份&日志备份) enable-开启，disable-关闭示例值：enable
InstanceId	否	String	实例Id 示例值：mssql-7vfv3rk3
InstanceIdSet.N	否	Array of String	实例ID列表示例值：[mssql-7vfv3rk3]
CrossBackupSaveDays	否	Integer	跨地域备份保留天数，取值：7~1830，默认7天示例值：7
CrossBackupRegion.N	否	Array of String	跨地域备份的目标地域ID，最多两个，最少一个示例值：[ap-guangzhou]
CleanUpCrossBackup	否	Integer	是否立即清理跨地域备份(数据备份&日志备份) ，只有在BackupEnabled = disable时有效。1-是，0-否，默认：0 示例值：1

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 开启、关闭跨地域备份策略

输入示例

https://sqlserver.tencentcloudapi.com/?Action=ModifyCrossBackupStrategy
&InstanceId=mssql-7vfv3rk3
&InstanceIdSet.0=mssql-7vfv3rk3
&CrossBackupEnabled=enable
&CrossBackupSaveDays=7
&CrossBackupRegion.0=ap-guangzhou
&CleanUpCrossBackup=1
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "fc765108-efcd-11ec-887f-525400853186"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.DBError	数据库错误。
InvalidParameter.InputIllegal	输入错误。
InvalidParameterValue.IllegalRegion	地域错误。
ResourceUnavailable.InstanceStatusInvalid	实例状态无效。
UnauthorizedOperation.PermissionDenied	cam鉴权错误。

开启、关闭跨地域备份策略

本页目录：