接口请求域名： dts.intl.tencentcloudapi.com 。
查询数据迁移任务.
如果是金融区链路, 请使用域名: https://dts.ap-shenzhen-fsi.tencentcloudapi.com
默认接口请求频率限制：100次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| 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] |
| TagFilters.N | 否 | Array of TagFilter | 标签过滤条件 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 任务数目 |
| JobList | Array of MigrateJobInfo | 任务详情数组 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
https://dts.intl.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": "",
"CcnId": "",
"EngineVersion": "",
"Supplier": ""
},
"DstAccessType": "cdb",
"DstDatabaseType": "mysql",
"DstInfo": {
"InstanceId": "cdb-l78e0nbv",
"Ip": "",
"Port": 0,
"Region": "ap-shanghai",
"ReadOnly": 0,
"User": "",
"Password": ""
},
"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": [],
"SrcInfoMulti": []
}
],
"RequestId": "c032aab5-b56a-428d-9cf7-e5f324ee408b"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| 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 | 认证失败，没有足够权限。 |
文档反馈