查询数据迁移任务

最近更新时间:2019-03-14 20:22:29

1. 接口描述

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

查询数据迁移任务. 如果是金融区链路, 请使用域名: https://dts.ap-shenzhen-fsi.tencentcloudapi.com

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:dts.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMigrateJobs
Version String 公共参数,本接口取值:2018-03-30
Region String 公共参数,详见产品支持的地域列表
JobId String 数据迁移任务ID
JobName String 数据迁移任务名称
Order String 排序字段,可以取值为JobId、Status、JobName、MigrateType、RunMode、CreateTime
OrderSeq String 排序方式,升序为ASC,降序为DESC
Offset Integer 偏移量,默认为0
Limit Integer 返回实例数量,默认20,有效区间[1,100]

3. 输出参数

参数名称 类型 描述
TotalCount Integer 任务数目
JobList Array of MigrateJobInfo 任务详情数组
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据迁移任务

输入示例

https://dts.tencentcloudapi.com/?Action=DescribeMigrateJobs
&Order=CreateTime
&OrderSeq=DESC
&Offset=0
&Limit=2
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 2,
        "JobList": [
            {
                "JobId": "dts-1kl0iy0v",
                "JobName": "userdts",
                "MigrateOption": {
                    "RunMode": 1,
                    "ExpectTime": "0000-00-00 00:00:00",
                    "MigrateType": 2,
                    "MigrateObject": 2,
                    "ConsistencyType": 5,
                    "IsOverrideRoot": 0,
                    "ExternParams": "[]",
                    "ConsistencyParams": {
                        "SelectRowsPerTable": 0,
                        "TablesSelectAll": 0,
                        "TablesSelectCount": 0
                    }
                },
                "SrcAccessType": "extranet",
                "SrcDatabaseType": "mysql",
                "SrcInfo": {
                    "AccessKey": "",
                    "Ip": "9.18.84.24",
                    "Port": 10304,
                    "User": "root",
                    "Password": "",
                    "RdsInstanceId": "",
                    "CvmInstanceId": "",
                    "UniqDcgId": "",
                    "SubnetId": "",
                    "UniqVpnGwId": "",
                    "InstanceId": "",
                    "Region": "ap-guangzhou",
                    "VpcId": ""
                },
                "DstAccessType": "cdb",
                "DstDatabaseType": "mysql",
                "DstInfo": {
                    "InstanceId": "cdb-l78e0nbv",
                    "Ip": "",
                    "Port": 0,
                    "Region": "ap-shanghai",
                    "ReadOnly": 0
                },
                "Detail": {
                    "StepAll": 0,
                    "StepNow": 0,
                    "Progress": "0",
                    "CurrentStepProgress": "0",
                    "MasterSlaveDistance": 0,
                    "SecondsBehindMaster": 0,
                    "StepInfo": []
                },
                "Status": 1,
                "DatabaseInfo": [],
                "CreateTime": "2018-05-24 15:06:03",
                "StartTime": "0000-00-00 00:00:00",
                "EndTime": "0000-00-00 00:00:00"
            },
            {
                "JobId": "dts-dau5czmd",
                "JobName": "apitest",
                "MigrateOption": {
                    "RunMode": 1,
                    "ExpectTime": "",
                    "MigrateType": 2,
                    "MigrateObject": 2,
                    "ConsistencyType": 5,
                    "IsOverrideRoot": 0,
                    "ExternParams": "[]",
                    "ConsistencyParams": {
                        "SelectRowsPerTable": 0,
                        "TablesSelectAll": 0,
                        "TablesSelectCount": 0
                    }
                },
                "SrcAccessType": "extranet",
                "SrcDatabaseType": "mysql",
                "SrcInfo": {
                    "AccessKey": "",
                    "Ip": "9.18.81.3",
                    "Port": 11401,
                    "User": "root",
                    "Password": "",
                    "RdsInstanceId": "",
                    "CvmInstanceId": "",
                    "UniqDcgId": "",
                    "SubnetId": "",
                    "UniqVpnGwId": "",
                    "InstanceId": "",
                    "Region": "ap-guangzhou",
                    "VpcId": ""
                },
                "DstAccessType": "cdb",
                "DstDatabaseType": "mysql",
                "DstInfo": {
                    "InstanceId": "cdb-m78e0nnv",
                    "Ip": "",
                    "Port": 0,
                    "Region": "ap-shanghai",
                    "ReadOnly": 0
                },
                "Detail": {
                    "StepAll": 0,
                    "StepNow": 0,
                    "Progress": "0",
                    "CurrentStepProgress": "",
                    "MasterSlaveDistance": 0,
                    "SecondsBehindMaster": 0,
                    "StepInfo": []
                },
                "Status": 5,
                "DatabaseInfo": [],
                "CreateTime": "2018-05-23 11:49:44",
                "StartTime": "0000-00-00 00:00:00",
                "EndTime": "0000-00-00 00:00:00"
            }
        ],
        "RequestId": "c032aab5-b56a-428d-9cf7-e5f324ee408b"
    }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.NotAllowOperation 禁止该操作。
InternalError.DatabaseError 迁移平台数据库访问失败。
InternalError.ProtocolError 通信协议错误。
InvalidParameter 参数错误