Last updated: 2021-09-15 10:25:40

1. API Description

Domain name for API request:

This API is used to query data migration tasks.
For a finance zone linkage, please use the domain name

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:

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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
TagFilters.N No Array of TagFilter Tag filter.

3. Output Parameters

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.

4. Example

Example1 Querying data migration tasks

Input Example
&<Common request parameters>

Output Example

  "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": "",
          "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": "Owner",
            "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. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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 A parameter error occurred.
UnauthorizedOperation.NotEnoughPrivileges Verification failed. Insufficient permissions.