数据传输服务查询某个迁移任务详情

1. 接口描述

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

查询某个迁移任务详情

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeMigrationDetail。
Version	是	String	公共参数，本接口取值：2021-12-06。
Region	是	String	公共参数，详见产品支持的地域列表。
JobId	是	String	数据迁移任务ID 示例值：dts-amm1jw5q

3. 输出参数

参数名称	类型	描述
JobId	String	数据迁移任务ID 示例值：dts-amm1jw5q
JobName	String	数据迁移任务名称示例值：dts-amm1jw5q
CreateTime	String	任务创建(提交)时间，格式为 yyyy-mm-dd hh:mm:ss 示例值：2022-07-11 16:20:49
UpdateTime	String	任务更新时间，格式为 yyyy-mm-dd hh:mm:ss 示例值：2022-07-11 16:20:49
StartTime	String	任务开始执行时间，格式为 yyyy-mm-dd hh:mm:ss 示例值：2022-07-11 16:20:49
EndTime	String	任务执行结束时间，格式为 yyyy-mm-dd hh:mm:ss 示例值：2022-07-11 16:20:49
BriefMsg	String	迁移任务简要错误信息示例值：dial tcp : i/o timeout
Status	String	任务状态，取值为：created(创建完成)、checking(校验中)、checkPass(校验通过)、checkNotPass(校验不通过)、readyRun(准备运行)、running(任务运行中)、readyComplete(准备完成)、success(任务成功)、failed(任务失败)、stopping(中止中)、completing(完成中)、 pausing(暂停中)、 manualPaused(已暂停) 示例值：running
Action	MigrateAction	任务操作信息
StepInfo	MigrateDetailInfo	迁移执行过程信息，在校验阶段显示校验过程步骤信息，在迁移阶段会显示迁移步骤信息
SrcInfo	DBEndpointInfo	源实例信息
DstInfo	DBEndpointInfo	目标端信息
CompareTask	CompareTaskInfo	数据一致性校验结果
Tags	Array of TagItem	标签信息
RunMode	String	运行模式，取值如：immediate(表示立即运行)、timed(表示定时运行) 示例值：immediate
ExpectRunTime	String	期待启动时间，当RunMode取值为timed时，此值必填，形如："2006-01-02 15:04:05" 示例值：2022-07-11 16:20:49
MigrateOption	MigrateOption	迁移选项，描述任务如何执行迁移等一系列配置信息
CheckStepInfo	CheckStepInfo	校验任务运行详情
TradeInfo	TradeInfo	描述计费相关的信息
ErrorInfo	Array of ErrorInfoItem	任务错误信息
DumperResumeCtrl	String	全量导出可重入标识：enum::"yes"/"no"。yes表示当前任务可重入、no表示当前任务处于全量导出且不可重入阶段；如果在该值为no时重启任务导出流程不支持断点续传示例值：yes
RateLimitOption	RateLimitOption	任务的限速信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询某个迁移任务详情

查询某个迁移任务详情

输入示例

POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMigrationDetail
<公共请求参数>

{
    "JobId": "dts-amm1jw5q"
}

输出示例

{
    "Response": {
        "Action": {
            "AllAction": [
                "view",
                "modify",
                "check",
                "start",
                "configure",
                "stop",
                "complete",
                "resume",
                "createCmpTask",
                "isolate",
                "offline",
                "resize",
                "recover"
            ],
            "AllowedAction": [
                "view",
                "stop",
                "complete",
                "createCmpTask",
                "view",
                "isolate",
                "resize"
            ]
        },
        "CheckStepInfo": {
            "EndAt": "2022-07-11 17:19:25",
            "Progress": {
                "Message": "success",
                "Percent": 100,
                "Status": "success",
                "StepAll": 12,
                "Steps": [
                    {
                        "Errors": [],
                        "Percent": 100,
                        "StartTime": "",
                        "Status": "finished",
                        "StepId": "ConnectDBCheck",
                        "StepMessage": "",
                        "StepName": "连接DB检查",
                        "StepNo": 0,
                        "Warnings": []
                    },
                    {
                        "Errors": [],
                        "Percent": 100,
                        "StartTime": "",
                        "Status": "finished",
                        "StepId": "VersionCheck",
                        "StepMessage": "",
                        "StepName": "版本检查",
                        "StepNo": 0,
                        "Warnings": []
                    },
                    {
                        "Errors": [],
                        "Percent": 100,
                        "StartTime": "",
                        "Status": "finished",
                        "StepId": "SrcPrivilegeCheck",
                        "StepMessage": "",
                        "StepName": "源实例权限检查",
                        "StepNo": 0,
                        "Warnings": [
                            {
                                "HelpDoc": "",
                                "Message": "您的授权情况：GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, RELOAD, PROCESS, REFERENCES, INDEX, ALTER, SHOW DATABASES, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, REPLICATION SLAVE, REPLICATION CLIENT, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, CREATE USER, EVENT, TRIGGER, CREATE TABLESPACE ON *.* TO 'root'@'%' WITH GRANT OPTION。 源端账号权限范围大于要求的账号权限范围，腾讯云DTS不会使用超过必要的权限，请按照最小化原则给与授权: https://cloud.tencent.com/document/product/571/58700",
                                "Solution": ""
                            }
                        ]
                    },
                    {
                        "Errors": [],
                        "Percent": 100,
                        "StartTime": "",
                        "Status": "finished",
                        "StepId": "SimpleParamCheck",
                        "StepMessage": "",
                        "StepName": "部分实例参数检查",
                        "StepNo": 0,
                        "Warnings": []
                    },
                    {
                        "Errors": [],
                        "Percent": 100,
                        "StartTime": "",
                        "Status": "finished",
                        "StepId": "DstPrivilegeCheck",
                        "StepMessage": "",
                        "StepName": "目标实例权限检查",
                        "StepNo": 0,
                        "Warnings": []
                    },
                    {
                        "Errors": [],
                        "Percent": 100,
                        "StartTime": "",
                        "Status": "finished",
                        "StepId": "DstEmptyCheck",
                        "StepMessage": "",
                        "StepName": "目标实例内容冲突检查",
                        "StepNo": 0,
                        "Warnings": []
                    },
                    {
                        "Errors": [],
                        "Percent": 100,
                        "StartTime": "",
                        "Status": "finished",
                        "StepId": "DstSpaceCheck",
                        "StepMessage": "",
                        "StepName": "目标实例空间检查",
                        "StepNo": 0,
                        "Warnings": []
                    },
                    {
                        "Errors": [],
                        "Percent": 100,
                        "StartTime": "",
                        "Status": "finished",
                        "StepId": "BinlogParamCheck",
                        "StepMessage": "",
                        "StepName": "binlog参数检查",
                        "StepNo": 0,
                        "Warnings": []
                    },
                    {
                        "Errors": [],
                        "Percent": 100,
                        "StartTime": "",
                        "Status": "finished",
                        "StepId": "ConstraintCheck",
                        "StepMessage": "",
                        "StepName": "外键依赖检查",
                        "StepNo": 0,
                        "Warnings": []
                    },
                    {
                        "Errors": [],
                        "Percent": 100,
                        "StartTime": "",
                        "Status": "finished",
                        "StepId": "ConstraintRefCheck",
                        "StepMessage": "",
                        "StepName": "外键部分库表依赖检查",
                        "StepNo": 0,
                        "Warnings": []
                    },
                    {
                        "Errors": [],
                        "Percent": 100,
                        "StartTime": "",
                        "Status": "finished",
                        "StepId": "ViewCheck",
                        "StepMessage": "",
                        "StepName": "视图检查",
                        "StepNo": 0,
                        "Warnings": []
                    },
                    {
                        "Errors": [],
                        "Percent": 100,
                        "StartTime": "",
                        "Status": "finished",
                        "StepId": "WarningParamCheck",
                        "StepMessage": "",
                        "StepName": "警告项检查",
                        "StepNo": 0,
                        "Warnings": []
                    },
                    {
                        "Errors": [],
                        "Percent": 0,
                        "StartTime": "",
                        "Status": "skipped",
                        "StepId": "OptimizeCheck",
                        "StepMessage": "",
                        "StepName": "周边检查",
                        "StepNo": 0,
                        "Warnings": [
                            {
                                "HelpDoc": "",
                                "Message": "skipped",
                                "Solution": ""
                            }
                        ]
                    }
                ],
                "StepNow": 12
            },
            "StartAt": "2022-07-11 17:18:57"
        },
        "CompareTask": {
            "CompareTaskId": "dts-amm1jw5q-cmp-bmuum7jk",
            "Status": "consistent"
        },
        "CreateTime": "2022-07-11 16:20:49",
        "DstInfo": {
            "AccessType": "cdb",
            "DatabaseType": "mysql",
            "ExtraAttr": [],
            "Info": [
                {
                    "Account": "",
                    "AccountMode": "",
                    "AccountRole": "",
                    "CcnGwId": "",
                    "CvmInstanceId": "",
                    "DbKernel": "",
                    "EngineVersion": "",
                    "Host": "",
                    "InstanceId": "cdb-o7uph0cj",
                    "Password": "Abc_123456789",
                    "Port": 0,
                    "Role": "",
                    "SubnetId": "",
                    "TmpSecretId": "",
                    "TmpSecretKey": "",
                    "TmpToken": "",
                    "UniqDcgId": "",
                    "UniqVpnGwId": "",
                    "User": "root",
                    "VpcId": ""
                }
            ],
            "NodeType": "simple",
            "Region": "ap-guangzhou",
            "Supplier": ""
        },
        "EndTime": "0000-00-00 00:00:00",
        "ErrorInfo": [],
        "ExpectRunTime": "2022-07-11 17:16:50",
        "JobId": "dts-amm1jw5q",
        "JobName": "test_config_api",
        "BriefMsg": "",
        "MigrateOption": {
            "Consistency": {
                "Mode": "full"
            },
            "DatabaseTable": {
                "Databases": [
                    {
                        "DBMode": "partial",
                        "DbName": "big100",
                        "EventMode": "",
                        "FunctionMode": "",
                        "NewDbName": "",
                        "NewSchemaName": "",
                        "ProcedureMode": "",
                        "RoleMode": "",
                        "Roles": [],
                        "SchemaMode": "",
                        "SchemaName": "",
                        "TableMode": "partial",
                        "Tables": [
                            {
                                "NewTableName": "",
                                "TableEditMode": "",
                                "TableName": "sbtest1",
                                "TmpTables": []
                            },
                            {
                                "NewTableName": "new_sbtest10",
                                "TableEditMode": "rename",
                                "TableName": "sbtest10",
                                "TmpTables": []
                            },
                            {
                                "NewTableName": "",
                                "TableEditMode": "",
                                "TableName": "sbtest100",
                                "TmpTables": []
                            }
                        ],
                        "TriggerMode": "",
                        "ViewMode": "none",
                        "Views": []
                    },
                    {
                        "DBMode": "all",
                        "DbName": "db1",
                        "EventMode": "",
                        "FunctionMode": "",
                        "NewDbName": "",
                        "NewSchemaName": "",
                        "ProcedureMode": "",
                        "RoleMode": "",
                        "Roles": [],
                        "SchemaMode": "",
                        "SchemaName": "",
                        "TableMode": "",
                        "Tables": [],
                        "TriggerMode": "",
                        "ViewMode": "",
                        "Views": []
                    }
                ],
                "AdvancedObjects": [
                    "function"
                ],
                "ObjectMode": "partial"
            },
            "ExtraAttr": [],
            "IsMigrateAccount": false,
            "IsDstReadOnly": false,
            "IsOverrideRoot": false,
            "MigrateType": "fullAndIncrement"
        },
        "RequestId": "ac300ff0-00f2-11ed-b005-4930e69d89c2",
        "RunMode": "immediate",
        "SrcInfo": {
            "AccessType": "intranet",
            "DatabaseType": "mysql",
            "ExtraAttr": [],
            "Info": [
                {
                    "Account": "",
                    "AccountMode": "",
                    "AccountRole": "",
                    "CcnGwId": "",
                    "CvmInstanceId": "",
                    "DbKernel": "",
                    "EngineVersion": "5.7",
                    "Host": "9.123.456.789",
                    "InstanceId": "",
                    "Password": "Abc_123456789",
                    "Port": 31035,
                    "Role": "",
                    "SubnetId": "",
                    "TmpSecretId": "",
                    "TmpSecretKey": "",
                    "TmpToken": "",
                    "UniqDcgId": "",
                    "UniqVpnGwId": "",
                    "User": "root",
                    "VpcId": ""
                }
            ],
            "NodeType": "simple",
            "Region": "ap-guangzhou",
            "Supplier": ""
        },
        "StartTime": "2022-07-11 17:20:56",
        "Status": "readyComplete",
        "StepInfo": {
            "MasterSlaveDistance": 0,
            "SecondsBehindMaster": 0,
            "StepAll": 3,
            "StepInfo": [
                {
                    "StepMessage": "",
                    "Percent": 100,
                    "Errors": [],
                    "StartTime": "2022-07-11 17:21:59",
                    "Status": "finished",
                    "StepId": "dumper",
                    "StepName": "源库导出",
                    "StepNo": 1,
                    "Warnings": []
                },
                {
                    "StepMessage": "",
                    "Percent": 100,
                    "Errors": [],
                    "StartTime": "2022-07-11 17:22:43",
                    "Status": "finished",
                    "StepId": "loader",
                    "StepName": "数据导入",
                    "StepNo": 2,
                    "Warnings": []
                },
                {
                    "StepMessage": "",
                    "Percent": 100,
                    "Errors": [],
                    "StartTime": "2022-07-11 17:23:26",
                    "Status": "running",
                    "StepId": "sinker",
                    "StepName": "同步增量",
                    "StepNo": 3,
                    "Warnings": []
                }
            ],
            "StepNow": 3
        },
        "Tags": [],
        "TradeInfo": {
            "BillingType": "billing",
            "DealName": "20220711715001047929481",
            "ExpireTime": "0000-00-00 00:00:00",
            "InstanceClass": "xlarge",
            "IsolateReason": "",
            "LastDealName": "",
            "OfflineReason": "",
            "PayType": "postpay",
            "TradeStatus": "normal",
            "OfflineTime": "",
            "IsolateTime": ""
        },
        "UpdateTime": "2022-07-11 19:53:03",
        "DumperResumeCtrl": "no"
    }
}

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. 错误码

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

错误码	描述
AuthFailure.AuthFailureError	认证失败。
DryRunOperation.DryRunOperationError	DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation.FailedOperationError	操作失败。
InternalError.InternalErrorError	内部错误。
InvalidParameter.ControllerNotFoundError	异常错误导致当前接口未注册。
InvalidParameter.InvalidParameterError	参数无效。
InvalidParameterValue.InvalidParameterValueError	非法参数。
LimitExceeded.LimitExceededError	数量超出限制。
MissingParameter.MissingParameterError	参数丢失。
OperationDenied.OperationDeniedError	操作被拒绝。
RequestLimitExceeded.RequestLimitExceededError	请求次数超限。
ResourceInUse.ResourceInUseError	资源在使用中。
ResourceInsufficient.ResourceInsufficientError	资源短缺。
ResourceNotFound.ResourceNotFoundError	资源未找到。
ResourceUnavailable.ResourceUnavailableError	资源不可用。
ResourcesSoldOut.ResourcesSoldOutError	资源售罄。
UnauthorizedOperation.UnauthorizedOperationError	未授权的操作。
UnknownParameter.UnknownParameterError	未知参数。
UnsupportedOperation.UnsupportedOperationError	不支持的操作。

近期搜索热词

云服务器

云硬盘

容器服务

负载均衡

弹性伸缩

云函数

私有网络

批量计算

API 网关

专线接入

对象存储

微服务平台 TSF

文件存储

消息队列 CKafka 版

全站加速网络

日志服务

云数据库 MySQL

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

云数据库 Redis®

内容分发网络 CDN

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

数据传输服务

全球应用加速

腾讯云区块链服务平台 TBaaS

云拨测

访问管理

主机安全

标签

DDoS 防护

密钥管理系统

Web 应用防火墙

操作审计

域名注册

SSL 证书

数据万象

短信

NLP 技术

云点播

云市场

云加密机

云安全中心

云开发 CloudBase

文字识别

流计算 Oceanus

腾讯云数据仓库 TCHouse-P

人脸识别

Elasticsearch Service

集团账号管理

口语评测（基础版）

图像识别

媒体处理

云直播

云联络中心

机器翻译

物联网通信

人脸融合

游戏数据库 TcaplusDB

弹性 MapReduce

游戏多媒体引擎

腾讯云 BI

实时音视频

渠道合作伙伴

TI-ONE 训练平台

数据安全审计

分布式身份

数据加速器 GooseFS

腾讯云健康看板

统一 Catalog 服务

消息队列 RabbitMQ 版

声音复刻

文旅客情大数据

实时互动-工业能源版

腾讯健康组学平台

大模型图像创作引擎

云压测