云数据库 SQL Server 创建迁移任务-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口（CreateMigration）作用是创建一个迁移任务

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateMigration。
Version	是	String	公共参数，本接口取值：2018-03-28。
Region	是	String	公共参数，详见产品支持的地域列表。
MigrateName	是	String	迁移任务的名称示例值：测试接口
MigrateType	是	Integer	迁移类型（1:结构迁移 2:数据迁移 3:增量同步）示例值：2
SourceType	是	Integer	迁移源的类型 1:TencentDB for SQLServer 2:云服务器自建SQLServer数据库 4:SQLServer备份还原 5:SQLServer备份还原（COS方式）示例值：5
Source	是	MigrateSource	迁移源
Target	是	MigrateTarget	迁移目标
MigrateDBSet.N	否	Array of MigrateDB	迁移DB对象，离线迁移不使用（SourceType=4或SourceType=5）。
RenameRestore.N	否	Array of RenameRestoreDatabase	按照ReNameRestoreDatabase中的库进行恢复，并重命名，不填则按照默认方式命名恢复的库，且恢复所有的库。SourceType=5的情况下有效。

3. 输出参数

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

4. 示例

示例1 创建迁移任务

输入示例

https://sqlserver.tencentcloudapi.com/?Action=CreateMigration
&MigrateName=测试接口
&MigrateType=2
&SourceType=5
&Source.Url.0=http://gz-oncvm-1254065710.cosgz.myqcloud.com/testdb.bak
&Target.InstanceId=mssql-si2823jyl
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
        "MigrateId": 2728
    }
}

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	数据库错误。
FailedOperation.GcsError	操作失败或者网络超时。
InternalError	内部错误。
InternalError.CreateFlowFailed	流程创建失败。
InternalError.DBConnectError	数据库连接错误。
InternalError.SystemError	系统错误。
InternalError.UnknownError	未知错误。
InvalidParameter	参数错误。
InvalidParameter.InputIllegal	输入错误。
InvalidParameter.ParamsAssertFailed	参数断言转换错误。
InvalidParameterValue.DBCharIllegal	数据库名称包含非法字符。
InvalidParameterValue.DBExist	数据库已经存在。
InvalidParameterValue.MigrationNameIsIllegal	迁移名称包含非法字符。
InvalidParameterValue.OnCvmTypeNotSupported	是CVM类型。
ResourceNotFound.InstanceNotFound	实例不存在。
ResourceUnavailable.InstanceMigrateRegionIllegal	实例迁移地域非法。
ResourceUnavailable.InstanceMigrateStatusInvalid	实例迁移状态无效。
ResourceUnavailable.InstanceStatusInvalid	实例状态无效。
UnauthorizedOperation.PermissionDenied	cam鉴权错误。

创建迁移任务

本页目录：