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

Querying Task Details

Function

This API is used to query task details.

Constraints

  • This API is available only for migration and synchronization from MySQL to MySQL, migration from Redis to GeminiDB Redis, migration from Redis Cluster to GeminiDB Redis, and synchronization from Oracle to GaussDB Distributed.
  • This API can be used only in certain regions. For details, see Endpoints.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v5/{project_id}/jobs/{job_id}

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

job_id

Yes

String

Definition

Task ID, which uniquely identifies a data replication task and serves as the identifier for operations such as query, modification, and deletion.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Definition

Task details type, which specifies the type of task details to be queried.

Constraints

N/A

Range

  • detail: basic task information.
  • network: connection testing result, which must be used together with the query_id parameter.
  • precheck: pre-check result, which must be used together with the query_id parameter.
  • progress: task progress information.
  • log: task log information. Pagination query parameters offset and limit are supported.
  • compare: comparison task.
  • file: object import information.
  • is_writable: result of disabling read-only for the destination database.
  • cloud_connection: the connectivity test of workload replay from other clouds, which must be used together with the query_id parameter.
  • diagnosis: quick diagnosis query. This parameter must be used together with query_id.
  • diagnosis_history: quick diagnosis history query.
  • repair_progress: data repair progress. This parameter must be used together with query_id.
  • repair_detail: data repair details. This parameter must be used together with query_id.
  • repair_export_status: data repair SQL export status. This parameter must be used together with compare_task_id.

Default Value

N/A

query_id

No

String

Definition

Query ID used for querying task details. For task details of some types, you need to use the query_id returned by the request that triggered the operation to query the operation results.

Constraints

N/A

Range

N/A

Default Value

N/A

offset

No

Integer

Definition

Offset, which is used for pagination query. The records after this offset will be queried.

Constraints

Pagination query is supported for task details of some types. This parameter can be specified to control pagination query.

Range

N/A

Default Value

N/A

limit

No

Integer

Definition

Maximum number of records that can be returned. This parameter is used to specify the number of records returned on each page during pagination query.

Constraints

Pagination query is supported for task details of some types.

Range

N/A

Default Value

N/A

compare_type

No

String

Definition

Type of a comparison task. This parameter is mandatory when type is set to compare.

Constraints

This parameter is mandatory when type is set to compare.

Range

  • object_compare: object-level comparison.
  • line_compare: row comparison.
  • content_compare: value comparison.
  • data_compare: data-level comparison.

Default Value

N/A

query_type

No

String

Definition

Comparison task query.

Constraints

This parameter is mandatory when type is set to compare.

Range

  • overview: comparison task overview.
  • list: list of data comparison tasks.
  • detail: comparison details.
  • diff: inconsistency details.

Default Value

N/A

object_type

No

String

Definition

Type of comparison details.

Constraints

This parameter is mandatory when object-level comparison is selected.

Range

  • DB: database-level comparison details.
  • TABLE: table-level comparison details.
  • INDEX: index comparison details.

Default Value

N/A

compare_task_id

No

String

Definition

Comparison task ID, which is used to specify the comparison task to be queried.

Constraints

N/A

Range

N/A

Default Value

N/A

source_db_name

No

String

Definition

Name of the source database for data comparison, which is used to filter comparison results by source database.

Constraints

N/A

Range

N/A

Default Value

N/A

target_db_name

No

String

Definition

Name of the destination database for data comparison, which is used to filter comparison results by destination database.

Constraints

N/A

Range

N/A

Default Value

N/A

compare_detail_type

No

String

Definition

Comparison result type, which is used to filter records that have been compared or cannot be compared.

Constraints

N/A

Range

  • compare: The comparison is complete.
  • uncompare: The comparison cannot be performed.

Default Value

N/A

log_level

No

String

Definition

Log level, which is used to filter query results by log severity.

Constraints

N/A

Range

  • Info: information level.
  • Warn: warning level.
  • Error: error level.

Default Value

N/A

Request Parameters

Table 3 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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job

Object

Definition

Response body for querying details about a single task, which includes the complete information about the task.

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

Parameter

Type

Description

id

String

Definition

Task ID, which uniquely identifies a data replication task.

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 failed 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 failed to be started.
  • PAUSING: The task is paused.
  • FULL_TRANSFER_STARTED: Full migration or synchronization starts. For DR scenarios, initialization is in progress.
  • FULL_TRANSFER_FAILED: Full migration or synchronization failed. For DR scenarios, initialization failed.
  • FULL_TRANSFER_COMPLETE: Full migration or synchronization is complete. For DR scenarios, initialization is complete.
  • INCRE_TRANSFER_STARTED: Incremental migration or synchronization starts. For DR scenarios, disaster recovery is in progress.
  • INCRE_TRANSFER_FAILED: Incremental migration or synchronization failed. For DR scenarios, a DR exception occurs.
  • RELEASE_RESOURCE_STARTED: The task is being stopped.
  • RELEASE_RESOURCE_FAILED: The task failed to be stopped.
  • RELEASE_RESOURCE_COMPLETE: The task is stopped.
  • REBUILD_NODE_STARTED: The task is being recovered.
  • REBUILD_NODE_FAILED: The task failed to be recovered.
  • CHANGE_JOB_STARTED: The task is being changed.
  • CHANGE_JOB_FAILED: The task failed 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 failed 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 failed.

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

total_count

Integer

Definition

Total number of records in the list, which is irrelevant to pagination. This parameter indicates the total number of records that meet the query criteria, which is used for pagination calculation.

Constraints

N/A

Range

N/A

master_job_id

String

Definition

ID of the primary task in a multi-task scenario, which is used to identify the primary task in the many-to-one synchronization scenario.

Constraints

N/A

Range

N/A

base_info

Object

Definition

Basic task information body. For details, see Table 6.

source_endpoint

Array of objects

Definition

Information body of the source database. For details, see Table 8.

target_endpoint

Array of objects

Definition

Information body of the destination database. For details, see Table 8.

alarm_notify

Object

Definition

Information body for setting task exception notification. If this parameter is enabled, the system sends a notification to a specified SMN topic when the task is abnormal.

For details, see Table 15.

speed_limit

Array of objects

Definition

Flow control information body.

  • If you enable flow control, you can customize the maximum migration speed.
  • If you disable flow control, the migration speed is not limited and the outbound bandwidth of the source database is maximally used,

which causes read consumption on the source database accordingly. For example, if the outbound bandwidth of the source database is 100 MB/s and 80% bandwidth is used, the I/O consumption on the source database is 80 MB/s.

For details, see Table 16.

user_migration

Object

Definition

User migration information body. For details, see Table 17.

policy_config

Object

Definition

Policy information body. This parameter is used to configure migration and synchronization policies, including the conflict policy, DROP Database filtering, and object synchronization scope.

For details, see Table 20.

db_param

Object

Definition

Database parameter information body. For details, see Table 21.

tuning_params

Object

Definition

Advanced setting information body. For details, see Table 23.

period_order

Object

Definition

Yearly/Monthly information body.

For details, see Table 25.

node_info

Object

Definition

Information body of the DRS instance.

For details, see Table 26.

logs

Array of objects

Definition

Information body of a log query result.

For details, see Table 30.

network_results

Array of objects

Definition

Information body of a connection testing result.

For details, see Table 31.

precheck_result

Object

Definition

Pre-check result information body.

For details, see Table 32.

progress_info

Object

Definition

Task progress information body.

For details, see Table 35.

migration_object_progress_info

Object

Definition

Progress information body of objects being migrated.

For details, see Table 37.

metrics

Object

Definition

Node metrics.

For details, see Table 39.

compare_result

Object

Definition

Task comparison result.

For details, see Table 40.

support_import_file_resp

Object

Definition

file: object import information.

For details, see Table 51.

instance_features

Map<String,String>

Definition

Task functions controlled by both the switch and version, in the format of key-value pairs.

Constraints

N/A

Range

N/A

task_version

String

Definition

Task version, which identifies the version used by the current data replication task.

Constraints

N/A

Range

N/A

connection_management

Object

Definition

Connection management information. For details, see Table 52.

public_ip_list

Array of objects

Definition

Information about a specified EIP.

For details, see Table 54.

bind_public_ip_state

String

Definition

Whether an EIP is successfully bound. This parameter indicates the execution result of binding an EIP to the task.

Constraints

N/A

Range

  • SUCCESS
  • FAILED

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 55.

is_writable

String

Definition

Whether read-only is disabled for the destination database.

Constraints

N/A

Range

  • pending: Read-only is being disabled for the destination database.
  • success: Read-only is disabled for the destination database.

diagnoses

Array of objects

Definition

Quick diagnosis result.

For details, see QueryDiagnosisResult.

repair_progress_info

object

Definition

Data repair progress.

For details, see repair_progress_info.

repair_detail_info

object

Definition

Data repair details.

For details, see QueryRepairDetailResp.

repair_export_status

String

Definition

Data repair SQL export status, which indicates the export progress of the data repair SQL file.

Constraints

N/A

Range

  • INIT: The result export is in the initial status.
  • EXPORTING: The comparison result is being exported.
  • EXPORT_COMPLETE: The comparison result export is complete.
  • EXPORT_COMMON_FAILED: The comparison result export failed.

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.
Table 6 Data structure description of field base_info

Parameter

Type

Description

name

String

Definition

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

Constraints

  • The value is case-insensitive and can contain 4 to 50 characters.
  • Only letters, digits, hyphens (-), and underscores (_) are allowed.

Range

N/A

job_type

String

Definition

DRS task type, which is used to distinguish different data replication scenarios.

Constraints

N/A

Range

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

multi_write

Boolean

Definition

Whether the DR type is dual-active. This parameter specifies whether to enable bidirectional write in the DR scenario.

Constraints

  • This parameter is mandatory when job_type is set to cloudDataGuard. If the DR type is dual-active, set multi_write to true. Otherwise, set this parameter to false.
  • If job_type is set to other values, multi_write is optional.

Range

  • true: dual-active DR.
  • false: not dual-active DR.

Default Value

false

engine_type

String

Definition

Engine type of the DRS task.

Constraints

N/A

Range

  • oracle-to-gaussdbv5: real-time synchronization from Oracle to GaussDB Distributed
  • mysql-to-mysql: real-time migration and synchronization from MySQL to MySQL
  • redis-to-gaussredis: real-time migration from Redis to GeminiDB Redis
  • rediscluster-to-gaussredis: real-time migration from Redis Cluster to GeminiDB Redis

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

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.

net_type

String

Definition

Type of the network used by the task.

Constraints

The VPC network cannot be selected in the DR scenario.

Range

  • eip: public network.
  • vpc: VPC network.
  • vpn: VPN or Direct Connect.

charging_mode

String

Definition

Billing mode of the task.

Constraints

N/A

Range

  • period: yearly/monthly billing.
  • on_demand: pay-per-use billing.

Default Value

on_deman

enterprise_project_id

String

Definition

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

Constraints

  • If no value is specified, this parameter is set to null. It cannot be set to an empty string.
  • When enterprise project is enabled, this parameter can be set.

Range

N/A

Default Value

0: default enterprise project.

description

String

Definition

Task description, which is used to add supplementary information about the data replication task.

Constraints

  • The length cannot exceed 256 characters.
  • The value cannot contain the following special characters: !<>'&"\

Range

N/A

start_time

String

Definition

Scheduled start time of the task. After it is set, the task automatically starts at the specified time.

Constraints

N/A

Range

N/A

expired_days

String

Definition

Number of days after which an abnormal task automatically stops. The unit is day.

Constraints

N/A

Range

14-100

Default Value

14

tags

Array of objects

Definition

Tags, which are used to add tags to data replication tasks for categorized management.

For details, see Table 7.

Constraints

  • A maximum of 20 tags can be added.

is_open_fast_clean

Boolean

Definition

Whether to enable quick binlog clearing for RDS for MySQL or RDS for MariaDB. If this function is enabled, synchronized binlogs will be automatically cleared to release storage space.

Constraints

This parameter is available only for MySQL and MariaDB engines.

Range

  • true: Quick binlog clearing is enabled.
  • false: Quick binlog clearing is disabled.

Default Value

false
Table 7 Data structure description of field tags

Parameter

Type

Description

key

String

Definition

Tag key.

Constraints

A tag key can contain a maximum of 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Range

1–36

value

String

Definition

Tag value.

Constraints

A tag value can contain a maximum of 43 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Range

1–36
Table 8 Data structure description of fields source_endpoint and target_endpoint

Parameter

Type

Description

db_type

String

Definition

Database type, which indicates the DB engine type of the source or destination database.

Constraints

N/A

Range

  • oracle: Oracle.
  • gaussdbv5: GaussDB Distributed.
  • redis: Single-node or primary/standby Redis.
  • rediscluster: Redis Cluster.
  • gaussredis: GeminiDB Redis.

endpoint_type

String

Definition

DB instance type, which indicates the deployment mode of the database.

Constraints

N/A

Range

  • offline: on-premises database.
  • ecs: database built on Huawei Cloud ECSs.
  • cloud: Huawei cloud database.

endpoint_role

String

Definition

Role of the DB instance, which indicates whether the database is the source or destination in the data replication task.

Constraints

N/A

Range

  • so: source database.
  • ta: destination database.

endpoint

Object

Definition

Basic information body of the database.

For details, see Table 9.

cloud

Object

Definition

Region and project where a DB instance is located.

For details, see Table 10.

vpc

Object

Definition

Information about the VPC, subnet, and security group where a DB instance resides.

For details, see Table 11.

config

Object

Definition

Basic information body of database settings.

For details, see Table 12.

ssl

Object

Definition

Information body of the database SSL certificate.

For details, see Table 13.

customized_dns

Object

Definition

Custom DNS server.

For details, see Table 14.
Table 9 Data structure description of fields endpoint and source_sharding

Parameter

Type

Description

id

String

Definition

Database information ID.

Constraints

N/A

Range

N/A

endpoint_name

String

Definition

Database scenario type.

Constraints

N/A

Range

  • oracle: indicates the on-premises Oracle database.
  • ecs_oracle: indicates the Oracle database built on Huawei Cloud ECSs.
  • cloud_gaussdbv5: indicates the Huawei Cloud distributed GaussDB database.
  • mysql: indicates the MySQL database built on other clouds or on-premises MySQL database.
  • ecs_mysql: indicates the MySQL database built on Huawei Cloud ECSs.
  • cloud_mysql: indicates the Huawei Cloud RDS for MySQL database.
  • redis: On-premises Redis database.
  • ecs_redis: Redis database built on Huawei Cloud ECSs.
  • rediscluster: On-premises Redis Cluster database.
  • ecs_rediscluster: Redis Cluster database built on Huawei Cloud ECSs.
  • cloud_gaussdb_redis: Huawei Cloud GeminiDB Redis.

ip

String

Definition

Database IP address.

Constraints

  • If an on-premises MongoDB database is used, use colons (:) to separate the database IP address and port number, and use commas (,) to separate multiple values. A maximum of three IP addresses or domain names can be entered.
  • If a DDS instance is used, use colons (:) to separate the database IP address and port number, and use commas (,) to separate multiple values.
  • If the database is a Redis Cluster database, enter the IP addresses and port numbers of all shards in the source Redis Cluster database. Use colons (:) to separate a database IP address and port number. Use commas (,) to separate multiple values. You are advised to enter the IP address of the slave node of a cluster shard. Up to 32 IP addresses or domain names can be entered. Use commas (,) to separate multiple IP addresses or domain names.

Example:

  • MongoDB: 192.168.0.10:8080,192.168.0.11:8080,192.168.0.12:8080
  • DDS: 192.168.205.130:8635,192.168.250.64:8635
  • Redis Cluster: 192.168.0.1:8080,192.168.0.2:8080

Range

N/A

db_port

String

Definition

Database port.

Constraints

N/A

Range

An integer ranging from 1 to 65535

db_user

String

Definition

Database username.

Constraints

N/A

Range

N/A

db_password

String

Definition

Database password.

Constraints

N/A

Range

N/A

instance_id

String

Definition

ID of a Huawei Cloud DB instance.

Constraints

N/A

Range

N/A

instance_name

String

Definition

Name of a Huawei Cloud DB instance.

Constraints

N/A

Range

N/A

db_name

String

Definition

Database name. For example, for an Oracle database, the value is serviceName.orcl.

Constraints

N/A

Range

N/A

source_sharding

Array of objects

Definition

Information about the physical source database.

For details, see Table 9.
Table 10 Data structure description of field cloud

Parameter

Type

Description

region

String

Definition

Region ID.

Constraints

This parameter is mandatory when DB Instance Type is set to ecs (database built on Huawei Cloud ECSs) or cloud (Huawei cloud database). For details, see Regions and Endpoints. Note: If there are subprojects in a region, the region ID is a combination of the regional project ID and subproject ID, which are combined using an underscore (_).

Range

N/A

project_id

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

az_code

String

Definition

Name of the AZ where the database is located.

Constraints

N/A

Range

N/A
Table 11 Data structure description of field vpc

Parameter

Type

Description

vpc_id

String

Definition

ID of the VPC where a DB instance is located. To obtain the ID, perform the following steps: Method 1: Log in to the VPC console and view the VPC ID on the VPC details page. Method 2: Call the API for querying VPCs. For details, see Querying VPCs.

subnet_id

String

Definition

ID of the subnet where a DB instance is located. To obtain the ID, perform the following steps: Method 1: Log in to the VPC console and click the target subnet on the Subnets page to view the network ID on the displayed page. Method 2: Call the API for querying subnets. For details, see Querying Subnets.

security_group_id

String

Definition

ID of the security group where a DB instance is located. To obtain the ID, perform the following steps: Method 1: Log in to the VPC console. Choose Access Control > Security Groups in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page. Method 2: Call the API for querying security groups. For details, see Querying Security Groups.
Table 12 Data structure description of field config

Parameter

Type

Description

is_target_readonly

Boolean

Definition

Whether the destination DB instance is set to read-only.

Constraints

This parameter is available only when job_direction is set to up during MySQL migration and DR. In the DR scenario, this parameter is mandatory and set to true if the current cloud is the standby in single-active DR. If this parameter is not specified, the default value is true.

Range

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

Default Value

true

node_num

Integer

Definition

Number of nodes.

Constraints

It specifies the number of subtasks connected to the source Redis Cluster instance for data migration from Redis Cluster to GeminiDB Redis. The value ranges from 1 to 16 and cannot be greater than the number of shards in the source Redis Cluster instance. Set this parameter based on the scale of the source Redis Cluster instance. You are advised to set one subtask to connect to four shards in the source Redis Cluster instance.

Range

1-16

Default Value

0
Table 13 Data structure description of field ssl

Parameter

Type

Description

ssl_link

Boolean

Definition

Whether SSL is enabled.

Constraints

If SSL is enabled, the value of this parameter is true.

Range

  • true: SSL is enabled.
  • false: SSL is not enabled.

ssl_cert_name

String

Definition

SSL certificate name.

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_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_password

String

Definition

SSL certificate password. This parameter is mandatory if the certificate file name extension is .p12.

Constraints

N/A

Range

N/A
Table 14 Data structure description of field customized_dns

Parameter

Type

Description

is_set_dns

Boolean

Definition

Specifies whether to set your own DNS server.

Constraints

N/A

Range

N/A

set_dns_action

String

Definition

Behavior of setting your own DNS server.

Constraints

N/A

Range

  • add: Add a customized DNS server IP address.
  • keep: Retain the DNS server IP address.
  • update: Update the customized DNS server IP address. (The update takes effect when the DNS server IP address changes.)
  • recover: Restore the default DNS server IP address. (Restoration may cause domain name resolution failures. Exercise caution when performing this operation.)

dns_ip

String

Definition

DNS server IP address.

Constraints

N/A

Range

0-15
Table 15 Data structure description of field alarm_notify

Parameter

Type

Description

alarm_to_user

Boolean

Definition

Whether to notify users of alarms. This parameter specifies whether to send an alarm notification to users when the task status is abnormal.

Constraints

N/A

Range

  • true: Users are notified of alarms.
  • false: Users are not notified of alarms.

Default Value

false

topic_urn

String

Definition

SMN topic URN, which specifies the destination SMN topic to which alarm notifications are sent.

Constraints

N/A

Range

N/A

delay_time

Long

Definition

Delay threshold, in seconds.

Constraints

  • A synchronization delay indicates a time difference (in seconds) of synchronization between the source and destination databases.
  • If the delay exceeds a specified value and lasts for 6 minutes, DRS will notify specified recipients. (In the early stages of an incremental migration, there is more delay because more data is waiting to be synchronized. In this situation, no notifications will be sent.)
  • This option is available only for full+incremental tasks.

Range

1–3600

Default Value

0

rpo_delay

Long

Definition

RPO delay threshold, in seconds.

Constraints

If the RPO delay between the service database and the DRS instance exceeds a specified value and lasts for 6 minutes, DRS will notify specified recipients. (In the early stages of an incremental DR, there is more delay because more data is waiting to be synchronized. In this situation, no notifications will be sent.)

Range

1–3600

Default Value

0

rto_delay

Long

Definition

RTO delay threshold, in seconds.

Constraints

If the RTO delay between the DRS instance and the DR database exceeds a specified value and lasts for 6 minutes, DRS will notify specified recipients.

Range

1–3600

Default Value

0
Table 16 Data structure description of field speed_limit

Parameter

Type

Description

begin

String

Definition

Start time of flow control.

Constraints

It is a UTC time. The start time is an integer in hh:mm format and the minutes part is ignored. hh indicates the hour, for example, 01:00.

Range

N/A

end

String

Definition

End time.

Constraints

It is a UTC time in the format of hh:mm, for example, 15:59. The value must end with 59.

Range

N/A

speed

String

Definition

Flow control rate, in MB/s.

Constraints

N/A

Range

1–9999
Table 17 Data structure description of field user_migration

Parameter

Type

Description

is_migrate_user

Boolean

Definition

Whether to migrate users.

Constraints

N/A

Range

N/A

is_set_password

Boolean

Definition

Whether to reset a unified password.

Constraints

N/A

Range

  • true: Reset a unified password.
  • false: Do not reset a unified password. The following scenarios are supported:
  • Real-time migration: MySQL migration.

password

String

Definition

Unified password.

Constraints

This parameter is mandatory when is_set_password is set to true. The password cannot be empty.

Range

N/A

user_list

Array of objects

Definition

User list in the migration objects. The following scenarios are supported:

  • Real-time migration: MySQL-to-MySQL migration and MongoDB-to-DDS migration.

For details, see Table 18.

role_list

Array of objects

Definition

User role in the migration objects. The following scenarios are supported:

  • Real-time migration: MongoDB-to-DDS migration.

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

Parameter

Type

Description

id

String

Definition

User ID.

Constraints

N/A

Range

N/A

account

String

Definition

User.

Constraints

N/A

Range

N/A

is_set_password

Boolean

Definition

Whether to reset the user password. The following scenarios are supported:

  • Real-time migration: MySQL migration.

Constraints

N/A

Range

N/A

password

String

Definition

New password.

Constraints

This parameter is mandatory when is_set_password is set to true. The password cannot be empty.

Range

N/A
Table 19 Data structure description of field role_list

Parameter

Type

Description

role

String

Definition

Role.

Constraints

N/A

Range

N/A
Table 20 Data structure description of field policy_config

Parameter

Type

Description

filter_ddl_policy

String

Definition

DDL filtering policy, which specifies the type of DDL operations to be filtered out during incremental synchronization.

Constraints

  • Real-time migration: For MySQL migration, this parameter can be set to "", indicating that DROP DATABASE is not filtered out.
  • Real-time synchronization: For MySQL synchronization, this parameter can only be set to drop_database.

Range

drop_database: The DROP DATABASE operation is filtered out.

conflict_policy

String

Definition

Incremental conflict policy. This parameter specifies how to handle conflicts when the destination database already contains the same data. The conflict policy refers to the conflict handling policy during incremental synchronization. By default, conflicts in the full synchronization phase are ignored.

Constraints

  • Real-time migration: not supported.
  • Real-time synchronization: supported.

Range

  • ignore: Ignore the conflict. The system will ignore the conflicting data and continue the subsequent synchronization process.
  • stop: Report an error. The synchronization task will be stopped and fail. You can view the details in synchronization logs.
  • overwrite: Overwrite the existing data with the synchronized data. Conflicting data will be overwritten.

index_trans

Boolean

Definition

Object synchronization scope: whether to synchronize normal indexes.

Constraints

By default, DRS synchronizes the primary key or unique index. A normal index refers to an index other than the primary key or unique index.

Range

  • true: All indexes will be synchronized.
  • false: Only primary key or unique indexes are synchronized.

Default Value

true

ddl_trans

Boolean

Definition

Object synchronization scope: indicates whether to synchronize DDLs in the incremental phase.

Constraints

N/A

Range

  • true: DDLs are synchronized in the incremental phase.
  • false: DDLs are not synchronized in the incremental phase.

Default Value

true

data_sync_topology_type

String

Definition

Data synchronization topology.

Constraints

Data synchronization supports multiple synchronization topologies. You can plan your synchronization instances based on service requirements.

Range

  • one2one: one-to-one.
  • one2many: one-to-many.
  • many2one: many-to-one.

Default Value

one2one

support_ddl_info

String

Definition

DDL operations supported by incremental synchronization, which specifies the type of DDL operations that can be synchronized during incremental synchronization.

Constraints

  • In one-to-one and one-to-many scenarios, if the DDL usage of the source and destination databases must be consistent, high-risk DDLs must be synchronized.
  • In one-to-one and one-to-many scenarios, if you do not want a high-risk DDL to be performed in the destination, deselect the high-risk DDL to protect destination data. However, filtering DDL may cause synchronization to fail, for example, column deletion.
  • In many-to-one data synchronization tasks, it is recommended that only the ADD COLUMN operation is synchronized, or tasks may fail or data may be inconsistent due to changes in destination tables. Typical failure scenarios are as follows:
    • Synchronizing the TRUNCATE operation clears all destination data.
    • Synchronizing the CREATE INDEX operation locks the destination table.
    • Synchronizing the RENAME operation causes other task failure because the destination table cannot be found.
    • Synchronizing the MODIFY COLUMN operation causes other task failure due to incompatible data types.

Range

  • CREATE_TABLE: Create a table.
  • ADD_COLUMN: Add a column.
  • MODIFY_COLUMN: Modify a column attribute.
  • CHANGE_COLUMN: Change a column attribute.
  • DROP_INDEX: Delete an index.
  • ADD_INDEX: Add an index.
  • CREATE_INDEX: Create an index.
  • RENAME_INDEX: Rename an index.

sync_type_policy

String

Definition

Type of data to be synchronized, which specifies the type of data to be synchronized during incremental synchronization.

Constraints

Except supportAllType, other types can be specified together, for example, tableData,tableStructure.

Range

  • supportAllType: All types.
  • tableData: Data.
  • tableStructure: Table structure.
  • constraintData: Index.

increment_read_mode

String

Definition

Incremental read mode for Oracle-to-GaussDB synchronization. This parameter specifies how incremental data is read when data is synchronized from Oracle to GaussDB.

Constraints

N/A

Range

  • logminer: LogMiner mode
  • xstream: XStream mode

dml_types

String

Definition

DML synchronization type, which specifies the type of data operations to be synchronized during incremental synchronization, including insert, update, and delete operations.

Constraints

N/A

Range

N/A

is_create_table_with_index

Boolean

Definition

Whether to create indexes along with the table structure during synchronization.

Constraints

N/A

Range

  • true: Indexes are created along with the table structure.
  • false: Indexes are not created along with the table structure.
Table 21 Data structure description of field db_param

Parameter

Type

Description

common

Array of objects

Definition

Common parameter. Only the values of destination database parameters whose comparison results are inconsistent can be changed.

For details, see Table 22.

performance

Array of objects

Definition

Performance parameter. If the comparison results are consistent, you can also change the values of destination database parameters.

For details, see Table 22.
Table 22 Data structure description of fields common and performance

Parameter

Type

Description

key

String

Definition

Database parameter name.

Constraints

N/A

Range

  • binlog_cache_size
  • binlog_stmt_cache_size
  • bulk_insert_buffer_size
  • innodb_buffer_pool_size
  • key_buffer_size
  • long_query_time
  • query_cache_type
  • read_buffer_size
  • read_rnd_buffer_size
  • sort_buffer_size
  • sync_binlog
  • innodb_buffer_pool_instances

target_value

String

Definition

Parameter value of the destination database.

Constraints

N/A

Range

N/A
Table 23 Data structure description of field tuning_params

Parameter

Type

Description

full_sync

Array of objects

Definition

Full migration tuning parameters.

For details, see Table 24.

incre_capture

Array of objects

Definition

Incremental capture tuning parameters.

For details, see Table 24.

incre_apply

Array of objects

Definition

Incremental replay tuning parameters.

For details, see Table 24.

incre_relay

Array of objects

Definition

Incremental log extraction tuning parameters.

For details, see Table 24.
Table 24 Data structure description of fields full_sync, incre_capture, incre_apply, and incre_relay

Parameter

Type

Description

param_name

String

Definition

Parameter name.

Constraints

N/A

Range

N/A

param_value

String

Definition

Parameter value.

Constraints

N/A

Range

N/A

availability

Boolean

Definition

Available or not.

Constraints

N/A

Range

N/A
Table 25 Data structure description of field period_order

Parameter

Type

Description

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.

Default Value

3

period_num

Integer

Definition

Number of subscription periods.

Constraints

This parameter depends on the value of period_type. For example:

  • When period_type is set to 2, the value 1 indicates one month.
  • When period_type is set to 3, the value 1 indicates one year.

Range

N/A

is_auto_renew

Integer

Definition

Whether auto renewal is enabled.

Constraints

N/A

Range

  • 0: indicates that auto renewal is disabled. This is the default value. You need to pay manually.
  • 1: indicates that auto renewal is enabled.
Table 26 Data structure description of field node_info

Parameter

Type

Description

spec

Object

Definition

Information body of DRS instance specifications.

For details, see Table 27.

vpc

Object

Definition

Information body of DRS instance VPC. This parameter is mandatory for self-built databases.

For details, see Table 28.

base_info

Object

Definition

Basic information about a task instance.

For details, see Table 29.
Table 27 Data structure description of field spec

Parameter

Type

Description

node_type

String

Definition

Specification code of the DRS instance, which determines the compute resource size of the replication instance.

Constraints

N/A

Range

  • micro: micro specifications.
  • small: small specifications.
  • medium: medium specifications.
  • high: large specifications.
Table 28 Data structure description of field vpc

Parameter

Type

Description

vpc_id

String

Definition

ID of the VPC where the DRS instance is located.

Constraints

N/A

Range

N/A

subnet_id

String

Definition

ID of the subnet where the DRS instance is located.

Constraints

N/A

Range

N/A

custom_node_ip

String

Definition

IP address of the DRS instance to be created. Use commas (,) to separate multiple values. Only IPv4 addresses are supported. To obtain the IP address, perform the following steps:

  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. View the subnet CIDR block and select an IP address that is not in use.
  • Method 2: Call the API for querying private IP addresses. For details, see "Querying Private IP Addresses". Select a private IP address whose device_owner is left blank. Example: 192.168.0.10,192.168.0.11

Constraints

N/A

Range

N/A

security_group_id

String

Definition

ID of the security group where the DRS instance is located.

Constraints

N/A

Range

N/A
Table 29 Data structure description of field base_info

Parameter

Type

Description

instance_type

String

Definition

DB instance type.

Constraints

N/A

Range

  • single: single-node instance.
  • ha: primary/standby instance.

arch

String

Definition

CPU architecture.

Constraints

N/A

Range

  • x86
  • arm

availability_zone

String

Definition

AZ ID.

Constraints

If the task instance is not a single-node instance, you need to specify an AZ for each node of the instance and separate the AZs with commas (,). Example:

  • If instance_type is set to single, the value is cn-north-4a.
  • If instance_type is set to ha, the value is cn-north-4a,cn-north-4b.

Range

N/A

status

String

Definition

Status.

Constraints

N/A

Range

  • CREATING: The task is being created.
  • CREATE_FAILED: The task failed to be created.
  • CONFIGURATION: The task is being configured.
  • WAITING_FOR_START: The task is waiting to be started.
  • RELEASE_RESOURCE_COMPLETE: The task is stopped.
  • DELETED: The task is deleted.
  • INCRE_TRANSFER_STARTED: The incremental migration is in progress.
  • INCRE_TRANSFER_FAILED: The incremental migration failed.
  • FULL_TRANSFER_STARTED: The full migration is in progress.
  • FULL_TRANSFER_COMPLETE: The full migration is complete.
  • PAUSING: The task is paused.
  • FULL_TRANSFER_FAILED: The full migration failed.

role

String

Definition

Primary/Standby role of a task.

Constraints

N/A

Range

N/A
Table 30 Data structure description of field logs

Parameter

Type

Description

level

String

Definition

Log level.

Constraints

N/A

Range

N/A

message

String

Definition

Log information.

Constraints

N/A

Range

N/A

create_time

String

Definition

Log time.

Constraints

N/A

Range

N/A
Table 31 Data structure description of field network_results

Parameter

Type

Description

ip

String

Definition

IP address for connection testing.

Constraints

N/A

Range

N/A

success

Boolean

Definition

Whether the connection testing is successful.

Constraints

N/A

Range

N/A

result

String

Definition

Connection testing result.

Constraints

N/A

Range

N/A

status

String

Definition

Whether the connection testing is successful.

Constraints

N/A

Range

  • success: The connection testing is successful.
  • failed: The connection testing fails.

error_code

String

Definition

Error code of the connection testing failure.

Constraints

N/A

Range

N/A

error_msg

String

Definition

Error message of the connection testing failure.

Constraints

N/A

Range

N/A
Table 32 Data structure description of field precheck_result

Parameter

Type

Description

result

Boolean

Definition

Whether the pre-check items are passed.

Constraints

N/A

Range

N/A

process

String

Definition

Pre-check progress, in percentage.

Constraints

N/A

Range

N/A

total_passed_rate

String

Definition

Percentage of passed pre-checks.

Constraints

N/A

Range

N/A

rds_instance_id

String

Definition

DB instance ID.

Constraints

N/A

Range

N/A

job_direction

String

Definition

Migration direction.

Constraints

N/A

Range

N/A

precheck_results

Array of objects

Definition

Pre-check results.

For details, see Table 33.
Table 33 Data structure description of field precheck_results

Parameter

Type

Description

item

String

Definition

Check item.

Constraints

N/A

Range

N/A

result

String

Definition

Check results.

Constraints

N/A

Range

  • PASSED: The check is passed.
  • ALARM: There are check items to be confirmed.
  • FAILED: The check failed.

failed_reason

String

Definition

Failure cause.

Constraints

N/A

Range

N/A

data

String

Definition

Failure data.

Constraints

N/A

Range

N/A

raw_error_msg

String

Definition

Failure details.

Constraints

N/A

Range

N/A

group

String

Definition

Check item group.

Constraints

N/A

Range

N/A

is_support_skip

Boolean

Definition

Whether to skip the check.

Constraints

N/A

Range

N/A

is_skipped

Boolean

Definition

Skipped.

Constraints

N/A

Range

N/A

failed_sub_jobs

Array of objects

Definition

Details about a failed subtask.

For details, see Table 34.
Table 34 Data structure description of field failed_sub_jobs

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

check_result

String

Definition

Subtask check result.

Constraints

N/A

Range

N/A
Table 35 Data structure description of field progress_info

Parameter

Type

Description

progress

String

Definition

Migration comparison progress in percentage.

Constraints

N/A

Range

N/A

incr_trans_delay

String

Definition

Incremental migration delay (unit: s).

Constraints

N/A

Range

N/A

incr_trans_delay_millis

String

Definition

Incremental migration delay (unit: ms).

Constraints

N/A

Range

N/A

task_mode

String

Definition

Migration type.

Constraints

N/A

Range

N/A

transfer_status

String

Definition

Migration status.

Constraints

N/A

Range

  • CREATING: The task is being created.
  • CREATE_FAILED: The task failed 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 failed to be started.
  • PAUSING: The task is paused.
  • FULL_TRANSFER_STARTED: Full migration or synchronization starts. For DR scenarios, initialization is in progress.
  • FULL_TRANSFER_FAILED: Full migration or synchronization failed. For DR scenarios, initialization failed.
  • FULL_TRANSFER_COMPLETE: Full migration or synchronization is complete. For DR scenarios, initialization is complete.
  • INCRE_TRANSFER_STARTED: Incremental migration or synchronization starts. For DR scenarios, disaster recovery is in progress.
  • INCRE_TRANSFER_FAILED: Incremental migration or synchronization failed. For DR scenarios, a DR exception occurs.
  • RELEASE_RESOURCE_STARTED: The task is being stopped.
  • RELEASE_RESOURCE_FAILED: The task failed to be stopped.
  • RELEASE_RESOURCE_COMPLETE: The task is stopped.
  • REBUILD_NODE_STARTED: The task is being recovered.
  • REBUILD_NODE_FAILED: The task failed to be recovered.
  • CHANGE_JOB_STARTED: The task is being changed.
  • CHANGE_JOB_FAILED: The task failed 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 failed 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 failed.

process_time

String

Definition

Migration time.

Constraints

N/A

Range

N/A

remaining_time

String

Definition

Estimated remaining time.

Constraints

N/A

Range

N/A

progress_map

Map<String>

Definition

Full migration progress details.

For details, see Table 36.
Table 36 Data structure description of field progress_map

Parameter

Type

Description

completed

String

Definition

Progress.

Constraints

N/A

Range

N/A

remaining_time

String

Definition

Estimated remaining time.

Constraints

N/A

Range

N/A
Table 37 Data structure description of field migration_object_progress_info

Parameter

Type

Description

migration_object_overview

Array of objects

Definition

Overview details.

For details, see Table 38.

create_time

String

Definition

Data generation time.

Constraints

N/A

Range

N/A

full_start_time

String

Definition

Start time of full migration.

Constraints

N/A

Range

N/A

full_complete_time

String

Definition

End time of full migration.

Constraints

N/A

Range

N/A

incr_start_time

String

Definition

Start time of incremental migration.

Constraints

N/A

Range

N/A

end_time

String

Definition

End time.

Constraints

N/A

Range

N/A
Table 38 Data structure description of field migration_object_overview

Parameter

Type

Description

type

String

Definition

Type.

Constraints

N/A

Range

  • DATABASE
  • SCHEMA
  • PACKAGE
  • TABLE
  • COLUMN
  • VIEW
  • FUNCTION
  • PROCEDURE
  • ROUTINE
  • TRIGGER
  • INDEX
  • TABLE_INDEX: common index, aggregated based on tables
  • TABLE_RENAME_OR_COPY
  • TABLE_STRUCTURE
  • EVENT
  • SYNONYM: specific to SQL Server
  • TYPE: user-defined type, specific to SQL Server
  • RULE: specific to SQL Server
  • DEFAULT: specific to SQL Server
  • PLAN_GUIDE: execution plan, specific to SQL Server
  • FILE_GROUP: specific to SQL Server
  • PARTITION_FUNCTION: specific to SQL Server
  • SHARD_KEY: specific to MongoDB
  • VALIDATOR: specific to MongoDB
  • SEQUENCE
  • MATVIEW: materialized view
  • PARTITION_SCHEME: specific to SQL Server
  • ACCOUNT
  • EXTENSION: specific to PostgreSQL
  • AGGREGATE: aggregate function, specific to PostgreSQL
  • MATERIALIZED_VIEW: specific to PostgreSQL
  • TEXT_SEARCH_DICTIONARY: specific to PostgreSQL
  • CONVERSION: specific to PostgreSQL
  • DATA_TYPE: specific to PostgreSQL
  • TEXT_SEARCH_CONFIGURATION: specific to PostgreSQL
  • STATISTICS_EXTENSION: specific to PostgreSQL
  • MEMBERSHIP: specific to PostgreSQL
  • EVENT_TRIGGER: specific to PostgreSQL
  • COLLATION: specific to PostgreSQL
  • TEXT_SEARCH_PARSER: specific to PostgreSQL
  • PRIVILEGES: specific to PostgreSQL
  • FOREIGN_KEY: specific to PostgreSQL
  • ROLE

src_count

String

Definition

Amount of data to be migrated.

Constraints

N/A

Range

N/A

dst_count

String

Definition

Amount of data migrated.

Constraints

N/A

Range

N/A

status

String

Definition

Status.

Constraints

N/A

Range

  • NOT_START: The migration is not started.
  • TRANSFERING: The migration is in progress.
  • COMPLETED: The migration is complete.
  • FAILED: The migration failed.
  • TRANSFER_WHEN_END: The migration starts after the object check is complete.

start_time

String

Definition

Start time.

Constraints

N/A

Range

N/A

end_time

String

Definition

End time.

Constraints

N/A

Range

N/A
Table 39 Data structure description of field metrics

Parameter

Type

Description

job_id

String

Definition

Task ID.

Constraints

N/A

Range

N/A

node_id

String

Definition

Instance ID.

Constraints

N/A

Range

N/A

time_stamp

String

Definition

Time when the metric is reported.

Constraints

N/A

Range

N/A

cpu_util

String

Definition

CPU usage.

Constraints

N/A

Range

N/A

mem_util

String

Definition

Memory usage.

Constraints

N/A

Range

N/A

network_incoming_bytes_rate

String

Definition

Network input throughput.

Constraints

N/A

Range

N/A

network_outgoing_bytes_rate

String

Definition

Network output throughput.

Constraints

N/A

Range

N/A

disk_read_bytes_rate

String

Definition

Disk read throughput.

Constraints

N/A

Range

N/A

disk_write_bytes_rate

String

Definition

Disk write throughput.

Constraints

N/A

Range

N/A

apply_rows_rate

String

Definition

Rows written into destination database per second.

Constraints

N/A

Range

N/A

apply_transactions_rate

String

Definition

DML TPS.

Constraints

N/A

Range

N/A

apply_ddl_rate

String

Definition

DDL TPS.

Constraints

N/A

Range

N/A

apply_average_execute_time

String

Definition

Average transaction execution time.

Constraints

N/A

Range

N/A

apply_average_commit_time

String

Definition

Average transaction commit time.

Constraints

N/A

Range

N/A

apply_current_state

String

Definition

Synchronization status.

Constraints

N/A

Range

  • succeed: synchronization successful.
  • failed: synchronization failed.
  • processing: synchronization in progress.
  • waiting: waiting for synchronization.
Table 40 Data structure description of field compare_result

Parameter

Type

Description

objects_compare_overview_info

Object

Definition

Information body of object-level comparison overview.

For details, see Table 41.

objects_compare_detail_infos

Array of objects

Definition

Information body of object-level comparison details.

For details, see Table 43.

data_compare_task_list

Array of objects

Definition

List of data comparison tasks.

For details, see Table 44.

line_compare_overview_infos

Array of objects

Definition

Information body of row comparison overview.

For details, see Table 45.

line_compare_detail_infos

Array of objects

Definition

Information body of row comparison details.

For details, see Table 46.

content_compare_overview_infos

Array of objects

Definition

Information body of value comparison overview.

For details, see Table 47.

content_compare_detail_infos

Array of objects

Definition

Information body of value comparison details.

For details, see Table 48.

content_diff_detail_info

Object

Definition

Details about inconsistent value comparison data.

For details, see Table 49.
Table 41 Data structure description of field objects_compare_overview_info

Parameter

Type

Description

create_time

String

Definition

Time when a comparison task is created.

Constraints

N/A

Range

N/A

compare_results

Array of objects

Definition

Comparison result.

For details, see Table 42.

start_time

String

Definition

Start time of a comparison task.

Constraints

N/A

Range

N/A

status

String

Definition

Status of a comparison task.

Constraints

N/A

Range

  • RUNNING: The comparison task is in progress.
  • WAITING_FOR_RUNNING: The comparison task is waiting to be started.
  • SUCCESSFUL: The comparison task is complete.
  • FAILED: The comparison task fails.
  • CANCELLED: The comparison task is canceled.

export_status

String

Definition

Status of the exported comparison result.

Constraints

N/A

Range

N/A

report_remain_seconds

Long

Definition

Remaining validity period of the exported comparison result.

Constraints

N/A

Range

N/A

compare_job_id

String

Definition

ID of a comparison task.

Constraints

N/A

Range

N/A

error_msg

String

Definition

Failure cause.

Constraints

N/A

Range

N/A
Table 42 Data structure description of field compare_results

Parameter

Type

Description

type

String

Definition

Object type.

Constraints

N/A

Range

  • DB: indicates a database.
  • TABLE: indicates a table.
  • VIEW: indicates a view.
  • EVENT: indicates an event.
  • ROUTINE: indicates a stored procedure and function.
  • INDEX: indicates an index.
  • TRIGGER: indicates a trigger.
  • SYNONYM: indicates a synonym.
  • FUNCTION: indicates a function.
  • PROCEDURE: indicates a stored procedure.
  • TYPE: indicates a user-defined type.
  • RULE: indicates a rule.
  • DEFAULT_TYPE: indicates a default value.
  • PLAN_GUIDE: indicates an execution plan.
  • CONSTRAINT: indicates a constraint.
  • FILE_GROUP: indicates a file group.
  • PARTITION_FUNCTION: indicates a partition function.
  • PARTITION_SCHEME: indicates a partition scheme.
  • TABLE_COLLATION: indicates table sorting rule.
  • EXTENSIONS: indicates a plug-in.

source_count

Long

Definition

Number of source objects.

Constraints

N/A

Range

N/A

target_count

Long

Definition

Number of destination objects.

Constraints

N/A

Range

N/A

status

String

Definition

Comparison result.

Constraints

N/A

Range

  • CONSISTENT: consistent.
  • INCONSISTENT: inconsistent.
  • COMPARING: The comparison is in progress.
  • WAITING_FOR_COMPARISON: waiting for comparison.
  • FAILED_TO_COMPARE: The comparison failed.
  • TARGET_DB_NOT_EXIST: The destination database does not exist.
  • CAN_NOT_COMPARE: Comparison cannot be performed.
Table 43 Data structure description of field objects_compare_detail_infos

Parameter

Type

Description

source_db_value

String

Definition

Comparison value of the source database.

Constraints

N/A

Range

N/A

target_db_value

String

Definition

Comparison value of the destination database.

Constraints

N/A

Range

N/A

source_db_name

String

Definition

Source database name.

Constraints

N/A

Range

N/A

target_db_name

String

Definition

Destination database name.

Constraints

N/A

Range

N/A

error_message

String

Definition

Failure cause.

Constraints

N/A

Range

N/A
Table 44 Data structure description of field data_compare_task_list

Parameter

Type

Description

id

String

Definition

ID of a comparison task.

Constraints

N/A

Range

N/A

type

String

Definition

Comparison type.

Constraints

N/A

Range

  • object: object-level comparison.
  • lines: row comparison.
  • contents: value comparison.

start_time

String

Definition

Start time.

Constraints

N/A

Range

N/A

end_time

String

Definition

End time.

Constraints

N/A

Range

N/A

status

String

Definition

Status of a comparison task.

Constraints

N/A

Range

  • RUNNING: The comparison task is in progress.
  • WAITING_FOR_RUNNING: The comparison task is waiting to be started.
  • SUCCESSFUL: The comparison task is complete.
  • FAILED: The comparison task fails.
  • CANCELLED: The comparison task is canceled.
  • TIMEOUT_INTERRUPT: The comparison task times out.
  • FULL_DOING: Full verification is in progress.
  • INCRE_DOING: Incremental verification is in progress.

compute_type

String

Definition

Compute resource of a comparison task.

Constraints

N/A

Range

N/A

export_status

String

Definition

Status of the exported comparison result.

Constraints

N/A

Range

N/A

report_remain_seconds

Long

Definition

Remaining validity period of the exported comparison result.

Constraints

N/A

Range

N/A

compare_job_tag

Map<String,String>

Definition

Tag of a comparison task.

Constraints

N/A

Range

N/A

options

Map<String,String>

Definition

Comparison task options.

Constraints

N/A

Range

N/A

dynamic_compare_delay

Long

Definition

Dynamic comparison latency.

Constraints

N/A

Range

N/A

error_msg

String

Definition

Failure cause.

Constraints

N/A

Range

N/A
Table 45 Data structure description of field line_compare_overview_infos

Parameter

Type

Description

source_db_name

String

Definition

Source database name.

Constraints

N/A

Range

N/A

target_db_name

String

Definition

Destination database name.

Constraints

N/A

Range

N/A

status

String

Definition

Row comparison result.

Constraints

N/A

Range

  • CONSISTENT: consistent.
  • INCONSISTENT: inconsistent.
  • COMPARING: The comparison is in progress.
  • WAITING_FOR_COMPARISON: waiting for comparison.
  • FAILED_TO_COMPARE: The comparison failed.
  • TARGET_DB_NOT_EXIST: The destination database does not exist.
  • CAN_NOT_COMPARE: Comparison cannot be performed.
Table 46 Data structure description of field line_compare_detail_infos

Parameter

Type

Description

source_table_name

String

Definition

Table name of the source database.

Constraints

N/A

Range

N/A

source_row_num

String

Definition

Number of table rows in the source database.

Constraints

N/A

Range

N/A

target_table_name

String

Definition

Table name of the destination database.

Constraints

N/A

Range

N/A

target_row_num

String

Definition

Number of table rows in the destination database.

Constraints

N/A

Range

N/A

difference_row_num

String

Definition

Difference value.

Constraints

N/A

Range

N/A

status

String

Definition

Comparison result.

Constraints

N/A

Range

  • CONSISTENT: consistent.
  • INCONSISTENT: inconsistent.
  • COMPARING: The comparison is in progress.
  • WAITING_FOR_COMPARISON: waiting for comparison.
  • FAILED_TO_COMPARE: The comparison failed.
  • TARGET_DB_NOT_EXIST: The destination database does not exist.
  • CAN_NOT_COMPARE: Comparison cannot be performed.

message

String

Definition

Message.

Constraints

N/A

Range

N/A
Table 47 Data structure description of field content_compare_overview_infos

Parameter

Type

Description

source_db

String

Definition

Source database name.

Constraints

N/A

Range

N/A

target_db

String

Definition

Destination database name.

Constraints

N/A

Range

N/A

status

String

Definition

Comparison result.

Constraints

N/A

Range

  • CONSISTENT: consistent.
  • INCONSISTENT: inconsistent.
  • COMPARING: The comparison is in progress.
  • WAITING_FOR_COMPARISON: waiting for comparison.
  • FAILED_TO_COMPARE: The comparison failed.
  • TARGET_DB_NOT_EXIST: The destination database does not exist.
  • CAN_NOT_COMPARE: Comparison cannot be performed.

compare_result

Boolean

Definition

Comparison result.

Constraints

N/A

Range

N/A
Table 48 Data structure description of field content_compare_detail_infos

Parameter

Type

Description

source_db

String

Definition

Source database name.

Constraints

N/A

Range

N/A

target_db

String

Definition

Destination database name.

Constraints

N/A

Range

N/A

source_table_name

String

Definition

Table name of the source database.

Constraints

N/A

Range

N/A

target_table_name

String

Definition

Table name of the destination database.

Constraints

N/A

Range

N/A

source_row_num

Long

Definition

Number of table rows in the source database.

Constraints

N/A

Range

N/A

target_row_num

Long

Definition

Number of table rows in the destination database.

Constraints

N/A

Range

N/A

difference_row_num

Long

Definition

Number of inconsistent rows.

Constraints

N/A

Range

N/A

line_compare_result

Boolean

Definition

Row comparison result.

Constraints

N/A

Range

  • true: consistent.
  • false: inconsistent.

content_compare_result

Boolean

Definition

Value comparison result.

Constraints

N/A

Range

  • true: consistent.
  • false: inconsistent.

message

String

Definition

Failure cause.

Constraints

N/A

Range

N/A
Table 49 Data structure description of field content_diff_detail_info

Parameter

Type

Description

count

Long

Definition

Quantity.

Constraints

N/A

Range

N/A

target_meta_is_null

Long

Definition

Inconsistency details: The objects were found only in the source database.

Constraints

N/A

Range

N/A

source_meta_is_null

Long

Definition

Inconsistency details: The objects were found only in the destination database.

Constraints

N/A

Range

N/A

source_target_meta_not_null

Long

Definition

Inconsistency details: The objects were found in the source and destination databases.

Constraints

N/A

Range

N/A

contents_infos

Array of objects

Definition

Information list.

For details, see Table 50.
Table 50 Data structure description of field contents_infos

Parameter

Type

Description

source_key_value

Array of strings

Definition

Key value of the source database.

Constraints

N/A

Range

N/A

target_key_value

Array of strings

Definition

Key value of the destination database.

Constraints

N/A

Range

N/A

source_select_sql

String

Definition

Query the SQL statements of the source database.

Constraints

N/A

Range

N/A

target_select_sql

String

Definition

Query the SQL statements of the destination database.

Constraints

N/A

Range

N/A
Table 51 Data structure description of field support_import_file_resp

Parameter

Type

Description

file_size

String

Definition

File import threshold.

Constraints

N/A

Range

N/A

previous_select

String

Definition

Mode in which objects are selected last time.

Constraints

N/A

Range

N/A
Table 52 Data structure description of field connection_management

Parameter

Type

Description

driver_management

Object

Definition

Driver management.

For details, see Table 53.
Table 53 Data structure description of field driver_management

Parameter

Type

Description

driver_name

String

Definition

Driver name.

Constraints

N/A

Range

N/A
Table 54 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 55 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
Table 56 QueryDiagnosisResult

Parameter

Type

Description

score

Integer

Definition

Score.

Constraints

N/A

Range

N/A

status

String

Definition

Status.

Constraints

N/A

Range

  • INIT: Diagnosis is initialized.
  • RUNNING: Diagnosis is in progress.
  • SUCCESS: Diagnosis is complete.
  • FAILED: Diagnosis failed.

progress

Integer

Definition

Progress.

Constraints

N/A

Range

N/A

error_msg

String

Definition

Failure cause.

Constraints

N/A

Range

N/A

start_time

String

Definition

Start time.

Constraints

N/A

Range

N/A

end_time

String

Definition

End time.

Constraints

N/A

Range

N/A

total

Long

Definition

Total number of diagnosis items.

Constraints

N/A

Range

N/A

normal_count

Long

Definition

The number of normal items.

Constraints

N/A

Range

N/A

abnormal_count

Long

Definition

The number of exceptions.

Constraints

N/A

Range

N/A

alarm_count

Long

Definition

The number of alarms.

Constraints

N/A

Range

N/A

failure_count

Long

Definition

The number of failed items.

Constraints

N/A

Range

N/A

timeout_count

Long

Definition

The number of timeout items.

Constraints

N/A

Range

N/A

diagnosis_results

Array of objects

Definition

Diagnosis result.

For details, see diagnosis_results.
Table 57 diagnosis_results

Parameter

Type

Description

item

object

Definition

Diagnosis item.

For details, see item.

state

String

Definition

Diagnosis item status.

Constraints

N/A

Range

N/A

result_list

Array of objects

Definition

Diagnosis result.

For details, see result_list.

suggestion_list

Array of objects

Definition

Diagnosis suggestion.

For details, see suggestion_list.

score

Integer

Definition

Score of a diagnosis item.

Constraints

N/A

Range

N/A

time

String

Definition

Completion time.

Constraints

N/A

Range

N/A
Table 58 item

Parameter

Type

Description

category

String

Definition

Diagnosis item type.

Constraints

N/A

Range

N/A

name

String

Definition

Diagnosis item name.

Constraints

N/A

Range

N/A

weight

Double

Definition

Weight of a diagnosis item.

Constraints

N/A

Range

N/A
Table 59 result_list

Parameter

Type

Description

key

String

Definition

Content key.

Constraints

N/A

Range

N/A

value

String

Definition

Result value.

Constraints

N/A

Range

N/A

is_multi_language

Boolean

Definition

Whether the result value needs to be internationalized.

Constraints

N/A

Range

  • true: The result value needs to be internationalized.
  • false: The result value does not need to be internationalized.

module_name

String

Definition

Module name.

Constraints

N/A

Range

N/A

level

String

Definition

Level.

Constraints

N/A

Range

N/A
Table 60 suggestion_list

Parameter

Type

Description

content

String

Definition

Diagnosis suggestion content.

Constraints

N/A

Range

N/A
Table 61 repair_progress_info

Parameter

Type

Description

status

String

Definition

Repair status.

Constraints

N/A

Range

  • "FAILED"
  • "SUCCEEDED"
  • "FINISHED"
  • "SUCCESS"

progress

String

Definition

Repair progress, in percentage.

Constraints

N/A

Range

N/A

error_msg

String

Definition

Error message.

Constraints

N/A

Range

N/A

count

Integer

Definition

Total number.

Constraints

N/A

Range

N/A

repair_progress_details

object

Definition

Data repair progress.

For details, see repair_progress_details.
Table 62 repair_progress_details

Parameter

Type

Description

query_id

String

Definition

ID of a comparison task.

Constraints

N/A

Range

N/A

db_name

String

Definition

Database name.

Constraints

N/A

Range

N/A

schema_name

String

Definition

Schema name.

Constraints

N/A

Range

N/A

table_name

String

Definition

Table name.

Constraints

N/A

Range

N/A

total_row_count

Integer

Definition

Total number of rows.

Constraints

N/A

Range

N/A

complete_row_count

Integer

Definition

Number of completed rows.

Constraints

N/A

Range

N/A

filter_row_count

Integer

Definition

Number of filtered rows.

Constraints

N/A

Range

N/A

repaired_row_count

Integer

Definition

Number of repaired rows.

Constraints

N/A

Range

N/A

failed_row_count

Integer

Definition

Number of failed rows.

Constraints

N/A

Range

N/A

repair_status

Integer

Definition

Repair status.

Constraints

N/A

Range

N/A

start_time

String

Definition

Start time.

Constraints

N/A

Range

N/A

update_time

String

Definition

Update time.

Constraints

N/A

Range

N/A
Table 63 QueryRepairDetailResp

Parameter

Type

Description

count

Integer

Definition

Total number.

Constraints

N/A

Range

N/A

repair_details

Array of objects

Definition

Repair details.

For details, see repair_details.
Table 64 repair_details

Parameter

Type

Description

source_meta

String

Definition

Value of the identity column in the source table.

Constraints

N/A

Range

N/A

target_meta

String

Definition

Value of the identity column in the destination table.

Constraints

N/A

Range

N/A

repair_sql_state

Integer

Definition

Repair SQL status.

Constraints

N/A

Range

N/A

repair_sql_info

String

Definition

Repair SQL statement.

Constraints

N/A

Range

N/A

Status code: 400

Table 65 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code returned when an error occurs during task execution.

Constraints

  • Minimum length: 12 characters
  • Maximum length: 12 characters

Range

The format is DRS.XXXXXX.

error_msg

String

Definition

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

Constraints

  • Minimum length: 1 character
  • Maximum length: 512 characters

Range

N/A

Example Request

  • Querying the synchronization progress of a task 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r?type=progress
  • Querying the row comparison overview 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r?type=compare&query_type=overview&compare_type=line_compare&compare_task_id=1994b3e6-15ef-471e-8af1-7e2ed3e85b06&offset=0&limit=10
  • Querying task details 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r?type=detail
  • Querying data-level comparison tasks 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r?type=compare&compare_type=data_compare&query_type=list&limit=10&offset=0
  • Querying synchronization logs 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r?type=log&offset=0&limit=10
  • Querying the connection testing result 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r?type=network&query_id=669c9c19-99e3-4628-8c90-397136266701
  • Querying the quick diagnosis result. The value of query_id is the query ID returned by the API for starting diagnosis. 
    https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/781055ed-787f-4bfc-8886-b6ffc88jb201?type=diagnosis&query_id=8193ebe8-aac5-46bb-9330-810b62657adc
  • Querying the data repair progress. The value of query_id is the ID of the comparison task. 
    https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/781055ed-787f-4bfc-8886-b6ffc88jb201?type=repair_progress&query_id=d77dd50c-24b9-47b7-8f2e-9009efca4ab2&offset=0&limit=10

Example Response

Status code: 200

OK

Querying basic task information (when type is set to detail)

{
  "job" : {
    "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r",
    "status" : "CONFIGURATION",
    "create_time" : "2022-11-07T16:15:18Z",
    "base_info" : {
      "name" : "DRS-1234",
      "job_type" : "sync",
      "engine_type" : "oracle-to-gaussdbv5",
      "job_direction" : "up",
      "task_type" : "FULL_INCR_TRANS",
      "net_type" : "eip",
      "charging_mode" : "on_demand",
      "enterprise_project_id" : "0",
      "description" : "",
      "expired_days" : "14",
      "tags" : [ {
        "key" : "test",
        "value" : "test"
      } ]
    },
    "source_endpoint" : [ {
      "db_type" : "oracle",
      "endpoint_type" : "offline",
      "endpoint_role" : "so",
      "endpoint" : {
        "id" : "f59e6118-da89-4fdb-9b98-65f56709928a",
        "endpoint_name" : "oracle",
        "ip" : "10.154.217.239",
        "db_port" : "1521",
        "db_user" : "ORACLE_USER",
        "db_name" : "serviceName.orcl"
      },
      "ssl" : {
        "ssl_link" : false
      }
    } ],
    "target_endpoint" : [ {
      "db_type" : "gaussdbv5",
      "endpoint_type" : "cloud",
      "endpoint_role" : "ta",
      "endpoint" : {
        "id" : "10deb576-8885-473b-a213-4d76e668dc0d",
        "endpoint_name" : "cloud_gaussdbv5",
        "instance_id" : "c2c7579bc09c490b9d8009db715aeb0ain14",
        "db_user" : "root"
      },
      "cloud" : {
        "region" : "cn-north-4",
        "project_id" : "9dc8c0f3f74c4dbb23c29cf0318ee561",
        "az_code" : "cn-north-4a,cn-north-4g,cn-north-4c"
      },
      "vpc" : {
        "vpc_id" : "2cb5d364-ae63-4fbb-85b7-7d59f4a88f8f",
        "subnet_id" : "2cb54324-ae63-4fbb-85b7-7d59f4a88f8f",
        "security_group_id" : "039a3s89-665a-43e2-9b4f-bda7d9ee148d"
      }
    } ],
    "alarm_notify" : {
      "alarm_to_user" : true,
      "topic_urn" : "urn:smn:cn-north-4:f2c2468c3ee7410c862a461ca073d2f2:test",
      "delay_time" : 60
    },
    "speed_limit" : [ {
      "begin" : "16:00",
      "end" : "15:59",
      "speed" : "10"
    } ],
    "policy_config" : {
      "ddl_trans" : false
    },
    "node_info" : {
      "spec" : {
        "node_type" : "medium"
      }
    }
  }
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000010",
  "error_msg" : "Job does not exist, please check job ID."
}

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: Task Details