接口请求域名： dts.intl.tencentcloudapi.com 。
查询数据迁移任务列表
默认接口请求频率限制：100次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeMigrationJobs。 |
| Version | 是 | String | 公共参数，本接口取值：2021-12-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| JobId | 否 | String | 数据迁移任务ID，如：dts-amm1jw5q |
| JobName | 否 | String | 数据迁移任务名称 |
| Status.N | 否 | Array of String | 数据迁移任务状态，可取值包括：created(创建完成)、checking(校验中)、checkPass(校验通过)、checkNotPass(校验不通过)、readyRun(准备运行)、running(任务运行中)、readyComplete(准备完成)、success(任务成功)、failed(任务失败)、stopping(中止中)、completing(完成中) |
| SrcInstanceId | 否 | String | 源实例ID，格式如：cdb-c1nl9rpv |
| SrcRegion | 否 | String | 源实例地域，如：ap-guangzhou |
| SrcDatabaseType.N | 否 | Array of String | 源实例数据库类型，如：sqlserver,mysql,mongodb,redis,tendis,keewidb,clickhouse,cynosdbmysql,percona,tdsqlpercona,mariadb,tdsqlmysql,postgresql |
| SrcAccessType.N | 否 | Array of String | 源实例接入类型，值包括：extranet(外网)、vpncloud(云vpn接入的实例)、dcg(专线接入的实例)、ccn(云联网接入的实例)、cdb(云上cdb实例)、cvm(cvm自建实例) |
| DstInstanceId | 否 | String | 目标实例ID，格式如：cdb-c1nl9rpv |
| DstRegion | 否 | String | 目标实例地域，如：ap-guangzhou |
| DstDatabaseType.N | 否 | Array of String | 目标源实例数据库类型，如：sqlserver,mysql,mongodb,redis,tendis,keewidb,clickhouse,cynosdbmysql,percona,tdsqlpercona,mariadb,tdsqlmysql,postgresql |
| DstAccessType.N | 否 | Array of String | 目标实例接入类型，值包括：extranet(外网)、vpncloud(云vpn接入的实例)、dcg(专线接入的实例)、ccn(云联网接入的实例)、cdb(云上cdb实例)、cvm(cvm自建实例) |
| RunMode | 否 | String | 任务运行模式，值包括：immediate(立即运行)，timed(定时运行) |
| OrderSeq | 否 | String | 排序方式，可能取值为asc、desc，默认按照创建时间倒序 |
| Limit | 否 | Integer | 返回实例数量，默认20，有效区间[1,100] |
| Offset | 否 | Integer | 偏移量，默认为0 |
| TagFilters.N | 否 | Array of TagFilter | 标签过滤 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 迁移任务数量 |
| JobList | Array of JobItem | 迁移任务列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMigrationJobs
<公共请求参数>
{
"JobId": "dts-amm1jw5q"
}
{
"Response": {
"JobList": [
{
"Action": {
"AllAction": [
"view",
"modify",
"check",
"start",
"configure",
"stop",
"complete",
"resume",
"createCmpTask",
"isolate",
"offline",
"resize",
"recover"
],
"AllowedAction": [
"view",
"stop",
"complete",
"createCmpTask",
"view",
"isolate",
"resize"
]
},
"CompareTask": {
"CompareTaskId": "dts-amm1jw5q-cmp-bmuum7jk",
"Status": "consistent"
},
"CreateTime": "2022-07-11 16:20:49",
"BriefMsg": "",
"DumperResumeCtrl": "yes",
"AutoRetryTimeRangeMinutes": 5,
"StepInfo": {
"MasterSlaveDistance": 0,
"SecondsBehindMaster": 0,
"StepAll": 3,
"StepInfo": [
{
"Errors": [],
"StartTime": "2022-07-11 17:21:59",
"Status": "finished",
"StepId": "dumper",
"StepName": "源库导出",
"StepNo": 1,
"Percent": 100,
"StepMessage": "",
"Warnings": []
},
{
"Errors": [],
"StartTime": "2022-07-11 17:22:43",
"Status": "finished",
"StepId": "loader",
"StepName": "数据导入",
"StepNo": 2,
"Percent": 100,
"StepMessage": "",
"Warnings": []
},
{
"Errors": [],
"StartTime": "2022-07-11 17:23:26",
"Status": "running",
"StepId": "sinker",
"StepName": "同步增量",
"Percent": 0,
"StepMessage": "",
"StepNo": 3,
"Warnings": []
}
],
"StepNow": 3
},
"DstInfo": {
"AccessType": "cdb",
"DatabaseType": "mysql",
"ExtraAttr": [],
"Info": [
{
"Account": "",
"AccountMode": "",
"AccountRole": "",
"CcnGwId": "",
"CvmInstanceId": "",
"DbKernel": "",
"EngineVersion": "",
"Host": "",
"InstanceId": "cdb-o7uph0cj",
"Password": "xxxxxxxx",
"Port": 0,
"EncryptConn": "Encrypted",
"Role": "",
"SubnetId": "",
"TmpSecretId": "",
"TmpSecretKey": "",
"TmpToken": "",
"UniqDcgId": "",
"UniqVpnGwId": "",
"User": "root",
"VpcId": ""
}
],
"NodeType": "simple",
"Region": "ap-guangzhou",
"Supplier": ""
},
"EndTime": "0000-00-00 00:00:00",
"ExpectRunTime": "",
"JobId": "dts-amm1jw5q",
"JobName": "test_config_api",
"RunMode": "immediate",
"SrcInfo": {
"AccessType": "intranet",
"DatabaseType": "mysql",
"ExtraAttr": [],
"Info": [
{
"Account": "",
"AccountMode": "",
"AccountRole": "",
"CcnGwId": "",
"CvmInstanceId": "",
"DbKernel": "",
"EngineVersion": "5.7",
"Host": "9.123.210.37",
"InstanceId": "",
"Password": "xxxxxxxx",
"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",
"Tags": [],
"TradeInfo": {
"BillingType": "billing",
"DealName": "20220711715001047929481",
"ExpireTime": "0000-00-00 00:00:00",
"OfflineTime": "0000-00-00 00:00:00",
"IsolateTime": "0000-00-00 00:00:00",
"InstanceClass": "xlarge",
"IsolateReason": "",
"LastDealName": "",
"OfflineReason": "",
"PayType": "postpay",
"TradeStatus": "normal"
},
"UpdateTime": "2022-07-11 17:26:40"
}
],
"RequestId": "asdfadfasdfasdf",
"TotalCount": 1
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.AuthFailureError | 认证失败。 |
| DryRunOperation.DryRunOperationError | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation.FailedOperationError | 操作失败。 |
| InternalError.InternalErrorError | 内部错误。 |
| InvalidParameter.ControllerNotFoundError | 异常错误导致当前接口未注册。 |
| InvalidParameter.InvalidParameterError | 参数无效。 |
| InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
| LimitExceeded.LimitExceededError | 数量超出限制。 |
| MissingParameter.MissingParameterError | 参数丢失。 |
| RequestLimitExceeded.RequestLimitExceededError | 请求次数超限。 |
| ResourceInUse.ResourceInUseError | 资源在使用中。 |
| ResourceInsufficient.ResourceInsufficientError | 资源短缺。 |
| ResourceNotFound.BizResourceNotFoundError | 未找到资源。 |
| ResourceNotFound.ResourceNotFoundError | 资源未找到。 |
| ResourceUnavailable.ResourceUnavailableError | 资源不可用。 |
| ResourcesSoldOut.ResourcesSoldOutError | 资源售罄。 |
| UnauthorizedOperation.UnauthorizedOperationError | 未授权的操作。 |
| UnknownParameter.UnknownParameterError | 未知参数。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.UnsupportedOperationError | 不支持的操作。 |
文档反馈