1. 接口描述
接口请求域名： sqlserver.tencentcloudapi.com 。
本接口（CreateBackupMigration）用于创建备份导入任务。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateBackupMigration。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 导入目标实例ID 示例值：mssql-rdc0gajn |
| RecoveryType | 是 | String | 迁移任务恢复类型，FULL-全量备份恢复，FULL_LOG-全量备份+事务日志恢复，FULL_DIFF-全量备份+差异备份恢复 示例值：FULL |
| UploadType | 是 | String | 备份上传类型，COS_URL-备份放在用户的对象存储上，提供URL。COS_UPLOAD-备份放在业务的对象存储上，需要用户上传。 示例值：COS_UPLOAD |
| MigrationName | 是 | String | 任务名称 示例值：字符串 |
| BackupFiles.N | 否 | Array of String | UploadType是COS_URL时这里填URL，COS_UPLOAD这里填备份文件的名字。只支持1个备份文件，但1个备份文件内可包含多个库 示例值：["db1.bak\n"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| BackupMigrationId | String | 备份导入任务ID 示例值：mssql-backup-migration-cg0ffgqt |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建备份文件导入任务
输入示例
https://sqlserver.tencentcloudapi.com/?Action=CreateBackupMigration
&InstanceId=mssql-rdc0gajn
&RecoveryType=FULL
&UploadType=COS_UPLOAD
&MigrationName=字符串
&BackupFiles.0=db1.bak
&<公共请求参数>输出示例
{
"Response": {
"BackupMigrationId": "mssql-backup-migration-cg0ffgqt",
"RequestId": "4e2f2093-9cde-44ec-b64b-edfcc2f911d4"
}
}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.DBError | 数据库错误。 |
| InternalError.SystemError | 系统错误。 |
| InvalidParameter.InputIllegal | 输入错误。 |
| InvalidParameter.ParamsAssertFailed | 参数断言转换错误。 |
| InvalidParameterValue.BackupNameIsIllegal | 备份名称存在非法字符。 |
| InvalidParameterValue.MigrationNameIsIllegal | 迁移名称包含非法字符。 |
| ResourceNotFound.InstanceNotFound | 实例不存在。 |
| UnauthorizedOperation.PermissionDenied | cam鉴权错误。 |