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

1. 接口描述

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

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

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
TotalCount Integer 任务数目
示例值:2
JobList Array of MigrateJobInfo 任务详情数组
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据迁移任务

输入示例

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

输出示例

{
    "Response": {
        "TotalCount": 1,
        "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
                },
                "Tags": [
                    {
                        "TagKey": "负责人",
                        "TagValue": "alice"
                    }
                ],
                "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",
                "ErrorInfo": []
            }
        ],
        "RequestId": "c032aab5-b56a-428d-9cf7-e5f324ee408b"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.AuthFailureError 认证失败。
AuthFailure.UnauthorizedOperationError 鉴权失败,当前用户不允许执行该操作。
FailedOperation.NotAllowOperation 禁止该操作。
InternalError.DatabaseError 迁移平台数据库访问失败。
InternalError.InternalErrorError 内部错误。
InternalError.ProtocolError 通信协议错误。
InternalError.UndefinedError 内部错误。
InternalError.UnknownError 未知的内部错误。
InvalidParameter 参数错误。
InvalidParameter.InvalidParameterError 参数无效。
InvalidParameterValue.BizInvalidParameterValueError 业务参数错误。
InvalidParameterValue.DataConvertError 数据转换错误。
InvalidParameterValue.InvalidParameterValueError 非法参数。
RequestLimitExceeded.RequestLimitExceededError 请求次数超限。
UnauthorizedOperation.NotEnoughPrivileges 认证失败,没有足够权限。