1. 接口描述
接口请求域名： sqlserver.tencentcloudapi.com 。
本接口(CreateBackup)用于创建备份。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateBackup。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Strategy | 否 | Integer | 备份策略(0-实例备份 1-多库备份) 示例值：1 |
| DBNames.N | 否 | Array of String | 需要备份库名的列表(多库备份才填写) 示例值：["db1\r\n","db2\r\n"] |
| InstanceId | 否 | String | 实例ID（必填），形如mssql-i1z41iwd 示例值：mssql-njj2mtpl |
| BackupName | 否 | String | 备份名称，若不填则自动生成“实例ID_备份开始时间戳” 示例值：BackupName |
| StorageStrategy | 否 | Integer | 备份存储策略 0-跟随自定义备份保留策略 1-跟随实例生命周期直到实例下线，默认取值0 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FlowId | Integer | 异步任务ID 示例值：5293 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建备份
创建备份
输入示例
https://sqlserver.tencentcloudapi.com/?Action=CreateBackup
&InstanceId=mssql-njj2mtpl
&Strategy=1
&DBNames.0=db1
&DBNames.1=db2
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
"FlowId": 5293
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DBError | 数据库错误。 |
| FailedOperation.GcsError | 操作失败或者网络超时。 |
| InternalError | 内部错误。 |
| InternalError.DBError | 数据库错误。 |
| InternalError.GcsError | GCS接口错误。 |
| InternalError.SystemError | 系统错误。 |
| InternalError.UnknownError | 未知错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InputIllegal | 输入错误。 |
| InvalidParameter.ParamsAssertFailed | 参数断言转换错误。 |
| InvalidParameterValue.BackupNameIsIllegal | 备份名称存在非法字符。 |
| LimitExceeded.TooManyDB | 数据库超过限制。 |
| ResourceNotFound.DBNotFound | 数据库不存在。 |
| ResourceNotFound.InstanceNotFound | 实例不存在。 |
| ResourceUnavailable.DBInvalidStatus | 数据库状态无效。 |
| ResourceUnavailable.InstanceStatusInvalid | 实例状态无效。 |
| UnauthorizedOperation.PermissionDenied | cam鉴权错误。 |
