All Products
Search
Document Center

Data Transmission Service:ConfigureDtsJob

Last Updated:Jun 13, 2024

Configures a data migration, synchronization, or verification task.

  • When you configure a task in the Data Transmission Service (DTS) console, you can move the pointer over Next: Save Task Settings and Precheck in the Advanced Settings step and click Preview OpenAPI parameters to view the parameters that are used to configure the task by calling an API operation.

  • If you want to run a DTS task on a DTS dedicated cluster, you must configure the task before you purchase a DTS instance. In addition, DTS dedicated clusters do not support cross-region DTS tasks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

STRING

Yes

ConfigureDtsJob

The operation that you want to perform. Set the value to ConfigureDtsJob.

DtsJobName

STRING

Yes

rdsmysql_to_mysql

The name of the DTS instance.

SourceEndpointInstanceType

STRING

Yes

RDS

The type of the source instance. Valid values:

Alibaba Cloud database instances

  • RDS: ApsaraDB RDS for MySQL instance, ApsaraDB RDS for SQL Server instance, ApsaraDB RDS for PostgreSQL instance, or ApsaraDB RDS for MariaDB instance

  • PolarDB: PolarDB for MySQL cluster

  • REDIS: ApsaraDB for Redis instance

  • DISTRIBUTED_POLARDBX10: PolarDB-X 1.0 instance (formerly DRDS)

  • POLARDBX20: PolarDB-X 2.0 instance

  • MONGODB: ApsaraDB for MongoDB instance

  • DISTRIBUTED_DMSLOGICDB: Data Management (DMS) logical database

Self-managed databases

  • OTHER: self-managed database with a public IP address

  • ECS: self-managed database hosted on an Elastic Compute Service (ECS) instance

  • EXPRESS: self-managed database connected over Express Connect

  • CEN: self-managed database connected over Cloud Enterprise Network (CEN)

  • DG: self-managed database connected over Database Gateway

Note
  • If the source instance is a PolarDB for Oracle cluster, you must connect the cluster to DTS as a self-managed database by using a public IP address or Express Connect and set this parameter to OTHER or EXPRESS.

  • For more information, see Supported sources and targets.

  • If the source instance is a self-managed database, you must deploy the network environment for the database. For more information, see Preparation overview.

SourceEndpointInstanceID

STRING

No

rm-bp1imrtn6fq7h****

The source instance ID.

If the source instance is an Alibaba Cloud database instance, you must specify the ID of the database instance. For example, if the source instance is an ApsaraDB RDS for MySQL instance, you must specify the ID of the ApsaraDB RDS for MySQL instance.

If the source instance is a self-managed database, the value of this parameter varies with the value of SourceEndpointInstanceType.

  • If SourceEndpointInstanceType is set to ECS, you must specify the ID of the ECS instance.

  • If SourceEndpointInstanceType is set to DG, you must specify the ID of the database gateway.

  • If SourceEndpointInstanceType is set to EXPRESS or CEN, you must specify the ID of the virtual private cloud (VPC) that is connected to the source instance.

Note

If SourceEndpointInstanceType is set to CEN, you must also specify the ID of the CEN instance in Reserve. For more information, see Reserve parameter.

SourceEndpointEngineName

STRING

No

MYSQL

The database type of the source instance.

  • MYSQL: ApsaraDB RDS for MySQL instance or self-managed MySQL database

  • MARIADB: ApsaraDB RDS for MariaDB instance

  • PolarDB: PolarDB for MySQL cluster

  • POLARDB_O: PolarDB for Oracle cluster

  • POLARDBX10: PolarDB-X 1.0 instance (formerly DRDS)

  • POLARDBX20: PolarDB-X 2.0 instance

  • ORACLE: self-managed Oracle database

  • POSTGRESQL: ApsaraDB RDS for PostgreSQL instance or self-managed PostgreSQL database

  • MSSQL: ApsaraDB RDS for SQL Server instance or self-managed SQL Server database

  • MONGODB: ApsaraDB for MongoDB instance or self-managed MongoDB database

  • DB2: self-managed Db2 for LUW database

  • AS400: self-managed Db2 for i database

  • DMSPOLARDB: DMS logical database

  • HBASE: self-managed HBase database

  • TERADATA: Teradata database

  • TiDB: TiDB database

  • REDIS: ApsaraDB for Redis instance or self-managed Redis database

Note
  • Default value: MYSQL.

  • If SourceEndpointEngineName is set to MONGODB, you must also specify the architecture type of the MongoDB database in Reserve. For more information, see Reserve parameter.

SourceEndpointRegion

STRING

No

cn-hangzhou

The ID of the region in which the source instance resides. For more information, see Supported regions.

Note

If the source instance is an Alibaba Cloud database instance, this parameter is required.

SourceEndpointIP

STRING

No

172.16.**.***

The IP address of the source instance.

Note

This parameter is required only if SourceEndpointInstanceType is set to OTHER, EXPRESS, DG, or CEN.

SourceEndpointPort

STRING

No

3306

The port number of the source instance.

Note

This parameter is required only if the source instance is a self-managed database.

SourceEndpointOracleSID

STRING

No

testsid

The system ID (SID) of the Oracle database.

Note

This parameter is required only if SourceEndpointEngineName is set to ORACLE and the Oracle database is deployed in a non-Real Application Cluster (RAC) architecture.

SourceEndpointDatabaseName

STRING

No

dtstestdatabase

The name of the database that contains the objects to be migrated or synchronized in the source instance.

Note

This parameter is required only if the source instance is a PolarDB for Oracle cluster, a PostgreSQL database, or a MongoDB database.

SourceEndpointUserName

STRING

No

dtstest

The database account of the source database.

Note

SourceEndpointPassword

STRING

No

Test123456

The password of the source database account.

SourceEndpointOwnerID

STRING

No

140692647406****

The ID of the Alibaba Cloud account to which the source database belongs.

Note

You can specify this parameter to migrate or synchronize data across different Alibaba Cloud accounts. In this case, you must specify SourceEndpointRole.

SourceEndpointRole

STRING

No

ram-for-dts

The name of the Resource Access Management (RAM) role configured for the Alibaba Cloud account to which the source instance belongs.

Note

This parameter is required if you migrate or synchronize data across different Alibaba Cloud accounts. For information about the permissions and authorization methods of the RAM role, see Configure RAM authorization for cross-account DTS tasks.

DestinationEndpointInstanceType

STRING

Yes

EXPRESS

The type of the destination instance. Valid values:

Alibaba Cloud database instances

  • RDS: ApsaraDB RDS for MySQL instance, ApsaraDB RDS for SQL Server instance, ApsaraDB RDS for PostgreSQL instance, or ApsaraDB RDS for MariaDB instance

  • PolarDB: PolarDB for MySQL cluster

  • DISTRIBUTED_POLARDBX10: PolarDB-X 1.0 instance (formerly DRDS)

  • POLARDBX20: PolarDB-X 2.0 instance

  • REDIS: ApsaraDB for Redis instance

  • ADS: AnalyticDB for MySQL V2.0 cluster or AnalyticDB for MySQL V3.0 cluster

  • MONGODB: ApsaraDB for MongoDB instance

  • GREENPLUM: AnalyticDB for PostgreSQL instance

  • DATAHUB: DataHub project

  • ELK: Elasticsearch cluster

  • Tablestore: Tablestore instance

  • ODPS: MaxCompute project

Self-managed databases

  • OTHER: self-managed database with a public IP address

  • ECS: self-managed database hosted on an ECS instance

  • EXPRESS: self-managed database connected over Express Connect

  • CEN: self-managed database connected over CEN

  • DG: self-managed database connected over Database Gateway

Note
  • If the destination instance is a PolarDB for Oracle cluster, you must connect the cluster to DTS as a self-managed database by using a public IP address or Express Connect and set this parameter to OTHER or EXPRESS.

  • If the destination instance is an ApsaraMQ for Kafka instance, you must connect the instance to DTS as a self-managed database by using ECS or Express Connect and set this parameter to ECS or EXPRESS.

  • For more information, see Supported sources and targets.

  • If the destination instance is a self-managed database, you must deploy the network environment for the database. For more information, see Preparation overview.

DestinationEndpointInstanceID

STRING

No

vpc-bp1opxu1zkhn00gzv****

The destination instance ID.

If the destination instance is an Alibaba Cloud database instance, you must specify the ID of the database instance. For example, if the destination instance is an ApsaraDB RDS for MySQL instance, you must specify the ID of the ApsaraDB RDS for MySQL instance.

If the destination instance is a self-managed database, the value of this parameter varies with the value of DestinationEndpointInstanceType.

  • If DestinationEndpointInstanceType is set to ECS, you must specify the ID of the ECS instance.

  • If DestinationEndpointInstanceType is set to DG, you must specify the ID of the database gateway.

  • If DestinationEndpointInstanceType is set to EXPRESS or CEN, you must specify the ID of the VPC that is connected to the source instance.

Note

If DestinationEndpointInstanceType is set to CEN, you must also specify the ID of the CEN instance in Reserve. For more information, see Reserve parameter.

DestinationEndpointEngineName

STRING

No

MYSQL

The database type of the destination instance.

  • MYSQL: ApsaraDB RDS for MySQL instance or self-managed MySQL database

  • MARIADB: ApsaraDB RDS for MariaDB instance

  • PolarDB: PolarDB for MySQL cluster

  • POLARDB_O: PolarDB for Oracle cluster

  • POLARDBX10: PolarDB-X 1.0 instance (formerly DRDS)

  • POLARDBX20: PolarDB-X 2.0 instance

  • ORACLE: self-managed Oracle database

  • POSTGRESQL: ApsaraDB RDS for PostgreSQL instance or self-managed PostgreSQL database

  • MSSQL: ApsaraDB RDS for SQL Server instance or self-managed SQL Server database

  • ADS: AnalyticDB for MySQL V2.0 cluster

  • ADB30: AnalyticDB for MySQL V3.0 cluster

  • MONGODB: ApsaraDB for MongoDB instance or self-managed MongoDB database

  • GREENPLUM: AnalyticDB for PostgreSQL instance

  • KAFKA: ApsaraMQ for Kafka instance or self-managed Kafka cluster

  • DATAHUB: DataHub project

  • DB2: self-managed Db2 for LUW database

  • AS400: self-managed Db2 for i database

  • ODPS: MaxCompute project

  • Tablestore: Tablestore instance

  • ELK: Elasticsearch cluster

  • REDIS: ApsaraDB for Redis instance or self-managed Redis database

Note
  • Default value: MYSQL.

  • If this parameter is set to KAFKA, MONGODB, or PolarDB, you must also specify the database information in Reserve. For more information, see Reserve parameter.

DestinationEndpointRegion

STRING

No

cn-hangzhou

The ID of the region in which the destination instance resides. For more information, see Supported regions.

Note

If the destination instance is an Alibaba Cloud database instance, this parameter is required.

DestinationEndpointIP

STRING

No

172.16.**.***

The IP address of the destination instance.

Note

This parameter is required only if DestinationEndpointInstanceType is set to OTHER, EXPRESS, DG, or CEN.

DestinationEndpointPort

STRING

No

3306

The port number of the destination instance.

Note

This parameter is required only if the destination instance is a self-managed database.

DestinationEndpointDataBaseName

STRING

No

dtstestdata

The name of the database that contains the objects that are migrated or synchronized in the destination instance.

Note
  • This parameter is required only if the destination database is a PolarDB for Oracle cluster, an AnalyticDB for PostgreSQL instance, a PostgreSQL database, a MaxCompute project, or a MongoDB database.

  • If the destination instance is a MaxCompute project, you must specify the ID of the MaxCompute project.

DestinationEndpointUserName

STRING

No

dtstest

The database account of the destination database.

Note

DestinationEndpointPassword

STRING

No

Test123456

The password of the destination database account.

Note

If the destination database is a MaxCompute project, you must specify the AccessKey secret of your Alibaba Cloud account. For information about how to obtain your AccessKey pair, see Create an AccessKey pair.

DestinationEndpointOwnerID

STRING

No

140692647406****

The ID of the Alibaba Cloud account to which the destination ApsaraDB RDS for MySQL instance belongs.

Note
  • This parameter is available only if the destination instance is an ApsaraDB RDS for MySQL instance.

  • You can specify this parameter to migrate or synchronize data across different Alibaba Cloud accounts. In this case, you must specify DestinationEndpointRole.

DestinationEndpointRole

STRING

No

ram-for-dts

The name of the RAM role configured for the Alibaba Cloud account to which the destination instance belongs.

Note

This parameter is required if you migrate or synchronize data across different Alibaba Cloud accounts. For information about the permissions and authorization methods of the RAM role, see Configure RAM authorization for cross-account DTS tasks.

StructureInitialization

BOOLEAN

Yes

true

Specifies whether to perform schema migration or schema synchronization. Valid values:

  • true (default)

  • false

Note

If JobType is set to CHECK, set this parameter to false.

DataInitialization

BOOLEAN

Yes

true

Specifies whether to perform full data migration or full data synchronization. Valid values:

  • true (default)

  • false

Note

If JobType is set to CHECK, set this parameter to false.

DataSynchronization

BOOLEAN

Yes

true

Specifies whether to perform incremental data migration or incremental data synchronization. Valid values:

  • false (default)

  • true

Note

If JobType is set to CHECK, set this parameter to false.

DbList

STRING

Yes

{"dtstest":{"name":"dtstest","all":true}}

The objects that you want to migrate or synchronize. The value is a JSON string. For more information, see Objects of DTS tasks.

Note

The DbList parameter supports passing in up to 10 MB of data.

Reserve

STRING

No

{ "srcInstanceId": "cen-9kqshqum*******" }

The reserved parameter of DTS. The value is a JSON string. You can specify this parameter to add more configurations of the source or destination instance to the DTS task. For example, you can specify the data storage format of the destination Kafka database and the ID of the CEN instance. For more information, see Reserve parameter.

Checkpoint

STRING

No

1610540493

The start offset of incremental data migration or incremental data synchronization. The value is a UNIX timestamp. Unit: seconds.

DestinationEndpointOracleSID

STRING

No

testsid

The SID of the Oracle database.

Note

This parameter is required only if DestinationEndpointEngineName is set to ORACLE and the Oracle database is deployed in a non-RAC architecture.

JobType

STRING

Yes

SYNC

The type of the task. Valid values:

  • MIGRATION: data migration task.

  • SYNC: data synchronization task.

  • CHECK: data verification task. You must separately purchase a data verification instance.

Note

If you set this parameter to MIGRATION or SYNC, you can also enable data verification in the data migration or synchronization task.

DtsJobId

STRING

No

k2gm967v16f****

The ID of the data migration or synchronization task.

Note

You can call the DescribeDtsJobs operation to query the task ID.

DtsInstanceId

STRING

No

dtsk2gm967v16f****

The ID of the data migration or synchronization instance.

Note

You can call the DescribeDtsJobs operation to query the instance ID.

DelayPhone

STRING

No

1361234****,1371234****

The mobile numbers that receive latency-related alerts. Separate multiple mobile numbers with commas (,).

Note
  • This parameter is available only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. You can specify up to 10 mobile numbers.

  • Users of the international site (alibabacloud.com) cannot receive alerts by using mobile numbers, but can configure alert rules for DTS tasks in the CloudMonitor console. For more information, see Configure alert rules for DTS tasks in the CloudMonitor console.

DelayRuleTime

LONG

No

10

The threshold for latency alerts. Unit: seconds. The value must be an integer. You can set the threshold based on your business requirements. To prevent jitters caused by network and database overloads, we recommend that you set the threshold to more than 10 seconds.

Note

If DelayNotice is set to true, this parameter is required.

DelayNotice

BOOLEAN

No

true

Specifies whether to monitor the task latency. Valid values:

  • true

  • false

ErrorPhone

STRING

No

1361234****,1371234****

The mobile numbers that receive status-related alerts. Separate multiple mobile numbers with commas (,).

Note
  • This parameter is available only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. You can specify up to 10 mobile numbers.

  • Users of the international site (alibabacloud.com) cannot receive alerts by using mobile numbers, but can configure alert rules for DTS tasks in the CloudMonitor console. For more information, see Configure alert rules for DTS tasks in the CloudMonitor console.

ErrorNotice

BOOLEAN

No

true

Specifies whether to monitor the task status. Valid values:

  • true

  • false

SynchronizationDirection

STRING

No

Forward

The synchronization direction. Valid values:

  • Forward

  • Reverse

Note
  • The default value is Forward.

  • The value Reverse takes effect only if the topology of the data synchronization task is two-way synchronization.

RegionId

STRING

No

cn-hangzhou

The ID of the region in which the DTS instance resides. For more information, see Supported regions.

DedicatedClusterId

STRING

No

dtscluster_atyl3b5214uk***

The ID of the DTS dedicated cluster on which the task runs.

Note

If this parameter is specified, the task is scheduled to the specified DTS dedicated cluster.

FileOssUrl

STRING

No

http://db-list-os-file.oss-cn-shanghai.aliyuncs.com/8e42_121852**********_79dd3aeabe2f43cdb**************

The URL of the Object Storage Service (OSS) bucket that stores the files related to the DTS task.

DataCheckConfigure

STRING

No

{"fullCheckModel":1,"fullCheckRatio":20,"checkMaximumHourEnable":1,"checkMaximumHour":1,"fullCheckErrorNotice":true,"fullCheckValidFailNotice":true,"fullCheckNoticeValue":8,"incrementalCheckErrorNotice":true,"incrementalCheckValidFailNotice":true,"incrementalCheckValidFailNoticeTimes":2,"incrementalCheckValidFailNoticePeriod":1,"incrementalCheckValidFailNoticeValue":1,"incrementalCheckDelayNotice":true,"incrementalCheckDelayNoticeTimes":2,"incrementalCheckDelayNoticePeriod":1,"incrementalCheckDelayNoticeValue":60,"fullDataCheck":true,"incrementalDataCheck":true,"dataCheckNoticePhone":"13126800****","dataCheckDbList":"{"dts":{"name":"dts","all":true}}"}

The parameters for data verification, including the configurations for data verification and alerts. The value is a JSON string. For more information, see DataCheckConfigure parameter description.

DisasterRecoveryJob

BOOLEAN

No

true

Specifies whether the instance is a disaster recovery instance. Valid values:

  • true

  • false

SourceEndpointVSwitchID

STRING

No

vsw-bp10df3mxae6lpmku****

The ID of the vSwitch that is used for data shipping.

DtsBisLabel

STRING

No

normal

The environment tag of the DTS instance. Valid values:

  • normal

  • online

SrcCaCertificateOssUrl

STRING

No

****

The path of the certificate authority (CA) certificate that is used if the connection to the source database is encrypted by using SSL.

Note

This feature is not supported. Do not specify this parameter.

SrcCaCertificatePassword

STRING

No

****

The key of the CA certificate that is used if the connection to the source database is encrypted by using SSL.

Note

This feature is not supported. Do not specify this parameter.

DestCaCertificateOssUrl

STRING

No

****

The path of the CA certificate that is used if the connection to the destination database is encrypted by using SSL.

Note

This feature is not supported. Do not specify this parameter.

DestCaCertificatePassword

STRING

No

****

The key of the CA certificate that is used if the connection to the destination database is encrypted by using SSL.

Note

This feature is not supported. Do not specify this parameter.

MinDu

DOUBLE

No

1

The minimum number of DTS Units (DUs).

Note

This parameter is supported only for serverless instances.

MaxDu

DOUBLE

No

16

The maximum number of DUs.

Note

This parameter is supported only for serverless instances.

Response parameters

Parameter

Type

Example

Description

HttpStatusCode

STRING

200

The returned HTTP status codes.

RequestId

STRING

224DB9F7-3100-4899-AB9C-C938BCCB****

The request ID.

ErrCode

STRING

InternalError

The error code returned if the call failed.

DtsJobId

STRING

k2gm967v16f****

The ID of the data migration or synchronization task.

DtsInstanceId

STRING

dtsk2gm967v16f****

The ID of the data migration or synchronization instance.

Success

STRING

true

Indicates whether the request was successful.

ErrMessage

STRING

The request processing has failed due to some unknown error.

The error message returned if the call failed.

Examples

Sample request

http(s)://dts.aliyuncs.com/?Action=ConfigureDtsJob
&RegionId=cn-hangzhou
&SourceEndpointInstanceType=RDS
&DestinationEndpointInstanceType=EXPRESS
&StructureInitialization=true
&DataInitialization=true
&DataSynchronization=true
&DbList={"dtstest":{"name":"dtstest","all":true}}
&JobType=SYNC
&SourceEndpointInstanceID=rm-bp1imrtn6fq7h****
&SourceEndpointEngineName=MYSQL
&SourceEndpointRegion=cn-hangzhou
&SourceEndpointUserName=dtstest
&SourceEndpointPassword=Test123456
&DestinationEndpointInstanceID=vpc-bp1opxu1zkhn00gzv****
&DestinationEndpointEngineName=MYSQL
&DestinationEndpointIP=172.16.**.***
&DestinationEndpointRegion=cn-hangzhou
&DestinationEndpointPort=3306
&DestinationEndpointUserName=dtstest
&DestinationEndpointPassword=Test123456
&DtsJobId=k2gm967v16f****
&DtsInstanceId=dtsk2gm967v16f****
&DtsJobName=ApsaraDB RDS for MySQL to self-managed MySQL database connected over Express Connect
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ConfigureDtsJobResponse>
    <DtsJobId>k2gm967v16f****</DtsJobId>
    <RequestId>224DB9F7-3100-4899-AB9C-C938BCCB****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <DtsInstanceId>dtsk2gm967v16f****</DtsInstanceId>
    <Success>true</Success>
</ConfigureDtsJobResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DtsJobId" : "k2gm967v16f****",
  "RequestId" : "224DB9F7-3100-4899-AB9C-C938BCCB****",
  "HttpStatusCode" : 200,
  "DtsInstanceId" : "dtsk2gm967v16f****",
  "Success" : true
}

Error codes

HTTP status code

Error code

Error message

Description

403

InvalidParameter.KafkaBrokerInvalid

kafka broker configuration must be intranet IP

The node name of a self-managed Kafka cluster hosted on ECS is set to a hostname instead of an IP address.

403

InvalidParameter.KafkaHostInvalid

kafaka host name should be intranet IP

The Kafka hostname must be an IP address accessed over an internal network.

403

UpdateJob.OperationDenied.InitStatus

The operation is not permitted due to Dts job status is init.

The task is already started and cannot be modified. Reconfigure the task or modify the objects to be synchronized. If you reconfigure the task, the old task configurations are deleted.

403

GetMongoDbShardInfo.NoShardAddress

MongoDb has not yet opened the shard connection address, please try again after opening.

The shard connection information cannot be obtained. Check the parameter settings. Make sure that the database is an ApsaraDB for MongoDB sharded cluster instance and that an endpoint is applied for a shard node.

403

GetMongoDbShardInfo.EmptyInstances

Failed to get MongoDb shard information, the return is empty.

The shard information cannot be obtained. Check the parameter settings and make sure that the database is an ApsaraDB for MongoDB sharded cluster instance.

403

CheckJobFailed.ServerUnAvailable

Unable to check whether the node can connect to the database because the node service is unavailable.

The connection to specific DTS servers cannot be established. Try again. If the error persists, contact technical support.

403

DbTypeNotSupport.PolarDBRDS

The current rds instance is of type PolarDB, which is not supported for the time being. Only rds instances under drds are supported.

DTS does not support data synchronization that involves a PolarDB-X 1.0 instance with a PolarDB for MySQL database shard.

403

DbTypeNotSupport.OnlyReadRDS

Synchronization is not currently supported due to latency issues with read-only PolarDB-X 1.0 instances.

DTS does not support data synchronization that involves a PolarDB-X 1.0 instance with a read-only database shard.

403

DTS.Msg.InvalidParameter.KafkaBrokerInvalid

kafka broker configuration must be intranet IP

The node name of a self-managed Kafka cluster hosted on ECS is set to a hostname instead of an IP address.

403

DTS.Msg.InvalidParameter.KafkaHostInvalid

kafaka host name should be intranet IP

The Kafka hostname must be an IP address accessed over an internal network.

403

DTS.Msg.UpdateJob.OperationDenied.InitStatus

The operation is not permitted due to Dts job status is init.

The task is already started and cannot be modified. Reconfigure the task or modify the objects to be synchronized. If you reconfigure the task, the old task configurations are deleted.

403

DTS.Msg.GetMongoDbShardInfo.NoShardAddress

MongoDb has not yet opened the shard connection address, please try again after opening.

The shard connection information cannot be obtained. Check the parameter settings. Make sure that the database is an ApsaraDB for MongoDB sharded cluster instance and that an endpoint is applied for a shard node.

403

DTS.Msg.GetMongoDbShardInfo.EmptyInstances

Failed to get MongoDb shard information, the return is empty.

The shard information cannot be obtained. Check the parameter settings and make sure that the database is an ApsaraDB for MongoDB sharded cluster instance.

403

DTS.Msg.CheckJobFailed.ServerUnAvailable

Unable to check whether the node can connect to the database because the node service is unavailable.

The connection to specific DTS servers cannot be established. Try again. If the error persists, contact technical support.

403

DTS.Msg.DbTypeNotSupport.PolarDBRDS

The current rds instance is of type PolarDB, which is not supported for the time being. Only rds instances under drds are supported.

DTS does not support data synchronization that involves a PolarDB-X 1.0 instance with a PolarDB for MySQL database shard.

403

DTS.Msg.DbTypeNotSupport.OnlyReadRDS

Synchronization is not currently supported due to latency issues with read-only PolarDB-X 1.0 instances.

DTS does not support data synchronization that involves a PolarDB-X 1.0 instance with a read-only database shard.

403

InvalidSecurityToken.Expired

Specified SecurityToken is expired.

The signature expired. Use a new signature.

400

Throttling.User

Request was denied due to user flow control.

The number of requests exceeded the limit, and the request was rejected. Try again later.

500

ServiceUnavailable

The request has failed due to a temporary failure of the server.

The response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support.

For a list of error codes, see Service error codes.