Domain name for API request: dts.tencentcloudapi.com.
This API is used to query data migration tasks.
For a finance zone linkage, please use the domain name https://dts.ap-shenzhen-fsi.tencentcloudapi.com.
A maximum of 50 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dts.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeMigrateJobs. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-03-30. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| JobId | No | String | Data migration task ID |
| JobName | No | String | Data migration task name |
| Order | No | String | Sort by field. Value range: JobId, Status, JobName, MigrateType, RunMode, CreateTime |
| OrderSeq | No | String | Sorting order. Value range: ASC (ascending), DESC (descending) |
| Offset | No | Integer | Offset. Default value: 0 |
| Limit | No | Integer | Number of the returned instances. Value range: [1, 100]. Default value: 20 |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of tasks |
| JobList | Array of MigrateJobInfo | Array of task details |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://dts.tencentcloudapi.com/?Action=DescribeMigrateJobs
&Order=CreateTime
&OrderSeq=DESC
&Offset=0
&Limit=2
&<Common request parameter>{
"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"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.NotAllowOperation | This operation is prohibited. |
| InternalError.DatabaseError | Failed to access the database on the DTS platform. |
| InternalError.ProtocolError | Communication protocol error. |
| InvalidParameter | Invalid parameter. |
Was this page helpful?