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

Querying Task Details in Batches

Function

This API is used to query task details in batches by 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.

Constraints

To ensure API performance, it is recommended that a single batch contain no more than 10 tasks.

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/batch-detail

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

jobs

Yes

Array of strings

Definition

Request body for querying task details in batches.

Constraints

N/A

Range

N/A

Default Value

N/A

page_req

No

Object

Definition

Pagination information.

For details, see Table 4.
Table 4 Data structure description of field page_req

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.

Constraints

The value cannot exceed the maximum number of pages (Number of pages = Number of transferred job IDs/Number of tasks on each page). If it is set to 0, all task information is obtained.

Range

0 to the upper limit of integers

Default Value

1

per_page

No

Integer

Definition

Number of tasks on each page. If the value is set to 0, all task information is obtained.

Constraints

N/A

Range

0–100

Default Value

5

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

count

Integer

Definition

Number of tasks.

Constraints

N/A

Range

N/A

results

Array of objects

Definition

Task details.

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

Parameter

Type

Description

id

String

Definition

Task ID.

Constraints

N/A

Range

N/A

parent_id

String

Definition

Parent task ID.

Constraints

N/A

Range

N/A

name

String

Definition

Task name.

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

Description.

Constraints

N/A

Range

N/A

create_time

String

Definition

Creation time, in timestamp format.

Constraints

N/A

Range

N/A

task_type

String

Definition

Task mode.

Constraints

N/A

Range

  • FULL_TRANS: full migration
  • INCR_TRANS: incremental migration
  • FULL_INCR_TRANS: full+incremental migration

source_endpoint

Object

Definition

Source database information.

For details, see Table 7.

dmq_endpoint

Object

Definition

DMQ information body.

For details, see Table 7.

source_sharding

Array of objects

Definition

Information about the physical source database.

For details, see Table 7.

target_endpoint

Object

Definition

Information body of the destination database.

For details, see Table 7.

net_type

String

Definition

Network type.

Constraints

N/A

Range

  • vpn
  • vpc
  • eip

failed_reason

String

Definition

Failure cause.

Constraints

N/A

Range

N/A

inst_info

Object

Definition

Replication instance information.

For details, see Table 9.

actual_start_time

String

Definition

Start time, in timestamp format.

Constraints

N/A

Range

N/A

full_transfer_complete_time

String

Definition

Full migration completion time, in timestamp format.

Constraints

N/A

Range

N/A

update_time

String

Definition

Update time, in timestamp format.

Constraints

N/A

Range

N/A

job_direction

String

Definition

Task direction.

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

job_kernel_direction

String

Definition

DR kernel direction. When no switchover occurs, the value of this parameter is the same as that of job_direction. When a switchover occurs, the value of this parameter is opposite to that of job_direction.

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

db_use_type

String

Definition

Migration scenario.

Constraints

N/A

Range

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

need_restart

Boolean

Definition

Whether a restart is required.

Constraints

N/A

Range

  • true: A restart is required.
  • false: A restart is not required.

is_target_readonly

Boolean

Definition

Whether the destination instance is restricted to read-only.

Constraints

N/A

Range

  • true: The destination instance is restricted to read-only.
  • false: The destination instance is not restricted to read-only.

conflict_policy

String

Definition

Conflict policy.

Constraints

N/A

Range

  • stop: The conflict fails.
  • overwrite: Conflicting data is overwritten.
  • ignore: The conflict is ignored.

filter_ddl_policy

String

Definition

DDL filtering policy.

Constraints

N/A

Range

  • drop_database: filtering out the DROP DATABASE operation.
  • drop_databasefilter_all: filtering out all DDLs.
  • "": no filter

speed_limit

Array of objects

Definition

Migration speed limit.

For details, see Table 10.

schema_type

String

Definition

Migration schemes.

Constraints

N/A

Range

  • Replication: primary/standby replication.
  • Tungsten: parses logs.
  • PGBaseBackup: PostgreSQL backup.

node_num

String

Definition

The number of nodes.

Constraints

N/A

Range

N/A

object_switch

Boolean

Definition

Whether to enable object selection.

Constraints

N/A

Range

  • true: Object selection is enabled.
  • false: Object selection is disabled.

master_job_id

String

Definition

Main task ID

Constraints

N/A

Range

N/A

full_mode

String

Definition

Full snapshot mode.

Constraints

N/A

Range

N/A

struct_trans

Boolean

Definition

Whether to migrate the structure.

Constraints

N/A

Range

  • true: The structure is migrated.
  • false: The structure is not migrated.

index_trans

Boolean

Definition

Whether to migrate indexes.

Constraints

N/A

Range

  • true: The indexes are migrated.
  • false: The indexes are not migrated.

replace_definer

Boolean

Definition

Whether to migrate the Definers of all source database objects to the destination database user.

Constraints

N/A

Range

  • true: The Definers of all source database objects are migrated to the destination database user.
  • false: The Definers of all source database objects are not migrated to the destination database user.

migrate_user

Boolean

Definition

Whether to migrate users.

Constraints

N/A

Range

  • true: Users are migrated.
  • false: Users are not migrated.

sync_database

Boolean

Definition

Whether to perform database-level synchronization.

Constraints

N/A

Range

N/A

  • true: database-level synchronization
  • false: not database-level synchronization

error_code

String

Definition

Error code.

Constraints

N/A

Range

N/A

error_message

String

Definition

Error message.

Constraints

N/A

Range

N/A

target_root_db

Object

Definition

Information about the root node database of the destination instance.

For details, see Table 11.

az_code

String

Definition

AZ where the node is located.

Constraints

N/A

Range

N/A

vpc_id

String

Definition

VPC to which the node belongs.

Constraints

N/A

Range

N/A

subnet_id

String

Definition

Subnet where the node is located.

Constraints

N/A

Range

N/A

security_group_id

String

Definition

Security group to which the node belongs.

Constraints

N/A

Range

N/A

multi_write

Boolean

Definition

Whether the task is a multi-active DR task. The value is true when the task is a dual-active DR task.

Constraints

N/A

Range

  • true: multi-active DR
  • false: not multi-active DR

support_ip_v6

Boolean

Definition

Whether IPv6 is supported.

Constraints

N/A

Range

  • true: IPv6 is supported.
  • false: IPv6 is not supported.

inherit_id

String

Definition

Inherited task ID.

Constraints

N/A

Range

N/A

gtid

String

Definition

GTID set of breakpoints.

Constraints

N/A

Range

N/A

alarm_notify

Object

Definition

Exception notification settings.

For details, see Table 12.

is_multi_az

Boolean

Definition

Whether the task is a primary/standby task.

Constraints

N/A

Range

  • true: The task is a primary/standby task.
  • false: The task is not a primary/standby task.

az_name

String

Definition

AZ name of the node.

Constraints

N/A

Range

N/A

master_az

String

Definition

Primary AZ of the primary/standby task.

Constraints

N/A

Range

N/A

slave_az

String

Definition

Standby AZ of the primary/standby task.

Constraints

N/A

Range

N/A

node_role

String

Definition

Primary/Standby role of a task.

Constraints

N/A

Range

N/A

incre_start_position

String

Definition

Start point of an incremental task.

Constraints

N/A

Range

N/A

period_order

Object

Definition

Yearly/Monthly information.

For details, see Table 14.

Constraints

This parameter is returned only for yearly/monthly tasks.

Range

N/A

object_infos

Array of objects

Definition

Synchronized object information.

For details, see Table 15.

original_job_direction

String

Definition

Task direction.

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

data_transformation

Object

Definition

Data filtering configuration information.

For details, see Table 16.

tags

Array of objects

Definition

Task tag.

For details, see Table 21.

public_ip_list

Array of objects

Definition

Information about a specified EIP.

For details, see Table 22.

bind_public_ip_state

String

Definition

Whether an EIP is successfully bound.

Constraints

N/A

Range

N/A

children

Array of objects

Definition

In the case of multiple tasks, if an EIP fails to be bound to a subtask, the subtask information is returned.

For details, see Table 23.

is_open_fast_clean

Boolean

Definition

Whether to enable binlog clearing for RDS for MySQL or RDS for MariaDB.

Constraints

N/A

Range

  • true: Enable binlog clearing.
  • false: Disable binlog clearing.
Table 7 Data structure description of fields source_endpoint, dmq_endpoint, source_sharding, and target_endpoint

Parameter

Type

Description

db_type

String

Definition

Database type.

Constraints

N/A

Range

  • mysql: MySQL
  • mongodb: MongoDB
  • gaussdbv5: GaussDB Distributed
  • taurus: TaurusDB
  • gaussdbv5ha: GaussDB Centralized
  • kafka: Kafka
  • postgresql: PostgreSQL
  • oracle: Oracle

az_code

String

Definition

Code of the AZ where the database is located.

Constraints

N/A

Range

N/A

region

String

Definition

Region where the DB instance is located. This parameter is mandatory when the database is a cloud instance, for example, an RDS instance.

Constraints

N/A

Range

N/A

inst_id

String

Definition

DB instance ID. This parameter is mandatory when the database is a cloud instance, for example, an RDS instance.

Constraints

N/A

Range

N/A

vpc_id

String

Definition

ID of the VPC where the database is located.

Constraints

N/A

Range

N/A

subnet_id

String

Definition

ID of the subnet where the database is located.

Constraints

N/A

Range

N/A

security_group_id

String

Definition

ID of the security group to which the database belongs.

Constraints

N/A

Range

N/A

project_id

String

Definition

ID of the project to which the DB instance belongs.

Constraints

N/A

Range

N/A

db_name

String

Definition

Service name.

Constraints

  • This parameter is mandatory when the source database is an Oracle database.
  • The value can contain a maximum of 128 characters and cannot contain the following special characters: !<>'&"\

Range

N/A

db_password

String

Definition

Database password.

Constraints

N/A

Range

N/A

db_port

Integer

Definition

Database port.

Constraints

N/A

Range

An integer ranging from 1 to 65535

db_user

String

Definition

Database user.

Constraints

N/A

Range

N/A

inst_name

String

Definition

RDS instance name.

Constraints

N/A

Range

N/A

ip

String

Definition

Database IP address.

Constraints

N/A

Range

N/A

mongo_ha_mode

String

Definition

Mongo HA mode.

Constraints

N/A

Range

N/A

safe_mode

Integer

Definition

Running mode of an MRS cluster.

Constraints

N/A

Range

  • 0: Normal cluster
  • 1: Security cluster

ssl_cert_password

String

Definition

SSL certificate password. The certificate file name extension is .p12.

Constraints

N/A

Range

N/A

ssl_cert_check_sum

String

Definition

The checksum value of the SSL certificate, which is used for backend verification. This parameter is mandatory for secure connection to the source database.

Constraints

N/A

Range

N/A

ssl_cert_key

String

Definition

SSL certificate content, which is encrypted using Base64.

Constraints

N/A

Range

N/A

ssl_cert_name

String

Definition

SSL certificate name.

Constraints

N/A

Range

N/A

ssl_link

Boolean

Definition

Whether SSL is enabled.

Constraints

N/A

Range

N/A

topic

String

Definition

Kafka topic name.

Constraints

N/A

Range

N/A

cluster_mode

String

Definition

For MongoDB 4.0 or later, if the cluster instance cannot obtain the IP address of the shard node, set cluster_mode in source_endpoint to Sharding4.0+.

Constraints

N/A

Range

Sharding4.0+

kafka_security_config

Object

Definition

This parameter is only for Kafka security authentication.

For details, see Table 8.
Table 8 Data structure description of field kafka_security_config

Parameter

Type

Description

type

String

Definition

Security protocol. This parameter is mandatory for security authentication. The corresponding field for Kafka is security.protocol.

Constraints

N/A

Range

  • PLAINTEXT: No security authentication mode is available. You only need to enter an IP address and a port number.
  • SASL_PLAINTEXT: The SASL mechanism is used to connect to Kafka, and you need to configure SASL parameters.
  • SSL: The SSL encryption is used to connect to Kafka, and you need to configure SSL parameters.
  • SASL_SSL: The SASL and SSL encryption authentication modes are used. You need to configure SSL and SASL parameters.

trust_store_key_name

String

Definition

Certificate name. This parameter is mandatory when the security protocol is set to SSL or SASL_SSL.

Constraints

N/A

Range

N/A

trust_store_key

String

Definition

Value of the security certificate after Base64 transcoding. This parameter is mandatory when the security protocol is set to SSL or SASL_SSL.

Constraints

N/A

Range

N/A

trust_store_password

String

Definition

Certificate password. This parameter is mandatory when a password is set for the certificate.

Constraints

N/A

Range

N/A

endpoint_algorithm

String

Definition

Host name endpoint identification algorithm, which specifies the endpoint identification algorithm for verifying the server host name using the server certificate. If this parameter is left blank, host name verification is disabled. The corresponding field for Kafka is ssl.endpoint.identification.algorithm.

Constraints

N/A

Range

N/A

sasl_mechanism

String

Definition

SASL mechanism used for client connection. The corresponding Kafka field is sasl.mechanism.

Constraints

N/A

Range

  • GSSAPI
  • PLAIN
  • SCRAM-SHA-256
  • SCRAM-SHA-512

delegation_tokens

Boolean

Definition

Whether to use token authentication. This parameter is valid only when the security protocol is set to SASL_SSL or SASL_PLAINTEXT and the SASL mechanism is set to SCRAM-SHA-256 or SCRAM-SHA-512.

Constraints

N/A

Range

N/A

enable_key_store

Boolean

Definition

Whether to enable two-way SSL authentication.

Constraints

N/A

Range

N/A

key_store_key

String

Definition

Keystore certificate. This parameter is mandatory when two-way SSL authentication is enabled.

Constraints

N/A

Range

N/A

key_store_key_name

String

Definition

Keystore certificate name. This parameter is mandatory when two-way SSL authentication is enabled.

Constraints

N/A

Range

N/A

key_store_password

String

Definition

Keystore certificate password. This parameter is mandatory when a password is set for the certificate. The corresponding field for Kafka is ssl.keystore.password.

Constraints

N/A

Range

N/A

set_private_key_password

Boolean

Definition

Whether to set the keystore private key password. The default value is false.

Constraints

N/A

Range

N/A

key_password

String

Definition

Keystore private key password. This parameter is mandatory when two-way SSL authentication is enabled and set_private_key_password is set to true. The corresponding field for Kafka is ssl.key.password.

Constraints

N/A

Range

N/A
Table 9 Data structure description of field inst_info

Parameter

Type

Description

engine_type

String

Definition

Engine type of a 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.

inst_type

String

Definition

Instance type.

Constraints

N/A

Range

  • common
  • high
  • ultrahigh

ip

String

Definition

Private IP address of the replication instance.

Constraints

N/A

Range

N/A

public_ip

String

Definition

EIP of the replication instance.

Constraints

N/A

Range

N/A

start_time

String

Definition

Scheduled start time of a replication instance task.

Constraints

N/A

Range

N/A

status

String

Definition

Replication instance status.

Constraints

N/A

Range

  • active
  • deleted

volume_size

Integer

Definition

Storage space of a replication instance.

Constraints

N/A

Range

N/A
Table 10 Data structure description of field speed_limit

Parameter

Type

Description

begin

String

Definition

Start time of flow control.

Constraints

N/A

Range

N/A

end

String

Definition

End time of flow control.

Constraints

N/A

Range

N/A

is_utc

Boolean

Definition

Whether the UTC time is used.

Constraints

N/A

Range

N/A

speed

String

Definition

Flow control

Constraints

N/A

Range

N/A
Table 11 Data structure description of field target_root_db

Parameter

Type

Description

db_name

String

Definition

Database name.

Constraints

N/A

Range

N/A

db_encoding

String

Definition

Encoding format

Constraints

N/A

Range

N/A
Table 12 Data structure description of field alarm_notify

Parameter

Type

Description

subscriptions

Array of objects

Definition

SMN information.

For details, see Table 13.

topic_name

String

Definition

Topic name.

Constraints

N/A

Range

N/A

delay_time

Long

Definition

Subscription delay.

Constraints

N/A

Range

N/A

rto_delay

Long

Definition

RTO delay.

Constraints

N/A

Range

N/A

rpo_delay

Long

Definition

RPO delay.

Constraints

N/A

Range

N/A

alarm_to_user

Boolean

Definition

Whether to notify users of alarms.

Constraints

N/A

Range

  • true: Users are notified.
  • false: Users are not notified.
Table 13 Data structure description of field subscriptions

Parameter

Type

Description

endpoints

Array of strings

Definition

SMS or email list.

Constraints

N/A

Range

N/A

protocol

String

Definition

Receiving method.

Constraints

N/A

Range

  • sms: SMS message
  • email: email
Table 14 Data structure description of field period_order

Parameter

Type

Description

status

String

Definition

Order status.

Constraints

N/A

Range

  • INITIALIZATION: The order is initialized.
  • AWAITING_AUDIT: The order is to be reviewed.
  • AWAITING_REFUND: The order is to be refunded.
  • PROCESSING: The order is being processed.
  • CANCELED: The order is canceled.
  • COMPLETED: The order is completed.
  • AWAITING_PAID: The order is to be paid.
  • AWAITING_APPROVE: The order is to be approved.
  • UNORDERED: The order is not placed.
  • FROZEN_CAN_RENEW: The order is frozen and can be renewed.
  • FROZEN_CAN_UNSUBSCRIBE: The order is frozen and can be unsubscribed.
  • FROZEN_CAN_RENEW_FREE: The order is frozen and can be renewed or stopped.
  • FROZEN_CAN_FREE: The order is frozen and can be stopped.
  • LOCK_RESOURCE: The resource is locked.

order_id

String

Definition

Order ID.

Constraints

N/A

Range

N/A

charging_mode

Integer

Definition

Billing mode.

Constraints

N/A

Range

  • 0: indicates the monthly/yearly billing.
  • 1: indicates the pay-per-use billing.

period_type

Integer

Definition

Subscription period type.

Constraints

N/A

Range

  • 2: indicates that the service is subscribed by month.
  • 3: indicates that the service is subscribed by year.

period_num

Integer

Definition

Number of subscription periods.

Constraints

N/A

Range

  • If period_type is set to 2 (month), the value ranges from 1 to 9.
  • If period_type is set to 3 (year), the value ranges from 1 to 3.

is_auto_renew

Integer

Definition

Whether auto renewal is enabled.

Constraints

N/A

Range

  • 0: indicates that auto renewal is disabled.
  • 1: indicates that auto renewal is enabled.

eff_time

String

Definition

Time when the resource takes effect (time when the resource is created). The value is UTC time in yyyy-MM-ddTHH:mm:ssZ (2016-06-28T00:00:00Z) format.

Constraints

N/A

Range

N/A

exp_time

String

Definition

Time when the resource expires. If the resource is renewed, it indicates the expiration time after the renewal. The value is UTC time in yyyy-MM-ddTHH:mm:ssZ (2016-03-28T00:00:00Z) format.

Constraints

N/A

Range

N/A
Table 15 Data structure description of field object_infos

Parameter

Type

Description

id

String

Definition

When type is set to database, this parameter indicates the database name. If type is set to table or view, set the field value by referring to the example.

Constraints

N/A

Range

N/A

parent_id

String

Definition

When type is set to table or view, this parameter indicates the database name.

Constraints

N/A

Range

N/A

type

String

Definition

Type.

Constraints

N/A

Range

  • table: table name
  • function: function
  • database: schema
  • procedure: stored procedure

name

String

Definition

Database object name, including the database name, table name, and view name.

Constraints

N/A

Range

N/A

alias_name

String

Definition

Alias, which is the new mapped name.

Constraints

N/A

Range

N/A
Table 16 Data structure description of field data_transformation

Parameter

Type

Description

total_count

Long

Definition

Total number of data filtering criteria.

Constraints

N/A

Range

N/A

filter_conditions

Array of objects

Definition

Data filtering configuration information.

Constraints: A maximum of 10,000 data filtering criteria can be returned.

For details, see Table 17.
Table 17 Data structure description of field filter_conditions

Parameter

Type

Description

transformation_info

Object

Definition

Data processing configuration for common row filtering.

For details, see Table 19.

config_transformation

Object

Definition

Advanced configuration information for row filtering.

For details, see Table 20.

data_transformation_object_infos

Array of objects

Definition

Data filtering object information.

For details, see Table 18.
Table 18 Data structure description of field data_transformation_object_infos

Parameter

Mandatory

Type

Description

id

No

String

Definition

Database object, database table name, and processing type. For example, the format is db1-*-*-tb1-*-*---conditionFilter--.

Constraints

N/A

Range

N/A

data_transformation_type

No

String

Definition

Value of the data processing filtering rule or configuration rule.

Constraints

N/A

Range

  • contentConditionalFilter: A processing rule value is generated.
  • configConditionalFilter: A configuration rule value is generated.

schema_name

No

String

Definition

Name of the schema for data processing.

Constraints

N/A

Range

N/A

table_name

No

String

Definition

Name of the table for data processing.

Constraints

N/A

Range

N/A
Table 19 Data structure description of field transformation_info

Parameter

Mandatory

Type

Description

transformation_type

Yes

String

Definition

Value of the data processing filtering rule or configuration rule.

Constraints

N/A

Range

  • contentConditionalFilter: A processing rule value is generated.
  • configConditionalFilter

value

Yes

String

Definition

Filter criteria. The processing rule value is a SQL statement, and the configuration rule value is config. The value contains a maximum of 256 characters.

Constraints

N/A

Range

N/A
Table 20 Data structure description of field config_transformation

Parameter

Mandatory

Type

Description

db_table_name

Yes

String

Definition

Database-name.Table-name, for example, lxl_test1.test_1, where lxl_test1 is the database name and test_1 is the table name.

Constraints

N/A

Range

N/A

db_name

Yes

String

Definition

Database name. The value contains a maximum of 256 characters.

Constraints

N/A

Range

N/A

table_name

Yes

String

Definition

Table name. The value contains a maximum of 256 characters.

Constraints

N/A

Range

N/A

col_names

Yes

String

Definition

Column name. The value contains a maximum of 256 characters.

Constraints

N/A

Range

N/A

prim_key_or_index

Yes

String

Definition

Primary key or unique index. The value contains a maximum of 256 characters.

Constraints

N/A

Range

N/A

indexs

Yes

String

Definition

Index that requires optimization. The value contains a maximum of 256 characters.

Constraints

N/A

Range

N/A

values

Yes

String

Definition

Filtering criteria. The value contains a maximum of 256 characters.

Constraints

N/A

Range

N/A
Table 21 Data structure description of field tags

Parameter

Mandatory

Type

Description

key

Yes

String

Definition

Tag key.

Constraints

N/A

Range

  • "key1" : "value1"
  • "key2" : "value2"

value

Yes

String

Definition

Tag value.

Constraints

N/A

Range

N/A
Table 22 Data structure description of field public_ip_list

Parameter

Type

Description

id

String

Definition

ID of a specified EIP.

Constraints

N/A

Range

N/A

public_ip

String

Definition

EIP.

Constraints

N/A

Range

N/A

type

String

Definition

Type of the task with the EIP bound.

Constraints

  • In a primary/standby task, master indicates the primary task, and slave indicates the standby task.
  • In other cases, the value is fixed to master.

Range

  • master
  • slave
Table 23 Data structure description of field children

Parameter

Type

Description

id

String

Definition

Subtask ID.

Constraints

N/A

Range

N/A

name

String

Definition

Subtask name.

Constraints

N/A

Range

N/A

Example Request

Request for querying task details:

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-detail

{
  "jobs" : [ "24834eb6-be30-464e-a299-f7aa730jb101", "140b5236-88ad-43c8-811c-1268453jb101" ],
  "page_req" : {
    "cur_page" : 1,
    "per_page" : 10
  }
}

Example Response

Status code: 200

OK

{
  "count" : 2,
  "results" : [ {
    "id" : "24834eb6-be30-464e-a299-f7aa730jb101",
    "name" : "DRS-3999-lws",
    "status" : "STARTJOBING",
    "description" : "",
    "create_time" : "1608519469412",
    "task_type" : "FULL_INCR_TRANS",
    "source_endpoint" : {
      "ip" : "172.22.74.56",
      "region" : "cn-xianhz-1",
      "db_type" : "mysql",
      "db_port" : 3306,
      "ssl_link" : false,
      "project_id" : "054ba152d480d55b2f5dc0069e7ddef0",
      "db_user" : "root"
    },
    "target_endpoint" : {
      "ip" : "172.21.176.219",
      "region" : "cn-xianhz-1",
      "db_type" : "mysql",
      "db_port" : 3306,
      "ssl_link" : false,
      "inst_id" : "3ef57dbcc8db478a9e346d26ef2575bfin01",
      "project_id" : "054ba152d480d55b2f5dc0069e7ddef0",
      "inst_name" : "rds-lws-target",
      "db_user" : "root",
      "vpc_id" : "0ff8df7b-f0e9-4b16-ac16-1db3dacb69e4",
      "subnet_id" : "f857d371-2f03-4622-85f6-2b7d42d0d82c"
    },
    "inst_info" : {
      "ip" : "172.16.213.101",
      "inst_type" : "high",
      "engine_type" : "mysql",
      "volume_size" : 100,
      "public_ip" : "******",
      "start_time" : "0"
    },
    "actual_start_time" : "1608520069393",
    "update_time" : "1608520068979",
    "job_direction" : "up",
    "db_use_type" : "migration",
    "need_restart" : false,
    "is_target_readonly" : true,
    "speed_limit" : [ ],
    "schema_type" : "Tungsten",
    "object_switch" : true,
    "replace_definer" : true,
    "migrate_user" : false,
    "az_code" : "az2xahz",
    "vpc_id" : "0ff8df7b-f0e9-4b16-ac16-1db3dacb69e4",
    "subnet_id" : "f857d371-2f03-4622-85f6-2b7d42d0d82c",
    "security_group_id" : "d90c971b-4b9d-402c-9c59-5c239389b8dd",
    "support_ip_v6" : false,
    "original_job_direction": "up",
    "is_open_fast_clean": true,
    "object_infos":[{
      "id":"test",
      "type":"database",
      "name":"test",
      "select":"true"
      },{
      "id":"test-*-*-table01",
      "type":"table",
      "name":"table01",
      "select":"true",
      "parent_id":"test"
      }]
  }, {
    "id" : "140b5236-88ad-43c8-811c-1268453jb101",
    "name" : "DRS-0042-linxiaolu",
    "status" : "CONFIGURATION",
    "description" : "",
    "create_time" : "1608366204171",
    "task_type" : "FULL_INCR_TRANS",
    "source_endpoint" : {
      "ip" : "192.168.0.27",
      "region" : "cn-xianhz-1",
      "db_type" : "mysql",
      "db_port" : 3306,
      "ssl_link" : false,
      "project_id" : "054ba152d480d55b2f5dc0069e7ddef0",
      "db_user" : "root"
    },
    "target_endpoint" : {
      "ip" : "192.168.0.131",
      "region" : "cn-xianhz-1",
      "db_type" : "mysql",
      "db_port" : 3306,
      "ssl_link" : false,
      "inst_id" : "e05a3679efe241d8b5dee80b17c1a863in01",
      "project_id" : "054ba152d480d55b2f5dc0069e7ddef0",
      "inst_name" : "rds-1417-lxl",
      "db_user" : "root",
      "vpc_id" : "65f0391c-0582-44a6-aa50-248f97ed82e1",
      "subnet_id" : "352ad828-3467-4f03-987a-c55a5a9dd417"
    },
    "inst_info" : {
      "ip" : "192.168.0.229",
      "status" : "ACTIVE",
      "inst_type" : "high",
      "engine_type" : "mysql",
      "volume_size" : 100,
      "public_ip" : "10.154.219.72",
      "start_time" : "0"
    },
    "actual_start_time" : "1608369232412",
    "full_transfer_complete_time" : "1608369510202",
    "update_time" : "1608517066434",
    "job_direction" : "up",
    "db_use_type" : "migration",
    "need_restart" : false,
    "is_target_readonly" : true,
    "speed_limit" : [ ],
    "schema_type" : "Tungsten",
    "object_switch" : false,
    "replace_definer" : true,
    "migrate_user" : false,
    "tags": [{
       "key1" : "value1",
       "key2" : "value2"
     }],
    "az_code" : "az2xahz",
    "vpc_id" : "65f0391c-0582-44a6-aa50-248f97ed82e1",
    "subnet_id" : "352ad828-3467-4f03-987a-c55a5a9dd417",
    "security_group_id" : "d90c971b-4b9d-402c-9c59-5c239389b8dd",
    "support_ip_v6" : false,
    "original_job_direction": "up",
    "object_infos":[{
      "id":"test2",
      "type":"database",
      "name":"test2",
      "select":"true"
      },{
      "id":"test2-*-*-table02",
      "type":"table",
      "name":"table02",
      "select":"true",
      "parent_id":"test2"
      }]
  } ],
    "data_transformation": {
      "total_count": 2,
        "filter_conditions": [
          {
            "data_transformation_object_infos": [
              {
                "id": "test02-*-*-table02-*-*---conditionFilter--",
                  "db_name": "test02",
                  "table_name": "table02",
                  "data_transformation_type": "contentConditionalFilter"
               }
             ],
             "transformation_info": {
               "value": "id1<1",
                 "transformation_type": "contentConditionalFilter"
             }
           },
           {
             "data_transformation_object_infos": [
               {
                 "id": "test02-*-*-table01-*-*---configConditionFilter--",
                 "db_name": "test02",
                 "table_name": "test01",
                 "data_transformation_type": "configConditionalFilter"
                }
              ],
              "transformation_info": {
                "value": "config",
                "transformation_type": "configConditionalFilter"
              },
              "config_transformation": {
                "indexs": "id",
                "values": "id <= 6",
                "db_table_name": "test02.table01",
                "db_name": "test02",
                "table_name": "table01",
                "col_names": "id",
                "prim_key_or_index": "id"
               }
            }
         ]
     }
}

Status Code

Status Code

Description

200

OK

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Public API Management