有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(DescribeMigrationDetail)用于查询迁移任务的详细情况

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMigrationDetail。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
MigrateId Integer 迁移任务ID
示例值:2728

3. 输出参数

参数名称 类型 描述
MigrateId Integer 迁移任务ID
示例值:2728
MigrateName String 迁移任务名称
示例值:测试接口
AppId Integer 迁移任务所属的用户ID
示例值:1254065710
Region String 迁移任务所属的地域
示例值:ap-guangzhou
SourceType Integer 迁移源的类型 1:TencentDB for SQLServer 2:云服务器自建SQLServer数据库 4:SQLServer备份还原 5:SQLServer备份还原(COS方式)
示例值:5
CreateTime Timestamp 迁移任务的创建时间
示例值:2018-08-06 17:44:58
StartTime Timestamp 迁移任务的开始时间
示例值:0000-00- 00 00:00:00
EndTime Timestamp 迁移任务的结束时间
示例值:0000-00-00 00:00:00
Status Integer 迁移任务的状态(1:初始化,4:迁移中,5.迁移失败,6.迁移成功)
示例值:1
Progress Integer 迁移任务当前进度
示例值:0
MigrateType Integer 迁移类型(1:结构迁移 2:数据迁移 3:增量同步)
示例值:2
Source MigrateSource 迁移源
Target MigrateTarget 迁移目标
MigrateDBSet Array of MigrateDB 迁移DB对象 ,离线迁移(SourceType=4或SourceType=5)不使用。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询迁移任务详情

输入示例

https://sqlserver.tencentcloudapi.com/?Action=DescribeMigrationDetail
&MigrateId=2728
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
        "MigrateId": 2728,
        "MigrateName": "测试接口",
        "AppId": 1254065710,
        "Region": "ap-guangzhou",
        "SourceType": 5,
        "CreateTime": "2018-08-06 17:44:58",
        "StartTime": "2020-09-22 00:00:00",
        "EndTime": "2020-09-22 00:00:00",
        "Status": 1,
        "Progress": 0,
        "MigrateType": 2,
        "Source": {
            "InstanceId": "",
            "CvmId": "",
            "VpcId": "",
            "SubnetId": "",
            "UserName": "",
            "Password": "",
            "Ip": "",
            "Port": 0,
            "Url": [
                "http://gz-oncvm-1254065710.cosgz.myqcloud.com/test4_20180724021516.bak",
                "http://gz-oncvm-1254065710.cosgz.myqcloud.com/testdb.bak"
            ],
            "UrlPassword": ""
        },
        "Target": {
            "InstanceId": "mssql-dr5843bdy",
            "UserName": "",
            "Password": ""
        },
        "MigrateDBSet": []
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DBError 数据库错误。
InternalError 内部错误。
InternalError.DBError 数据库错误。
InternalError.SystemError 系统错误。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InputIllegal 输入错误。
InvalidParameter.ParamsAssertFailed 参数断言转换错误。
UnauthorizedOperation.PermissionDenied cam鉴权错误。