Help Center/ Data Replication Service/ API Reference/ History API/ APIs V3.0/ Public API Management/ Querying Tasks of a Tenant
Updated on 2026-09-07 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Tasks of a Tenant

Function

This API is used to query tenant tasks by engine type, network type, task status, task name, or task ID.

Debugging

You can debug the API in API Explorer to support automatic authentication. API Explorer can automatically generate and debug example SDK code.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions and Supported Actions.

URI

POST /v3/{project_id}/jobs

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Auth-Token

Yes

String

Definition

User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us: English
  • zh-cn: Chinese

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

cur_page

No

Integer

Definition

Current page number. It is used to specify which page of data to be returned during pagination query. If you set this parameter to 0, all data items can be obtained.

Constraints

N/A

Range

N/A

Default Value

1

per_page

No

Integer

Definition

Number of records returned on each page. This parameter is used to control the number of records displayed on each page during pagination query.

Constraints

N/A

Range

0–1000

Default Value

10

db_use_type

Yes

String

Definition

Service scenario type of the migration task.

Constraints

N/A

Range

  • migration: real-time migration
  • sync: real-time synchronization
  • cloudDataGuard: real-time disaster recovery

Default Value

N/A

engine_type

No

String

Definition

Engine type of the DRS task.

Constraints

N/A

Range

  • mysql: migration and synchronization from MySQL to MySQL
  • mongodb: migration and synchronization from MongoDB to DDS
  • cloudDataGuard-mysql: DR from MySQL to MySQL
  • gaussdbv5: GaussDB synchronization
  • mysql-to-kafka: synchronization from MySQL to Kafka
  • taurus-to-kafka: synchronization from TaurusDB to Kafka
  • gaussdbv5ha-to-kafka: synchronization from GaussDB Centralized to Kafka
  • postgresql: synchronization from PostgreSQL to PostgreSQL
  • oracle-to-gaussdbv5: synchronization from Oracle to GaussDB Distributed
  • oracle-to-gaussdbv5ha: synchronization from Oracle to GaussDB Centralized
  • gaussdbv5-to-oracle: synchronization from GaussDB Distributed to Oracle
  • gaussdbv5ha-to-oracle: synchronization from GaussDB Centralized to Oracle
  • gaussdbv5-to-kafka: synchronization from GaussDB Distributed to Kafka

For details, see Engine Types.

Default Value

N/A

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter query results by enterprise project.

Constraints

  • If this parameter is not specified, it is set to null.
  • When enterprise project is enabled, this parameter can be set.

Range

N/A

Default Value

null

name

No

String

Definition

Task name or ID, which is used to filter query results by task name or ID. You can enter a maximum of 100 task IDs separated by commas (,).

Constraints

N/A

Range

N/A

Default Value

N/A

net_type

No

String

Definition

Type of the network used by the task.

Constraints

N/A

Range

  • vpn: Virtual Private Network
  • vpc: Virtual Private Cloud
  • eip: Elastic IP

Default Value

N/A

service_name

No

String

Definition

Service name, which is used when the Enterprise Project Management Service (EPS) is enabled.

Constraints

N/A

Range

  • eps

Default Value

N/A

status

No

String

Definition

Current status of the task, which is used to filter query results by task status.

Constraints

N/A

Range

  • CREATING: The task is being created.
  • CREATE_FAILED: The task fails to be created.
  • CONFIGURATION: The task is being configured.
  • STARTJOBING: The task is being started.
  • WAITING_FOR_START: The task is waiting to be started.
  • START_JOB_FAILED: The task fails to be started.
  • PAUSING: The task is paused.
  • FULL_TRANSFER_STARTED: Full migration or synchronization starts. Initialization is in progress in the DR scenario.
  • FULL_TRANSFER_FAILED: Full migration or synchronization fails. Initialization fails in the DR scenario.
  • FULL_TRANSFER_COMPLETE: Full migration or synchronization is complete. Initialization is complete in the DR scenario.
  • INCRE_TRANSFER_STARTED: Incremental migration or synchronization starts. The DR task is in progress.
  • INCRE_TRANSFER_FAILED: Incremental migration or synchronization fails. A DR exception occurs.
  • RELEASE_RESOURCE_STARTED: The task is being stopped.
  • RELEASE_RESOURCE_FAILED: The task fails to be stopped.
  • RELEASE_RESOURCE_COMPLETE: The task is stopped.
  • REBUILD_NODE_STARTED: The task is being recovered.
  • REBUILD_NODE_FAILED: The task fails to be recovered.
  • CHANGE_JOB_STARTED: The task is being changed.
  • CHANGE_JOB_FAILED: The task fails to be changed.
  • DELETED: The task is deleted.
  • CHILD_TRANSFER_STARTING: The subtask is being started.
  • CHILD_TRANSFER_STARTED: The subtask is being migrated.
  • CHILD_TRANSFER_COMPLETE: The subtask migration is complete.
  • CHILD_TRANSFER_FAILED: The subtask fails to be migrated.
  • RELEASE_CHILD_TRANSFER_STARTED: The subtask is being stopped.
  • RELEASE_CHILD_TRANSFER_COMPLETE: The subtask is stopped.
  • NODE_UPGRADE_START: The upgrade starts.
  • NODE_UPGRADE_COMPLETE: The upgrade is complete.
  • NODE_UPGRADE_FAILED: The upgrade fails.

Default Value

N/A

tags

No

Map<String,String>

Definition

Tag information, which is used to filter query results by tag. The value is a key-value pair.

For details, see Table 7.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_ids

No

Array of strings

Definition

DB instance ID list, which is used to filter query results by DB instance.

Constraints

A maximum of 10 instance IDs are supported.

Range

N/A

Default Value

null: DB instance IDs are not used for filtering.

instance_ip

No

String

Definition

IP address of the DB instance bound to DRS, which is used to filter query results by DB instance IP address.

Constraints

N/A

Range

N/A

Default Value

Empty string (""): indicates that the IP address of the DB instance bound to DRS is not used for filtering.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_record

Integer

Definition

Total number of tasks that meet the search criteria.

Constraints

N/A

Range

N/A

jobs

Array of objects

Definition

Task information list, which includes details about all tasks that meet the search criteria.

For details, see Table 5.
Table 5 Data structure description of field jobs

Parameter

Type

Description

id

String

Definition

Task ID, which uniquely identifies a data replication task.

Constraints

N/A

Range

N/A

name

String

Definition

Task name, which is used to identify and distinguish between different data replication tasks.

Constraints

N/A

Range

N/A

status

String

Definition

Task status.

Constraints

N/A

Range

  • CREATING: The task is being created.
  • CREATE_FAILED: The task fails to be created.
  • CONFIGURATION: The task is being configured.
  • STARTJOBING: The task is being started.
  • WAITING_FOR_START: The task is waiting to be started.
  • START_JOB_FAILED: The task fails to be started.
  • PAUSING: The task is paused.
  • FULL_TRANSFER_STARTED: Full migration or synchronization starts. Initialization is in progress in the DR scenario.
  • FULL_TRANSFER_FAILED: Full migration or synchronization fails. Initialization fails in the DR scenario.
  • FULL_TRANSFER_COMPLETE: Full migration or synchronization is complete. Initialization is complete in the DR scenario.
  • INCRE_TRANSFER_STARTED: Incremental migration or synchronization starts. The DR task is in progress.
  • INCRE_TRANSFER_FAILED: Incremental migration or synchronization fails. A DR exception occurs.
  • RELEASE_RESOURCE_STARTED: The task is being stopped.
  • RELEASE_RESOURCE_FAILED: The task fails to be stopped.
  • RELEASE_RESOURCE_COMPLETE: The task is stopped.
  • REBUILD_NODE_STARTED: The task is being recovered.
  • REBUILD_NODE_FAILED: The task fails to be recovered.
  • CHANGE_JOB_STARTED: The task is being changed.
  • CHANGE_JOB_FAILED: The task fails to be changed.
  • DELETED: The task is deleted.
  • CHILD_TRANSFER_STARTING: The subtask is being started.
  • CHILD_TRANSFER_STARTED: The subtask is being migrated.
  • CHILD_TRANSFER_COMPLETE: The subtask migration is complete.
  • CHILD_TRANSFER_FAILED: The subtask fails to be migrated.
  • RELEASE_CHILD_TRANSFER_STARTED: The subtask is being stopped.
  • RELEASE_CHILD_TRANSFER_COMPLETE: The subtask is stopped.
  • NODE_UPGRADE_START: The upgrade starts.
  • NODE_UPGRADE_COMPLETE: The upgrade is complete.
  • NODE_UPGRADE_FAILED: The upgrade fails.

description

String

Definition

Task description, which describes the task purpose or remarks.

Constraints

N/A

Range

N/A

create_time

String

Definition

Time when the task was created, which indicates the timestamp when the task was created for the first time.

Constraints

N/A

Range

N/A

engine_type

String

Definition

Engine type of the DRS task.

Constraints

N/A

Range

  • mysql: migration and synchronization from MySQL to MySQL
  • mongodb: migration and synchronization from MongoDB to DDS
  • cloudDataGuard-mysql: DR from MySQL to MySQL
  • gaussdbv5: GaussDB synchronization
  • mysql-to-kafka: synchronization from MySQL to Kafka
  • taurus-to-kafka: synchronization from TaurusDB to Kafka
  • gaussdbv5ha-to-kafka: synchronization from GaussDB Centralized to Kafka
  • postgresql: synchronization from PostgreSQL to PostgreSQL
  • oracle-to-gaussdbv5: synchronization from Oracle to GaussDB Distributed
  • oracle-to-gaussdbv5ha: synchronization from Oracle to GaussDB Centralized
  • gaussdbv5-to-oracle: synchronization from GaussDB Distributed to Oracle
  • gaussdbv5ha-to-oracle: synchronization from GaussDB Centralized to Oracle
  • gaussdbv5-to-kafka: synchronization from GaussDB Distributed to Kafka

For details, see Engine Types.

net_type

String

Definition

Type of the network used by the task.

Constraints

N/A

Range

  • vpn: Virtual Private Network
  • vpc: Virtual Private Cloud
  • eip: Elastic IP

billing_tag

Boolean

Definition

Billing mode tag of the task, which indicates whether the task is being billed.

Constraints

N/A

Range

  • true: being billed

  • false: not being billed

job_direction

String

Definition

Migration direction of the task.

Constraints

N/A

Range

  • up: to-the-cloud scenarios and DR scenarios where the current cloud is the standby
  • down: out-of-cloud scenarios and DR scenarios where the current cloud is the active
  • non-dbs: between self-built databases

db_use_type

String

Definition

Service scenario type of the task.

Constraints

N/A

Range

  • migration: real-time migration
  • sync: real-time synchronization
  • cloudDataGuard: real-time disaster recovery

task_type

String

Definition

Task migration mode, which specifies the execution mode of the data replication task.

Constraints

N/A

Range

  • FULL_TRANS: Full migration. Only historical data is migrated.
  • FULL_INCR_TRANS: Full+incremental migration. Historical data is migrated first, and then incremental data is continuously synchronized.
  • INCR_TRANS: Incremental migration. Only data changes are synchronized.

children

Array of objects

Definition

Subtask information body list, which contains details about all subtasks of the current task.

For details, see Table 6.

node_newFramework

Boolean

Definition

Whether the task is executed using the new framework.

Constraints

N/A

Range

  • true: new framework

  • false: old framework

job_action

Object

Definition

Task operation command matrix, which contains the operation commands that can and cannot be executed for the current task.

For details, see Table 7.
Table 6 Data structure description of field children

Parameter

Type

Description

billing_tag

Boolean

Definition

Billing mode tag of the task, which indicates whether the task is being billed.

Constraints

N/A

Range

  • true: being billed

  • false: not being billed

create_time

String

Definition

Time when the subtask was created, which indicates the timestamp when the task was created for the first time.

Constraints

N/A

Range

N/A

db_use_type

String

Definition

Service scenario type of the migration task.

Constraints

N/A

Range

  • migration: real-time migration
  • sync: real-time synchronization
  • cloudDataGuard: real-time disaster recovery

description

String

Definition

Subtask description, which describes the task purpose or remarks.

Constraints

N/A

Range

N/A

engine_type

String

Definition

Engine type of the DRS task.

Constraints

N/A

Range

  • mysql: migration and synchronization from MySQL to MySQL
  • mongodb: migration and synchronization from MongoDB to DDS
  • cloudDataGuard-mysql: DR from MySQL to MySQL
  • gaussdbv5: GaussDB synchronization
  • mysql-to-kafka: synchronization from MySQL to Kafka
  • taurus-to-kafka: synchronization from TaurusDB to Kafka
  • gaussdbv5ha-to-kafka: synchronization from GaussDB Centralized to Kafka
  • postgresql: synchronization from PostgreSQL to PostgreSQL
  • oracle-to-gaussdbv5: synchronization from Oracle to GaussDB Distributed
  • oracle-to-gaussdbv5ha: synchronization from Oracle to GaussDB Centralized
  • gaussdbv5-to-oracle: synchronization from GaussDB Distributed to Oracle
  • gaussdbv5ha-to-oracle: synchronization from GaussDB Centralized to Oracle
  • gaussdbv5-to-kafka: synchronization from GaussDB Distributed to Kafka

For details, see Engine Types.

error_msg

String

Definition

Detailed error description returned when the task fails to be executed.

Constraints

N/A

Range

N/A

id

String

Definition

Subtask ID, which uniquely identifies a data replication subtask.

Constraints

N/A

Range

N/A

job_direction

String

Definition

Migration direction of the subtask.

Constraints

N/A

Range

  • up: to-the-cloud scenarios and DR scenarios where the current cloud is the standby
  • down: out-of-cloud scenarios and DR scenarios where the current cloud is the active
  • non-dbs: between self-built databases

name

String

Definition

Subtask name, which identifies a data replication subtask.

Constraints

N/A

Range

N/A

net_type

String

Definition

Type of the network used by the subtask.

Constraints

N/A

Range

  • vpn: Virtual Private Network
  • vpc: Virtual Private Cloud
  • eip: Elastic IP

node_newFramework

Boolean

Definition

Whether the subtask is executed using the new framework.

Constraints

N/A

Range

  • true: new framework

  • false: old framework

status

String

Definition

Subtask status.

Constraints

N/A

Range

  • CREATING: The task is being created.
  • CREATE_FAILED: The task fails to be created.
  • CONFIGURATION: The task is being configured.
  • STARTJOBING: The task is being started.
  • WAITING_FOR_START: The task is waiting to be started.
  • START_JOB_FAILED: The task fails to be started.
  • PAUSING: The task is paused.
  • FULL_TRANSFER_STARTED: Full migration or synchronization starts. Initialization is in progress in the DR scenario.
  • FULL_TRANSFER_FAILED: Full migration or synchronization fails. Initialization fails in the DR scenario.
  • FULL_TRANSFER_COMPLETE: Full migration or synchronization is complete. Initialization is complete in the DR scenario.
  • INCRE_TRANSFER_STARTED: Incremental migration or synchronization starts. The DR task is in progress.
  • INCRE_TRANSFER_FAILED: Incremental migration or synchronization fails. A DR exception occurs.
  • RELEASE_RESOURCE_STARTED: The task is being stopped.
  • RELEASE_RESOURCE_FAILED: The task fails to be stopped.
  • RELEASE_RESOURCE_COMPLETE: The task is stopped.
  • REBUILD_NODE_STARTED: The task is being recovered.
  • REBUILD_NODE_FAILED: The task fails to be recovered.
  • CHANGE_JOB_STARTED: The task is being changed.
  • CHANGE_JOB_FAILED: The task fails to be changed.
  • DELETED: The task is deleted.
  • CHILD_TRANSFER_STARTING: The subtask is being started.
  • CHILD_TRANSFER_STARTED: The subtask is being migrated.
  • CHILD_TRANSFER_COMPLETE: The subtask migration is complete.
  • CHILD_TRANSFER_FAILED: The subtask fails to be migrated.
  • RELEASE_CHILD_TRANSFER_STARTED: The subtask is being stopped.
  • RELEASE_CHILD_TRANSFER_COMPLETE: The subtask is stopped.
  • NODE_UPGRADE_START: The upgrade starts.
  • NODE_UPGRADE_COMPLETE: The upgrade is complete.
  • NODE_UPGRADE_FAILED: The upgrade fails.

task_type

String

Definition

Subtask migration mode, which specifies the execution mode of the data replication task.

Constraints

N/A

Range

  • FULL_TRANS: Full migration. Only historical data is migrated.
  • FULL_INCR_TRANS: Full+incremental migration. Historical data is migrated first, and then incremental data is continuously synchronized.
  • INCR_TRANS: Incremental migration. Only data changes are synchronized.

job_action

Object

Definition

Subtask operation command matrix, which contains the operation commands that can and cannot be executed for the current subtask.

For details, see Table 7.
Table 7 Data structure description of field job_action

Parameter

Type

Description

available_actions

Array of strings

Definition

The set of operation commands that can be executed for the task.

Constraints

N/A

Range

  • CREATE: indicates the operation command for creating a task.
  • CHOOSE_OBJECT: indicates the operation command for selecting an object.
  • PRE_CHECK: indicates the operation command for pre-check.
  • CHANGE_MODE: indicates the operation command for changing the task mode.
  • FREE_RESOURCE: indicates the operation command for releasing resources.
  • MODIFY_DB_CONFIG: indicates the operation command for modifying database configurations.
  • RESET_DB_PWD: indicates the operation command for resetting the password of the source or destination database.
  • MODIFY_CONFIGURATION: indicates the operation command for modifying task configurations.
  • PAUSE: indicates the operation command for pausing a task.
  • START: indicates the operation command for starting a task.
  • CHANGE: indicates the operation command for modifying a task.
  • RETRY: indicates the operation command for retrying a task.
  • RESET: indicates the operation command for resetting a task.
  • DELETE: indicates the operation command for deleting a task.
  • QUERY_PRE_CHECK: indicates the operation command for performing a pre-check.
  • SWITCH_OVER: indicates the operation command for performing a DR switchover.
  • START_INCR: indicates the operation command for starting an incremental Cassandra task.
  • MODIFY_TASK_NUMBER: indicates the operation command for modifying the number of Cassandra threads.
  • CONTINUE_JOB: indicates the operation command for resuming a failed or stopped task from Oracle to GaussDB distributed.
  • STOP_JOB: indicates the operation command for stopping a task from Oracle to GaussDB distributed.
  • CONTINUE_CAPTURE: indicates the operation command for starting data capture for a task from Oracle to GaussDB distributed.
  • STOP_CAPTURE: indicates the operation command for stopping data capture for a task from Oracle to GaussDB distributed.
  • CONTINUE_APPLY: indicates the operation command for starting data replay for a task from Oracle to GaussDB distributed.
  • STOP_APPLY: indicates the operation command for stopping data replay for a task from Oracle to GaussDB distributed.
  • PAY_ORDER: indicates the operation command for paying yearly/monthly orders.
  • UNSUBSCRIBE: indicates the operation command for unsubscribing from yearly/monthly subscriptions.
  • TO_PERIOD: indicates the operation command for changing the billing mode from pay-per-use to yearly/monthly.
  • TO_RENEW: indicates the operation command for renewing a yearly/monthly subscription.
  • ORDER_INFO: indicates the operation command for querying order details.
  • CHANGE_FLAVOR: indicates the operation command for changing task specifications.
  • CLONE: indicates the operation command for cloning a task.

unavailable_actions

Array of strings

Definition

The set of operation commands that cannot be executed for the task.

Constraints

N/A

Range

  • CREATE: indicates the operation command for creating a task.
  • CHOOSE_OBJECT: indicates the operation command for selecting an object.
  • PRE_CHECK: indicates the operation command for pre-check.
  • CHANGE_MODE: indicates the operation command for changing the task mode.
  • FREE_RESOURCE: indicates the operation command for releasing resources.
  • MODIFY_DB_CONFIG: indicates the operation command for modifying database configurations.
  • RESET_DB_PWD: indicates the operation command for resetting the password of the source or destination database.
  • MODIFY_CONFIGURATION: indicates the operation command for modifying task configurations.
  • PAUSE: indicates the operation command for pausing a task.
  • START: indicates the operation command for starting a task.
  • CHANGE: indicates the operation command for modifying a task.
  • RETRY: indicates the operation command for retrying a task.
  • RESET: indicates the operation command for resetting a task.
  • DELETE: indicates the operation command for deleting a task.
  • QUERY_PRE_CHECK: indicates the operation command for performing a pre-check.
  • SWITCH_OVER: indicates the operation command for performing a DR switchover.
  • START_INCR: indicates the operation command for starting an incremental Cassandra task.
  • MODIFY_TASK_NUMBER: indicates the operation command for modifying the number of Cassandra threads.
  • CONTINUE_JOB: indicates the operation command for resuming a failed or stopped task from Oracle to GaussDB distributed.
  • STOP_JOB: indicates the operation command for stopping a task from Oracle to GaussDB distributed.
  • CONTINUE_CAPTURE: indicates the operation command for starting data capture for a task from Oracle to GaussDB distributed.
  • STOP_CAPTURE: indicates the operation command for stopping data capture for a task from Oracle to GaussDB distributed.
  • CONTINUE_APPLY: indicates the operation command for starting data replay for a task from Oracle to GaussDB distributed.
  • STOP_APPLY: indicates the operation command for stopping data replay for a task from Oracle to GaussDB distributed.
  • PAY_ORDER: indicates the operation command for paying yearly/monthly orders.
  • UNSUBSCRIBE: indicates the operation command for unsubscribing from yearly/monthly subscriptions.
  • TO_PERIOD: indicates the operation command for changing the billing mode from pay-per-use to yearly/monthly.
  • TO_RENEW: indicates the operation command for renewing a yearly/monthly subscription.
  • ORDER_INFO: indicates the operation command for querying order details.
  • CHANGE_FLAVOR: indicates the operation command for changing task specifications.
  • CLONE: indicates the operation command for cloning a task.

current_action

String

Definition

Operation command that is being executed for the task.

Constraints

N/A

Range

  • SWITCH_OVER: indicates that a DR switchover is in progress.
  • STOP_JOB: indicates that a task is being paused.

Example Request

  • Example of querying the real-time synchronization task list: 
    https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs

{
  "cur_page" : 1,
  "db_use_type" : "sync",
  "engine_type" : "",
  "name" : "",
  "net_type" : "",
  "per_page" : 5,
  "status" : ""
}
  • Example of querying the real-time migration task list: 
    https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs

{
  "cur_page" : 1,
  "db_use_type" : "migration",
  "engine_type" : "",
  "name" : "",
  "net_type" : "",
  "per_page" : 5,
  "status" : ""
}
  • Example of querying the real-time synchronization tasks based on the database instance ID: 
    https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs 
  
 { 
   "cur_page" : 1, 
   "db_use_type" : "sync", 
   "engine_type" : "", 
   "enterprise_project_id" : "", 
   "name" : "", 
   "net_type" : "", 
   "per_page" : 5, 
   "instance_ids" : [ "id1", "id2" ], 
   "status" : "" 
 }
  • Example of querying the real-time synchronization tasks based on the database instance IP address: 
    https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs 
  
 { 
   "cur_page" : 1, 
   "db_use_type" : "sync", 
   "engine_type" : "", 
   "enterprise_project_id" : "", 
   "name" : "", 
   "net_type" : "", 
   "per_page" : 5, 
   "instance_ip" : "127.0.0.1", 
   "status" : "" 
 }
  • Querying the real-time synchronization task list using multiple task IDs 
    https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs 
  
{
  "cur_page": 1,
  "db_use_type": "sync",
  "engine_type": "",
  "name": "bee869bc-15c0-4b3b-a34b-bf0d5efjb201,c2a61a77-6e55-4cd8-8be1-a562cc6jb201",
  "net_type": "",
  "per_page": 100,
  "status": ""
}

Example Response

Status code: 200

OK

  • Example response for querying the real-time migration tasks: 
    {
  "jobs" : [ {
    "id" : "24834eb6-be30-464e-a299-f7aa730jb101",
    "name" : "DRS-3999-lws",
    "status" : "INCRE_TRANSFER_FAILED",
    "description" : "",
    "create_time" : "2020-12-21 10:57:49",
    "error_msg" : "service LOGMANAGER failed, cause by: Unable to connect to DBMS: url=jdbc:mysql://172.22.74.56:3306?useUnicode=true&allowLoadLocalInfile=false&characterEncoding=UTF-8&connectTimeout=5000&useSSL=false&allowPublicKeyRetrieval=true&verifyServerCertificate=false&serverTimezone=UTC user=root",
    "engine_type" : "mysql",
    "net_type" : "eip",
    "billing_tag" : false,
    "job_direction" : "up",
    "db_use_type" : "migration",
    "task_type" : "FULL_INCR_TRANS",
    "node_newFramework" : false
    "job_action":{
        "available_actions": [
            "CREATE",
            "CHOOSE_OBJECT",
            "PRE_CHECK",
            "CHANGE_MODE",
            "FREE_RESOURCE",
            "MODIFY_DB_CONFIG",
            "RESET_DB_PWD",
            "MODIFY_CONFIGURATION",
            "PAUSE",
            "RETRY",
            "RESET",
         ],
         "unavailable_actions": [
             "START",
             "CHANGE",
             "DELETE",
             "QUERY_PRE_CHECK",
             "SWITCH_OVER",
             "MODIFY_SPECIFICATION_ID",
             "START_INCR",
             "MODIFY_TASK_NUMBER",
             "CONTINUE_JOB",
             "STOP_JOB",
             "CONTINUE_CAPTURE",
             "STOP_CAPTURE",
             "CONTINUE_APPLY",
             "API_CONFIGURATION_ACTION",
             "STOP_APPLY",
             "PAY_ORDER",
             "UNSUBSCRIBE",
             "TO_PERIOD",
             "TO_RENEW",
             "ORDER_INFO",
             "CHANGE_FLAVOR",
             "CLONE"
         ]
    }    
  }, {
    "id" : "140b5236-88ad-43c8-811c-1268453jb101",
    "name" : "DRS-0042-linxiaolu",
    "status" : "CONFIGURATION",
    "description" : "",
    "create_time" : "2020-12-19 16:23:24",
    "engine_type" : "mysql",
    "net_type" : "eip",
    "billing_tag" : false,
    "job_direction" : "up",
    "db_use_type" : "migration",
    "task_type" : "FULL_INCR_TRANS",
    "node_newFramework" : false
    "job_action": {
        "available_actions": [
            "CREATE",
            "START",
            "CHANGE",
            "CHOOSE_OBJECT",
            "PRE_CHECK",
            "CHANGE_MODE",
            "FREE_RESOURCE",
            "MODIFY_DB_CONFIG",
            "API_CONFIGURATION_ACTION"
        ],
        "unavailable_actions": [
            "RETRY",
            "RESET",
            "DELETE",
            "QUERY_PRE_CHECK",
            "SWITCH_OVER",
            "MODIFY_SPECIFICATION_ID",
            "RESET_DB_PWD",
            "MODIFY_CONFIGURATION",
            "PAUSE",
            "JUMP_RETRY",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "CONTINUE_JOB",
            "STOP_JOB",
            "CONTINUE_CAPTURE",
            "STOP_CAPTURE",
            "CONTINUE_APPLY",
            "STOP_APPLY",
            "PAY_ORDER",
            "UNSUBSCRIBE",
            "TO_PERIOD",
            "TO_RENEW",
            "ORDER_INFO",
            "CHANGE_FLAVOR",
             "CLONE"
         ]
     }
  }, {
    "id" : "7f8e6f74-72d2-4ddd-bb8f-6c41397jb101",
    "name" : "DRS-0796",
    "status" : "RELEASE_RESOURCE_COMPLETE",
    "description" : "",
    "create_time" : "2020-12-18 10:48:11",
    "engine_type" : "mysql",
    "net_type" : "eip",
    "billing_tag" : false,
    "job_direction" : "non-dbs",
    "db_use_type" : "migration",
    "task_type" : "FULL_INCR_TRANS",
    "node_newFramework" : false
    "job_action": {
        "available_actions": [
            "CREATE",
            "DELETE",
            "PRE_CHECK",
            "CHANGE_MODE",
            "MODIFY_DB_CONFIG",
            "CLONE"
        ],
        "unavailable_actions": [
            "FREE_RESOURCE",
            "START",
            "CHANGE",
            "CHOOSE_OBJECT",
            "RETRY",
            "RESET",
            "QUERY_PRE_CHECK",
            "SWITCH_OVER",
            "MODIFY_SPECIFICATION_ID",
            "RESET_DB_PWD",
            "MODIFY_CONFIGURATION",
            "PAUSE",
            "JUMP_RETRY",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "CONTINUE_JOB",
            "STOP_JOB",
            "CONTINUE_CAPTURE",
            "STOP_CAPTURE",
            "CONTINUE_APPLY",
            "STOP_APPLY",
            "PAY_ORDER",
            "UNSUBSCRIBE",
            "TO_PERIOD",
            "TO_RENEW",
            "ORDER_INFO",
            "CHANGE_FLAVOR"
         ]
     }
  }, {
    "id" : "14d88eeb-ee7e-4d30-a46e-a5ec8eajb101",
    "name" : "masj-mysql_migration_down-1",
    "status" : "INCRE_TRANSFER_STARTED",
"description": "[using] api test 2\n1. This API is used to configure the source and destination database information. Before selecting a table, you must perform this operation. \n2. If the description of a task in the configuration is successfully modified, 202 success is returned. \n3. If the description of a task in an incremental migration fails to be modified, 202 failed DRS.M01504\nAnother operation is being performed on the migration task or the migration task is abnormal. Try again later./",
    "create_time" : "2020-12-15 15:43:02",
    "engine_type" : "mysql",
    "net_type" : "eip",
    "billing_tag" : true,
    "job_direction" : "down",
    "db_use_type" : "migration",
    "task_type" : "FULL_INCR_TRANS",
    "node_newFramework" : false
    "job_action":{
        "available_actions": [
             "CREATE",
             "CHOOSE_OBJECT",
             "PRE_CHECK",
             "CHANGE_MODE",
             "FREE_RESOURCE",
             "MODIFY_DB_CONFIG",
             "RESET_DB_PWD",
             "MODIFY_CONFIGURATION",
             "PAUSE",
         ],
        "unavailable_actions": [
             "START",
             "RETRY",
             "RESET",
             "CHANGE",
             "DELETE",
             "QUERY_PRE_CHECK",
             "SWITCH_OVER",
             "MODIFY_SPECIFICATION_ID",
             "START_INCR",
             "MODIFY_TASK_NUMBER",
             "CONTINUE_JOB",
             "STOP_JOB",
             "CONTINUE_CAPTURE",
             "STOP_CAPTURE",
             "CONTINUE_APPLY",
             "API_CONFIGURATION_ACTION",
             "STOP_APPLY",
             "PAY_ORDER",
             "UNSUBSCRIBE",
             "TO_PERIOD",
             "TO_RENEW",
             "ORDER_INFO",
             "CHANGE_FLAVOR",
             "CLONE"
         ]
    }    
  }, {
    "id" : "d54691d2-f105-434d-a75d-809b017jb101",
    "name" : "masj-2-mysql_migration_down",
    "status" : "CONFIGURATION",
"description": "[using] api test 2\n1. This API is used to configure the source and destination database information. Before selecting a table, you must perform this operation. \n2. If the description of a task in the configuration is successfully modified, 202 success is returned. \n3. If the description of a task in an incremental migration fails to be modified, 202 failed DRS.M01504\nAnother operation is being performed on the migration task or the migration task is abnormal. Try again later./",
    "create_time" : "2020-12-14 21:39:07",
    "engine_type" : "mysql",
    "net_type" : "eip",
    "billing_tag" : false,
    "job_direction" : "down",
    "db_use_type" : "migration",
    "task_type" : "FULL_INCR_TRANS",
    "node_newFramework" : false
    "job_action": {
        "available_actions": [
            "CREATE",
            "START",
            "CHANGE",
            "CHOOSE_OBJECT",
            "PRE_CHECK",
            "CHANGE_MODE",
            "FREE_RESOURCE",
            "MODIFY_DB_CONFIG",
            "API_CONFIGURATION_ACTION"
        ],
        "unavailable_actions": [
            "RETRY",
            "RESET",
            "DELETE",
            "QUERY_PRE_CHECK",
            "SWITCH_OVER",
            "MODIFY_SPECIFICATION_ID",
            "RESET_DB_PWD",
            "MODIFY_CONFIGURATION",
            "PAUSE",
            "JUMP_RETRY",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "CONTINUE_JOB",
            "STOP_JOB",
            "CONTINUE_CAPTURE",
            "STOP_CAPTURE",
            "CONTINUE_APPLY",
            "STOP_APPLY",
            "PAY_ORDER",
            "UNSUBSCRIBE",
            "TO_PERIOD",
            "TO_RENEW",
            "ORDER_INFO",
            "CHANGE_FLAVOR",
             "CLONE"
         ]
     }
  } ],
  "total_record" : 7
}
  • Example response for querying the real-time synchronization tasks: 
    {
  "jobs" : [ {
    "id" : "7994aac9-0a15-4fdb-bcc5-667f088jb20b",
    "name" : "DRS-8200",
    "status" : "CREATE_FAILED",
    "description" : "",
    "create_time" : "2020-12-21 18:02:36",
    "error_msg" : "system error!",
    "engine_type" : "oracle-to-mysql",
    "net_type" : "eip",
    "billing_tag" : false,
    "job_direction" : "up",
    "db_use_type" : "sync",
    "task_type" : "FULL_INCR_TRANS",
    "node_newFramework" : false
    "job_action": {
        "available_actions": [
            "CREATE",
            "DELETE",
            "START",
            "CHANGE",
            "CHOOSE_OBJECT",
            "PRE_CHECK",
            "CHANGE_MODE",
            "MODIFY_DB_CONFIG",
            "API_CONFIGURATION_ACTION"
        ],
        "unavailable_actions": [
            "FREE_RESOURCE",
            "RETRY",
            "RESET",
            "QUERY_PRE_CHECK",
            "SWITCH_OVER",
            "MODIFY_SPECIFICATION_ID",
            "RESET_DB_PWD",
            "MODIFY_CONFIGURATION",
            "PAUSE",
            "JUMP_RETRY",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "CONTINUE_JOB",
            "STOP_JOB",
            "CONTINUE_CAPTURE",
            "STOP_CAPTURE",
            "CONTINUE_APPLY",
            "STOP_APPLY",
            "PAY_ORDER",
            "UNSUBSCRIBE",
            "TO_PERIOD",
            "TO_RENEW",
            "ORDER_INFO",
            "CHANGE_FLAVOR",
             "CLONE"
         ]
     }
  }, {
    "id" : "f463331d-e079-4689-bbef-4553202jb20b",
    "name" : "DRS-1285",
    "status" : "CONFIGURATION",
    "description" : "",
    "create_time" : "2020-12-21 17:19:38",
    "engine_type" : "oracle-to-mysql",
    "net_type" : "eip",
    "billing_tag" : false,
    "job_direction" : "up",
    "db_use_type" : "sync",
    "task_type" : "FULL_INCR_TRANS",
    "node_newFramework" : false
    "job_action": {
        "available_actions": [
            "CREATE",
            "START",
            "CHANGE",
            "CHOOSE_OBJECT",
            "PRE_CHECK",
            "CHANGE_MODE",
            "FREE_RESOURCE",
            "MODIFY_DB_CONFIG",
            "API_CONFIGURATION_ACTION"
        ],
        "unavailable_actions": [
            "RETRY",
            "RESET",
            "DELETE",
            "QUERY_PRE_CHECK",
            "SWITCH_OVER",
            "MODIFY_SPECIFICATION_ID",
            "RESET_DB_PWD",
            "MODIFY_CONFIGURATION",
            "PAUSE",
            "JUMP_RETRY",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "CONTINUE_JOB",
            "STOP_JOB",
            "CONTINUE_CAPTURE",
            "STOP_CAPTURE",
            "CONTINUE_APPLY",
            "STOP_APPLY",
            "PAY_ORDER",
            "UNSUBSCRIBE",
            "TO_PERIOD",
            "TO_RENEW",
            "ORDER_INFO",
            "CHANGE_FLAVOR",
             "CLONE"
         ]
     }
  }, {
    "id" : "7f13c511-c35b-4f82-92ae-83bcbf0jb201",
    "name" : "DRS-9383",
    "status" : "CONFIGURATION",
    "description" : "",
    "create_time" : "2020-12-21 17:18:44",
    "engine_type" : "mysql",
    "net_type" : "eip",
    "billing_tag" : false,
    "job_direction" : "up",
    "db_use_type" : "sync",
    "task_type" : "FULL_INCR_TRANS",
    "node_newFramework" : false
    "job_action": {
        "available_actions": [
            "CREATE",
            "START",
            "CHANGE",
            "CHOOSE_OBJECT",
            "PRE_CHECK",
            "CHANGE_MODE",
            "FREE_RESOURCE",
            "MODIFY_DB_CONFIG",
            "API_CONFIGURATION_ACTION"
        ],
        "unavailable_actions": [
            "RETRY",
            "RESET",
            "DELETE",
            "QUERY_PRE_CHECK",
            "SWITCH_OVER",
            "MODIFY_SPECIFICATION_ID",
            "RESET_DB_PWD",
            "MODIFY_CONFIGURATION",
            "PAUSE",
            "JUMP_RETRY",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "CONTINUE_JOB",
            "STOP_JOB",
            "CONTINUE_CAPTURE",
            "STOP_CAPTURE",
            "CONTINUE_APPLY",
            "STOP_APPLY",
            "PAY_ORDER",
            "UNSUBSCRIBE",
            "TO_PERIOD",
            "TO_RENEW",
            "ORDER_INFO",
            "CHANGE_FLAVOR",
             "CLONE"
         ]
     }
  }, {
    "id" : "7686e879-46a4-4d6b-bda9-5540424jb201",
    "name" : "DRS-9272",
    "status" : "CONFIGURATION",
    "description" : "",
    "create_time" : "2020-12-21 16:53:36",
    "engine_type" : "mysql",
    "net_type" : "eip",
    "billing_tag" : false,
    "job_direction" : "up",
    "db_use_type" : "sync",
    "task_type" : "FULL_INCR_TRANS",
    "node_newFramework" : false
    "job_action": {
        "available_actions": [
            "CREATE",
            "START",
            "CHANGE",
            "CHOOSE_OBJECT",
            "PRE_CHECK",
            "CHANGE_MODE",
            "FREE_RESOURCE",
            "MODIFY_DB_CONFIG",
            "API_CONFIGURATION_ACTION"
        ],
        "unavailable_actions": [
            "RETRY",
            "RESET",
            "DELETE",
            "QUERY_PRE_CHECK",
            "SWITCH_OVER",
            "MODIFY_SPECIFICATION_ID",
            "RESET_DB_PWD",
            "MODIFY_CONFIGURATION",
            "PAUSE",
            "JUMP_RETRY",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "CONTINUE_JOB",
            "STOP_JOB",
            "CONTINUE_CAPTURE",
            "STOP_CAPTURE",
            "CONTINUE_APPLY",
            "STOP_APPLY",
            "PAY_ORDER",
            "UNSUBSCRIBE",
            "TO_PERIOD",
            "TO_RENEW",
            "ORDER_INFO",
            "CHANGE_FLAVOR",
             "CLONE"
         ]
     }
  }, {
    "id" : "5b2c2ec8-430e-4de0-937b-9d9547ajb201",
    "name" : "DRS-2899",
    "status" : "RELEASE_RESOURCE_COMPLETE",
    "description" : "",
    "create_time" : "2020-12-21 16:24:24",
    "engine_type" : "mysql",
    "net_type" : "eip",
    "billing_tag" : false,
    "job_direction" : "up",
    "db_use_type" : "sync",
    "task_type" : "FULL_INCR_TRANS",
    "node_newFramework" : false
    "job_action": {
        "available_actions": [
            "CREATE",
            "DELETE",
            "PRE_CHECK",
            "CHANGE_MODE",
            "MODIFY_DB_CONFIG",
            "CLONE"
        ],
        "unavailable_actions": [
            "FREE_RESOURCE",
            "START",
            "CHANGE",
            "CHOOSE_OBJECT",
            "RETRY",
            "RESET",
            "QUERY_PRE_CHECK",
            "SWITCH_OVER",
            "MODIFY_SPECIFICATION_ID",
            "RESET_DB_PWD",
            "MODIFY_CONFIGURATION",
            "PAUSE",
            "JUMP_RETRY",
            "START_INCR",
            "MODIFY_TASK_NUMBER",
            "CONTINUE_JOB",
            "STOP_JOB",
            "CONTINUE_CAPTURE",
            "STOP_CAPTURE",
            "CONTINUE_APPLY",
            "STOP_APPLY",
            "PAY_ORDER",
            "UNSUBSCRIBE",
            "TO_PERIOD",
            "TO_RENEW",
            "ORDER_INFO",
            "CHANGE_FLAVOR"
         ]
     }
  } ],
  "total_record" : 18
}

Status Code

Status Code

Description

200

OK

400

Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Public API Management