1. 接口描述
接口请求域名： sqlserver.tencentcloudapi.com 。
本接口（ModifyBackupStrategy）用于修改备份策略
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyBackupStrategy。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID 示例值：mssql-j8kv137v |
| BackupType | 否 | String | 备份类型，当length(BackupDay) <=7 && length(BackupDay) >=2时，取值为weekly，当length(BackupDay)=1时，取值daily，默认daily 示例值：daily |
| BackupTime | 否 | Integer | 备份时间点，取值为0-23的整数 示例值：14 |
| BackupDay | 否 | Integer | BackupType取值为daily时，表示备份间隔天数。当前取值只能为1 示例值：1 |
| BackupModel | 否 | String | 备份模式（必填），master_pkg-主节点上打包备份文件；master_no_pkg-主节点单库备份文件；slave_pkg-从节点上打包备份文件；slave_no_pkg-从节点上单库备份文件，从节点上备份只有在always on容灾模式下支持。 示例值：master_no_pkg |
| BackupCycle.N | 否 | Array of Integer | BackupType取值为weekly时，表示每周的星期N做备份。（如果数据备份保留时间<7天，则取值[1,2,3,4,5,6,7]。如果数据备份保留时间>=7天，则备份周期取值至少是一周的任意2天） 示例值：[1,2,3,4,5,6,7] |
| BackupSaveDays | 否 | Integer | 数据(日志)备份保留天数（必填），取值[3-1830]天，默认7天 示例值：7 |
| RegularBackupEnable | 否 | String | 定期备份状态 enable-开启，disable-关闭，默认关闭 示例值：disable |
| RegularBackupSaveDays | 否 | Integer | 定期备份保留天数 [90 - 3650]天，默认365天 示例值：90 |
| RegularBackupStrategy | 否 | String | 定期备份策略 years-每年，quarters-每季度，months-每月，默认months 示例值：months |
| RegularBackupCounts | 否 | Integer | 定期备份保留个数，默认1个 示例值：1 |
| RegularBackupStartTime | 否 | String | 定期备份开始日期，格式-YYYY-MM-DD 默认当前日期 示例值：2022-10-10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Msg | String | 返回错误信息 示例值：failed |
| Code | Integer | 返回错误码 示例值：0 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改实例mssql-j8kv137v的备份策略
输入示例
POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBackupStrategy
<公共请求参数>
{
"BackupTime": "14",
"InstanceId": "mssql-j8kv137v",
"RegularBackupCounts": "1",
"BackupSaveDays": "7",
"BackupDay": "1",
"RegularBackupSaveDays": "365",
"BackupType": "daily",
"RegularBackupEnable": "enable",
"RegularBackupStrategy": "month",
"RegularBackupStartTime": "2022-10-10"
}输出示例
{
"Response": {
"RequestId": "780339f6-30d7-419a-a30c-c2dc0933af1c",
"Code": 0,
"Msg": ""
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.GcsError | GCS接口错误。 |
| InternalError.SystemError | 系统错误。 |
| InvalidParameter.InputIllegal | 输入错误。 |
| InvalidParameter.ParamsAssertFailed | 参数断言转换错误。 |
| ResourceNotFound.InstanceNotFound | 实例不存在。 |
| ResourceUnavailable.InstanceStatusInvalid | 实例状态无效。 |
| UnauthorizedOperation.PermissionDenied | cam鉴权错误。 |
