Database Transmission Service
Database Transmission Service
Document
- Documentation
Database Transmission ServiceAPI referenceData transmissionDescribeTransmissionTaskInfo
Copy page
Download PDFData transmission
DescribeTransmissionTaskInfo
Copy pageDownload PDFDescribeTransmissionTaskInfo
Call the DescribeTransmissionTaskInfo API to view the transmission task details.
Request type
Synchronous request.
Precautions
PG2PGRowCompareSettings
Request parameters
Response parameter
Name | Type | Example | Description |
TaskInfo | { "ChargeDetail":{ "ChargeStatus":"Init", "ChargeType":"PostPaid", "OrderNo":"" }, "CreateTime":1661242976288, "DestConfig":{ "DataSourceId":"322", "EndpointType":"Volc_Kafka", "VolcKafkaSettings":{ "AuthType":"PLAIN", "InstanceId":"kafka-cnngfsm7glfm****", "InstanceName":"", "Password":"", "RegionSettings":{ "Region":"" }, "Topic":"hua", "Username":"kakatest" } }, "EnableCloudMonitor":true, "EndTime":0, "ProjectName":"default", "SolutionSettings":{ "PG2KafkaSettings":{ "ErrorBehaviorSettings":{ "MaxRetrySeconds":7200 }, "FullTransmissionSettings":{ "EnableFull":false }, "IncrTransmissionSettings":{ "EnableIncr":true, "Statements":[ "StmtDMLInsert", "StmtDMLUpdate", "StmtDMLDelete", "StmtDDLAll" ] }, "MetaTransmissionSettings":{ "EnableMeta":false }, "ObjectMappings":[ { "DestObjName":"public", "MappingList":[ { "DestObjName":"", "ObjectType":"Table", "SrcObjName":"" } ], "ObjectType":"Database", "SrcObjName":"public" } ], "SubscriptionSettings":{ "PartitionPolicy":"P0", "Protocol":"Volc", "VPCId":"vpc-bp1opxu1zkhn00gz****", "VPCSubnetId":"" } }, "SolutionType":"PG2Kafka" }, "SrcConfig":{ "DataSourceId":"321", "EndpointType":"Volc_PostgreSQL", "VolcPostgreSQLSettings":{ "DBInstanceId":"postgres-338f4f3a****", "DBInstanceName":"", "DBName":"testzaizai", "Password":"", "RegionSettings":{ "Region":"cn-beijing" }, "Username":"testzaizai" } }, "StartTime":1661242976288, "TaskId":"c37008625ddd44019ee85b84fb****", "TaskName":"test****zaizai", "TaskStatus":"Init", "TaskSubType":"Default", "TaskType":"DataSubscription", "TenantId":"2100157781", "TrafficSpec":"Compact" } json |
TaskInfo
DataSource
Name | Type | Example | Description |
Category | String | MySQL | The type of instance. The values are as follows:
|
CreateTime | Long | 1734070854504 | Creation time of the data source. Millisecond timestamp. |
DataSourceId | String | 1867454442941460510 | Source or target instance ID. |
ModifyTime | Long | 1734070873088 | The most recent time the data source was updated. Millisecond timestamp. |
EndpointType | String | Volc_MySQL | The access method of the instance. the values are as follows:
|
VolcMySQLSettings | { "DBInstanceId": "mysql-0b5d385f*****", "DBInstanceName": "", "Password": "******", "RegionSettings": { "Region": "cn-shanghai" }, "Username": "huahua" } | Indicates the information of the source or target database where the access method is Volcengine RDS for MySQL. This parameter is required when EndpointType is set to Volc_MySQL. | |
VolcveDBMySQLSettings | { "DBInstanceId": "vedbm-arjlc5di****", "DBInstanceName": "", "Password": "******", "RegionSettings": { "Region": "cn-beijing" }, "Username": "root" } | Indicates the information of the source or target database where the access method is Volcano Engine veDB for MySQL. This parameter is required when EndpointType is set to Volc_veDB_MySQL. | |
VolcPostgreSQLSettings | { "DBInstanceId": "postgres-5d17bd5c****", "DBInstanceName": "", "DBName": "huahua", "Password": "******", "RegionSettings": { "Region": "cn-guangzhou" }, "Username": "huahua" } | Indicates the information of the source or target database where the access method is Volcengine RDS for PostgreSQL. This parameter is required when EndpointType is set to Volc_PostgreSQL. | |
VolcMongoSettings | { "DBInstanceId": "mongo-replica-8ea79132****", "DBInstanceName": "", "DeployType": "ReplicaSet", "MongoAuthSourceDB": "", "Password": "******", "RegionSettings": { "Region": "cn-guangzhou" }, "Username": "root" } | Indicates the information of the source or target database where the access method is Volcengine Database for MongoDB. This parameter is required when EndpointType is set to Volc_Mongo. | |
VolcElasticSearchSettings | { "DBInstanceId": "o-00g0sqi*****", "DBInstanceName": "", "Password": "******", "RegionSettings": { "Region": "cn-shanghai" }, "Username": "admin" } | Indicates the information of the target database where the access method is Volcengine Cloud Search Service. This parameter is required when EndpointType is set to Volc_ElasticSearch. | |
VolcKafkaSettings | { "AuthType": "PLAIN", "InstanceId": "kafka-cnnge0tckudy****", "InstanceName": "", "Password": "******", "RegionSettings": { "Region": "cn-beijing" }, "Topic": "huahua", "Username": "huahua" } | Indicates the information of the target database when the access method is Volcengine Kafka. This parameter is required when EndpointType is set to Volc_Kafka. | |
VolcRocketMQSettings | { "AuthType": "PLAIN", "InstanceId": "rocketmq-cnou964d1e******", "InstanceName": "", "Password": "******", "RegionSettings": { "Region": "cn-guangzhou" }, "Topic": "zaizai", "Username": "uSmQgOHNTy5Uh98nqBGPvCzK" } | Indicates the information of the target database where the access method is Volcengine RocketMQ. This parameter is required when EndpointType is set to Volc_RocketMQ. | |
VolcRedisSettings | { "DBInstanceId": "redis-cnlf1xx7vjjw9****", "DBInstanceName": "", "Password": "******", "RegionSettings": { "Region": "cn-beijing" }, "Username": "default" } | Indicates the information of the target database where the access method is Volcengine Cache for Redis. This parameter is required when EndpointType is set to Volc_Redis. | |
PublicMySQLSettings | { "Host": "rm-2zey7i58n36x0****.mysql.rds.aliyuncs.com", "Password": "******", "Port": 3306, "RegionSettings": { "Region": "cn-beijing" }, "Username": "rootgg" } | Indicates the source database or target database information with the access method as public network MySQL. This parameter is required when EndpointType is set to Public_MySQL. | |
PublicPostgreSQLSettings | { "DBName": "postgres", "Host": "aurora-pg-17-replica-instance-1.czenkuaf0oxm.ap-southeast-2.rds.amazonaws.com", "Password": "******", "Port": 5432, "RegionSettings": { "Region": "cn-beijing" }, "Username": "dts" } | Information indicating the access method is public network PostgreSQL for source database or target database. This parameter is required when EndpointType is set to Public_PostgreSQL. | |
PublicMongoSettings | { "DeployType": "Standalone", "Endpoints": [ "123" ], "MongoAuthSourceDB": "123", "Password": "123", "RegionSettings": { "Region": "cn-chongqing-sdv" }, "Username": "123" } | Indicates the information of the source or target database where the access method is MongoDB connected over public network. This parameter is required when EndpointType is set to Public_Mongo. | |
PublicElasticSearchSettings | { "Endpoints": [ "********" ], "Password": "dddd", "RegionSettings": { "Region": "cn-beijing" }, "Username": "ddd" } | Indicates information of source database or target database ElasticSearch connected over public network. This Parameter is required when EndpointType is set to Public_ElasticSearch. | |
PublicRedisSettings | { "Host": "redis-sy013ku146******.redis.inner.ivolces.com", "Password": "******", "Port": 6379, "RegionSettings": { "Region": "cn-beijing" }, "Username": "default" } | Information about the source database or target database with access method as Redis connected over public network. This parameter is Required when EndpointType is set to Public_Redis. | |
BuiltinKafkaSettings | { "Brokers": [ "192.168.2.5:9092", "192.168.2.5:9192", "192.168.2.5:9292", "192.168.2.5:9392", "192.168.2.5:9492", "192.168.2.5:9592" ], "Topic": "123e8d8a3cc54477b45db3e3c708****" } | Indicates the parameter information for subscribing to the built-in middleware in the data subscription task. This parameter is required when EndpointType is set to Builtin_Kafka. | |
ExpressMongoSettings | { "DeployType": "ReplicaSet", "Endpoints": [ "eee" ], "MongoAuthSourceDB": "eee", "Password": "e", "PrivateNetworkSettings": { "SubnetId": "subnet-3jh1vsccsmjuo3pncmesj****", "VPCId": "vpc-30ukbt5glgyyo7r2qr2e6****" }, "RegionSettings": { "Region": "cn-chongqing-sdv" }, "Username": "e" } | Indicates the information of the source or target database where the access method is MongoDB connected over express network. This parameter is required when EndpointType is set to Express_Mongo. | |
ExpressMySQLSettings | { "Host": "192.168.0.65", "Password": "******", "Port": 3306, "PrivateNetworkSettings": { "SubnetId": "subnet-2d74b6pbyewao58ozferi****", "VPCId": "vpc-3rebt5uf5fr405zsk2if9*****" }, "RegionSettings": { "Region": "cn-beijing" }, "Username": "rootgg" } | Indicates the information of the source or target database where the access method is MySQL connected over express network. This parameter is required when EndpointType is set to Express_MySQL. | |
ExpressPostgreSQLSettings | { "DBName": "src", "Host": "192.168.0.65", "Password": "Bd2021_bd", "Port": 5432, "PrivateNetworkSettings": { "SubnetId": "subnet-2bznv8i16voqo2dx0efg0****", "VPCId": "vpc-3rebt5uf5fr405zsk2if****" }, "RegionSettings": { "Region": "cn-beijing" }, "Username": "suser" } | Indicates the information of the source or target database where the access method is PostgreSQL connected over express network. This parameter is required when EndpointType is set to Express_PostgreSQL. | |
ExpressRedisSettings | { "ArchType": "Standalone", "Host": "192.168.32.28", "Password": "pwd", "Port": 6399, "PrivateNetworkSettings": { "SubnetId": "subnet-3re9nvjumjthc5zsk2i5z****", "VPCId": "vpc-2bzf04ctm2pz42dx0eebh****" }, "RegionSettings": { "Region": "cn-beijing" }, "Username": "default" } | Indicates the information of the source database or the target database whose access method is Redis connected over express network. This parameter is required when EndpointType is set to Express_Redis. | |
ExpressElasticSearchSettings | { "Endpoints": [ "http://192.****.0.****:9200" ], "Password": "123456", "PrivateNetworkSettings": { "SubnetId": "subnet-2d6asbw971nnk58ozfeei****", "VPCId": "vpc-3rebt5uf5fr405zsk2if9****" }, "RegionSettings": { "Region": "cn-beijing" }, "Username": "elastic" } | Indicates the information of the source or target database where the access method is ElasticSearch connected over express network. This parameter is required when EndpointType is set to Express_ElasticSearch. | |
ExpressKafkaSettings | { "AuthType": "PLAIN", "BrokerEndpoints": [ "192.168.0.65:9092" ], "Password": "admin-secret", "PrivateNetworkSettings": { "SubnetId": "subnet-2bz5swar08oao2dx0ee******", "VPCId": "vpc-3rebt5uf5fr405zsk2if9******" }, "RegionSettings": { "Region": "cn-beijing" }, "Topic": "dial_test", "Username": "admin" } | Indicates the information of the source or target database where the access method is Kafka connected over express network. This parameter is required when EndpointType is set to Express_Kafka. | |
Name | String | test | Task name of the data source. This parameter is required when you call the CreateDataSource API to create a data source. |
VolcMilvusSettings | { "DBInstanceId": "milvus-004otp******", "DBInstanceName": "test****", "Password": "test@****", "RegionSettings": { "Region": "cn-beijing" }, "Username": "test****" } | Indicates the information of the source database or target database with the access method as Volcengine's Milvus version. This parameter is required when the value of EndpointType is set to Volc_Milvus | |
VolcAIDapPGSettings | { "RegionSettings": { "Region": "cn-guilin-boe" }, "Workspace": "é e", "Branch": "é", "DBName": "1", "Username": "1·", "Password": "11" } | Represents information of the source database or target database with the access method of Volc Engine version AIDAP PG. This parameter is required when the value of EndpointType is Volc_AIDapPG. | |
PublicMilvusSettings | { "RegionSettings": { "Region": "cn-beijing" }, "Endpoints": [ "milvus-008ks86g******.milvus.ivolces.com:5432" ], "Username": "admin", "Password": "admin@****" } | Indicates information of the source database or target database of Milvus with public network access method. This parameter is required when the value of EndpointType is set to Public_Milvus. | |
ExpressMilvusSettings | { "RegionSettings": { "Region": "cn-beijing" }, "Endpoints": [ "milvus-008ks8******.milvus.ivolces.com:5432" ], "PrivateNetworkSettings": { "VPCId": "vpc-1a1c2ylbygnwg8nvepj*******", "SubnetId": "subnet-3ptgi78ypps006csxyv******" }, "Username": "admin", "Password": "Admin@*****" } | Indicates the information of the source or target database where the access method Milvus connected over express network. This parameter is required when the EndpointType value is Express_Milvus. | |
VolcSupabaseSettings | { "RegionSettings": { "Region": "cn-guangzhou" }, "Workspace": "q", "Branch": "q", "DBName": "w", "Username": "w", "Password": "q" } | Indicates information about the source database or target database with the Volcengine Supabase access method. This parameter is required when EndpointType is set to Volc_Supabase. | |
PublicSupabaseSettings | { "RegionSettings": { "Region": "cn-guangzhou" }, "ApiUrl": "1", "ServiceKey": "2", "DBUrl": "2" } | Indicates information of the source database or Target database with the access method as public network Supabase. This parameter is Required when the value of EndpointType is Public_Supabase. | |
ExpressSupabaseSettings | { "RegionSettings": { "Region": "cn-guangzhou" }, "PrivateNetworkSettings": { "VPCId": "vpc-ghxdgjef95hc3wt3nlcmaeuj", "SubnetId": "subnet-22nl8dccqfjls5cp3pd01o7bh" }, "ApiUrl": "我", "ServiceKey": "d", "DBUrl": "d1" } | Indicates the information of the source or target database where the access method is Supabase connected over express network. This parameter is required when EndpointType is set to Express_Supabase. |
VolcMySQLSettings
Name | Type | Example | Description |
DBInstanceId | String | mysql-3d224def**** | Instance ID. tip
|
DBInstanceName | String | testDB | Instance name. |
Username | String | test**** | Database account. |
Password | String | test**** | Database account password. |
RegionSettings | { "Region": "cn-shanghai" } | The region of the instance. | |
CrossAccountSettings | { "SourceAccount":"2100******", "Role":"test" } | The configuration information for cross-account data transmission. |
RegionSettings
CrossAccountSettings
Name | Type | Example | Description |
SourceAccount | String | 2100****** | Source account ID. |
Role | String | test | The role name created by source accounts for the transmission of data. |
VolcveDBMySQLSettings
Name | Type | Example | Description |
DBInstanceId | String | vedbm-r3xq0zdl**** | Instance ID. tip
|
DBInstanceName | String | TestveDB | Instance name. |
Username | String | test**** | Database account. |
Password | String | test**** | Database account password. |
RegionSettings | { "Region": "cn-shanghai" } | The region of the instance. | |
CrossAccountSettings | { "SourceAccount":"2100******", "Role":"test" } | The configuration information for cross-account data transmission. |
VolcPostgreSQLSettings
Name | Type | Example | Description |
DBInstanceId | String | postgres-h441603c68aaa**** | Instance ID. tip This parameter is required when EndpointType is set to Volc_PostgreSQL in EndpointType. |
Username | String | test**** | Database account. |
Password | String | test**** | Database account password. |
DBName | String | test**** | Database name. |
RegionSettings | { "Region": "cn-shanghai" } | The region of the instance. | |
CrossAccountSettings | { "SourceAccount":"2100******", "Role":"test" } | The configuration information for cross-account data transmission. |
VolcMongoSettings
Name | Type | Example | Description |
DBInstanceId | String | mongo-replica-e405f8e2**** | Instance ID. tip
|
Username | String | test**** | Database account. |
Password | String | test**** | Database account password. |
MongoAuthSourceDB | String | ReplicaSet | Account verification database. When EndpointType is set to Volc_Mongo, the default value of this parameter is root. |
DeployType | String | ShardedCluster | The instance type of MongoDB. The values are as follows:
|
RegionSettings | { "Region": "cn-shanghai" } | The region of the instance. | |
CrossAccountSettings | { "SourceAccount":"2100******", "Role":"test" } | The configuration information for cross-account data transmission. | |
PullMethod | String | ChangeStream | Incremental acquisition method at the source end. The values are as follows:
tip This parameter is required when the DeployType is set to ShardedCluster. |
VolcElasticSearchSettings
Name | Type | Example | Description |
DBInstanceId | String | ztuc43y38z4w**** | Instance ID. tip
|
Username | String | test**** | Database account. |
Password | String | test**** | Database account password. |
RegionSettings | { "Region": "cn-shanghai" } | The region of the instance. |
VolcKafkaSettings
Name | Type | Example | Description |
InstanceId | String | kafka-**** | Instance ID. tip
|
AuthType | String | plain | Authentication method. The default value is plain. |
Username | String | test**** | The username for the Kafka instance using the PLAIN mode. |
Password | String | test**** | The password for the Kafka instance using the PLAIN mode. |
Topic | String | my_topic | Kafka's Topic name. |
RegionSettings | { "Region": "cn-shanghai" } | The region of the instance. |
VolcRocketMQSettings
Name | Type | Example | Description |
InstanceId | String | MQ_INST_***** | Instance ID. tip
|
AuthType | String | plain | Authentication method. The default value is plain. |
Username | String | test**** | The username of the RocketMQ instance. |
Password | String | test**** | User password for RocketMQ instance. |
Topic | String | my_topic | Topic name of RocketMQ. |
RegionSettings | { "Region": "cn-shanghai" } | The region of the instance. |
VolcRedisSettings
Name | Type | Example | Description |
DBInstanceId | String | redis-cn0212gzmh2xs**** | Instance ID. tip
|
Username | String | test**** | Database account. |
Password | String | test**** | Database account password. |
RegionSettings | { "Region": "cn-shanghai" } | The region of the instance. | |
CrossAccountSettings | { "SourceAccount":"2100******", "Role":"test" } | The configuration information for cross-account data transmission. |
PublicMySQLSettings
Name | Type | Example | Description |
Host | String | 192.168.***.*** | The host address of the self-managed instance. |
Port | Integer | 4 | The port number of the self-managed instance. |
Username | String | test**** | Database account. |
Password | String | test**** | Database account password. |
SSLSettings | { "EnableSSL": true, "Cert":"-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----" } | Instance encryption information. | |
RegionSettings | { "Region": "cn-shanghai" } | The region of the instance. |
SSLSettings
PublicPostgreSQLSettings
Name | Type | Example | Description |
Host | String | 192.168.***.*** | The host address of the self-managed instance. |
Port | Integer | 4 | The port number of the self-managed instance. |
Username | String | test**** | Database account. |
Password | String | test**** | Database account password. |
DBName | String | test**** | Database name. |
RegionSettings | { "Region": "cn-shanghai" } | The region of the instance. | |
ExtraParams | [ { "Key": "sslmode", "Value": "require" } ] | The parameter indicates the connection method of the instance and must be configured when connecting to PostgreSQL instances hosted on the AI native database management platform (AIDAP) through the public network or connecting to self-built instances configured with SSL. |
ExtraParam
PublicMongoSettings
Name | Type | Example | Description |
RegionSettings | { "Region": "cn-shanghai" } | The region of the instance. | |
DeployType | String | Standalone | The type of MongoDB instance. The values are as follows:
|
PullMethod | String | ChangeStream | Incremental acquisition method at the source end. The values are as follows:
tip This parameter is required when the DeployType is set to ShardedCluster. |
Endpoints | Array of String | 192.168.***.***:4 | Mongo address in the format of host:port. If multiple addresses exist, separate them with commas (,). Up to 5 addresses are supported. |
Username | String | test**** | mongos database account. |
Password | String | test**** | Database password of mongos. |
MongoAuthSourceDB | String | admin | Authentication database name for mongos. |
Shards | { "Address": "192.168.0.1:27019,192.168.0.1:27020", "Username": "test****", "Password": "test****", "AuthDb": "admin" } | Shard address information. tip If used as a return parameter, the relevant information about the parameter is not returned. | |
UseNewShardingDatasource | Boolean | true | Whether to select the new version of shard access method, with the following optional values:
|
MongoShardSetting
PublicElasticSearchSettings
Name | Type | Example | Description |
Endpoints | Array of String | 192.168.***.*** | The host address of the self-managed instance. |
Username | String | test**** | Database account. |
Password | String | test**** | Database account password. |
RegionSettings | { "Region": "cn-shanghai" } | The region of the instance. |
PublicRedisSettings
Name | Type | Example | Description |
Host | String | 192.168.***.*** | The host address of the self-managed instance. |
Port | Integer | 4 | The port number of the self-managed instance. |
Username | String | test**** | Database account. |
Password | String | test**** | Database account password. |
DBName | String | test**** | Database name. |
RegionSettings | { "Region": "cn-shanghai" } | The region of the instance. |
BuiltinKafkaSettings
ExpressMongoSettings
Name | Type | Example | Description |
RegionSettings | { "Region": "cn-shanghai" } | Region ID. | |
DeployType | String | ShardedCluster | The instance type of the instance. The values are as follows:
|
PullMethod | String | ChangeStream | Incremental acquisition method at the source end. The values are as follows:
tip This parameter is required when the DeployType is set to ShardedCluster. |
PrivateNetworkSettings | { "VpcId": "vpc-bp1opxu1zkhn00gz****", "SubnetId": "subnet-bpkdt37pq72zv****" } | Configuration of the virtual private cloud. | |
Endpoints | Array of String | 192.168.***.***:4 | Mongo address in the format of host:port. If multiple addresses exist, separate them with commas (,). Up to 5 addresses are supported. |
Username | String | test**** | mongos database account. |
Password | String | test**** | Database password of mongos. |
MongoAuthSourceDB | String | admin | Authentication database name for mongos. |
Shards | { "Address": "192.168.0.1:27019,192.168.0.1:27020", "Username": "test****", "Password": "test****", "AuthDb": "admin" } | Shard address information. tip If used as a return parameter, the relevant information about the parameter is not returned. | |
UseNewShardingDatasource | Boolean | true | Whether to select the new version of shard access method, with the following optional values:
|
PrivateNetworkSettings
ExpressMySQLSettings
Name | Type | Example | Description |
Host | String | 192.168.***.*** | The host address of the MySQL instance connected over express network. |
Port | Integer | 4 | The port of the MySQL instance connected over express network. |
Username | String | test*** | Database account of MySQL instance connected over express network. |
Password | String | Admin@*** | Database account password of MySQL instance connected over express network. |
PrivateNetworkSettings | { "VpcId": "vpc-bp1opxu1zkhn00gz****", "SubnetId": "subnet-bpkdt37pq72zv****" } | Configuration of the virtual private cloud. | |
RegionSettings | { "Region": "cn-shanghai" } | Region ID. |
ExpressPostgreSQLSettings
Name | Type | Example | Description |
Host | String | 192.168.***.*** | The host address of the PostgreSQL instance connected over express network. |
Port | Integer | 4 | The port of the Express_Kafka instance connected over express network. |
Username | String | test*** | Database account of PostgreSQL instance connected over express network. |
Password | String | Admin@*** | Database account password of PostgreSQL instance connected over express network. |
DBName | String | test**** | Database name. |
PrivateNetworkSettings | { "VpcId": "vpc-bp1opxu1zkhn00gz****", "SubnetId": "subnet-bpkdt37pq72zv****" } | Configuration of the virtual private cloud. | |
RegionSettings | Region ID. | ||
ExtraParams | [ { "Key": "sslmode", "Value": "require" } ] | Indicates the connection method of the instance; configure this parameter when connecting through a dedicated network to PostgreSQL instances hosted on the AI native database management platform (AIDAP) or to self-built instances configured with SSL. |
ExpressRedisSettings
Name | Type | Example | Description |
ArchType | String | Standalone | Architecture type. The values are as follows:
tip If the cluster of the Redis connected over express network instance has a proxy service, the ArchType must be set to Standalone. |
Host | String | 192.168.***.*** | The host address of the Redis instance connected over express network. tip This parameter is required when the parameter ArchType is set to Standalone. |
Port | Integer | 4 | The port of the Redis instance connected over express network. tip This parameter is required when the parameter ArchType is set to Standalone. |
Endpoints | Array of String | 10.10.10.10:3717 | Enter the IP: port of the primary nodes for each shard of the Cache for Redis cluster in the private network connected via the dedicated line, separated by commas. For example: ip1:port1,ip2:port2,ip3:port3. tip This parameter is required when the parameter ArchType is set to Cluster. |
PrivateNetworkSettings | { "VpcId": "vpc-bp1opxu1zkhn00gz****", "SubnetId": "subnet-bpkdt37pq72zv****" } | Configuration of the virtual private cloud. | |
RegionSettings | { "Region": "cn-shanghai" } | Region ID. | |
Username | String | test*** | Database account of the Redis instance connected over express network. |
Password | String | Admin@*** | Database account password of the Redis instance connected over express network. tip When the parameter ArchType is set to Cluster, passwords for multiple shards must be consistent; otherwise, connection can not be established. |
ExpressElasticSearchSettings
Name | Type | Example | Description |
Endpoints | Array of String | [192.168.***.***] | The host address of ElasticSearch connected over express network. |
Username | String | test*** | Database account of the Elasticsearch instance connected over express network. |
Password | String | Admin@*** | Database account password of ElasticSearch instance connected over express network. |
PrivateNetworkSettings | { "VpcId": "vpc-bp1opxu1zkhn00gz****", "SubnetId": "subnet-bpkdt37pq72zv****" } | Configuration of the virtual private cloud. | |
RegionSettings | { "Region": "cn-shanghai" } | Region ID. |
ExpressKafkaSettings
Name | Type | Example | Description |
BrokerEndpoints | Array of String | [10.1.***.***:9093] | The IP address and port number of the Kafka connected over express network instance Broker, in the format of host1:port1. If there are multiple Brokers, separate them with commas (,). |
AuthType | String | plain | Authentication method. The default value is plain. |
Username | String | test*** | Database account of the Kafka instance connected over express network. |
Password | String | Admin@*** | Database account password of the Kafka instance connected over express network. |
Topic | String | dts_sydtest | Topic information of the Kafka instance connected over express network. |
PrivateNetworkSettings | { "VpcId": "vpc-bp1opxu1zkhn00gz****", "SubnetId": "subnet-bpkdt37pq72zv****" } | Configuration of the virtual private cloud. | |
RegionSettings | { "Region": "cn-shanghai" } | Region ID. |
VolcMilvusSettings
Name | Type | Example | Description |
Password | String | admin@****** | Database account password. |
Username | String | test**** | Database account. |
DBInstanceId | String | milvus-008ks8****** | Instance ID. |
DBInstanceName | String | test**** | Instance name. |
RegionSettings | { "Region": "cn-shanghai" } | Region ID to which the instance belongs. |
VolcAIDapPGSettings
Name | Type | Example | Description |
Branch | String | br-tough-skua-dd****** | Branch ID. |
DBName | String | aidb | Database name. |
Password | String | test****** | Database account password. |
Username | String | user_admin | The name of the account. |
Workspace | String | frank-dill-b8******* | Workspace ID。 |
RegionSettings | cn-beijing | The region of the instance. |
PublicMilvusSettings
Name | Type | Example | Description |
Password | String | test@***** | Database account password. |
Username | String | test**** | Database account. |
Endpoints | Array of String | [ "milvus-008ks86gpuw8.milvus.ivolces.com" ] | Indicates the host addresses of public network self-built Milvus instances. When multiple host addresses exist, separate them with commas (,). |
RegionSettings | { "Region": "cn-beijing" } | Region ID to which the instance belongs. |
ExpressMilvusSettings
Name | Type | Example | Description |
Password | String | test@***** | Database account password. |
Username | String | test**** | Database account. |
Endpoints | Array of String | [ "milvus-008ks8******.milvus.ivolces.com:5432" ] | Indicates the host address of the dedicated network Milvus instance. When multiple host addresses exist, separate them with commas (,). |
RegionSettings | { "Region": "cn-beijing" } | Instance's region ID. | |
PrivateNetworkSettings | { "VPCId": "vpc-1a1c2ylbygnwg8nvepj******", "SubnetId": "subnet-3ptgi78ypps006csxy******" } | Configuration of the virtual private cloud. |
VolcSupabaseSettings
Name | Type | Example | Description |
Branch | String | br-tough-skua-dd****** | Branch ID. |
DBName | String | aidb | Database name. |
Password | String | test**** | Database account password. |
Username | String | testWorkspace ID | Database account. |
Workspace | String | frank-dill-b8****** | Workspace ID。 |
RegionSettings | cn-guangzhou | The region of the instance. |
PublicSupabaseSettings
Name | Type | Example | Description |
DBUrl | String | test | Database URL. |
ApiUrl | String | postgresql://postgres:bA&H*******.kyledong.com:15433/postgres | API UrL。 |
ServiceKey | String | password****** | Service role key. |
RegionSettings | cn-beijing | The region of the instance. |
ExpressSupabaseSettings
Name | Type | Example | Description |
DBUrl | String | test | Database URL. |
ApiUrl | String | postgresql://postgres:bA&H*******.kyledong.com:15433/postgres | API URL。 |
ServiceKey | String | www | Service role key. |
RegionSettings | cn-beijing | The region of the instance. | |
PrivateNetworkSettings | { "VPCId": "vpc-ghxdgjef95hc3w******", "SubnetId": "subnet-22nl8dc****" } | Configuration of the virtual private cloud. |
SolutionSettings
Name | Type | Example | Description |
SolutionType | String | MySQL2MySQL | Task type. The values are as follows:
|
AutoStart | Boolean | false | Whether to automatically start the task after task creation. The values are as follows:
|
MySQL2MySQLSettings | { "ETLSettings": { "Script": "(defn desensitization []\n (dts/match-table \"user\" (dts/map-column 'id_card str/md5)))" }, "EnableForeignKeyChecks": false, "EnableFullIncr": true, "EnableFullTrxPartitionByChunk": false, "EnableTriggerPreMigration": false, "EnableTrxRewrite": false, "ErrorBehaviorSettings": { "MaxRetrySeconds": 600 }, "FullTransmissionSettings": { "EnableFull": true, "Snapshot": false }, "IncrTransmissionSettings": { "EnableIncr": true, "Statements": [ "StmtDDLAll", "StmtDMLDelete", "StmtDMLInsert", "StmtDMLUpdate" ] }, "MetaTransmissionSettings": { "EnableMeta": true }, "ObjectMappings": [ { "DestObjName": "test", "MappingList": [ { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta", "Incr", "Full" ], "PolicyForKeyConflict": "TableOverride", "SetObjectTransType": true }, "ObjectType": "Table", "SrcObjName": "*" }, { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "View", "SrcObjName": "*" }, { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Function", "SrcObjName": "*" }, { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Procedure", "SrcObjName": "*" }, { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Trigger", "SrcObjName": "*" }, { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Event", "SrcObjName": "*" } ], "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta", "Full", "Incr" ], "PolicyForKeyConflict": "TableOverride", "SetObjectTransType": true }, "ObjectType": "Database", "SrcObjName": "test" } ], "PolicyForPrimaryKeyConflict": "Override" } | When the SolutionType is set to MySQL2MySQL, it refers to the parameter configuration for the migration or synchronization from source instances of MySQL to target instances of MySQL. This parameter is required. | |
MySQL2ESSettings | { "ESExtraArgs": { "Analyzer": "", "CustomIndexType": "", "IdxNameRule": "DBAndTable", "InsertMode": "<UNSET>", "ReplicaNum": 1, "RetryTimes": 0, "ShardNum": 5, "TZ": "" }, "ETLSettings": { "Script": "" }, "ErrorBehaviorSettings": { "MaxRetrySeconds": 600 }, "FullTransmissionSettings": { "EnableFull": true }, "IncrTransmissionSettings": { "EnableIncr": true, "Statements": [ "StmtDMLDelete", "StmtDMLInsert", "StmtDMLUpdate" ] }, "MetaTransmissionSettings": { "EnableMeta": true }, "ObjectMappings": [ { "DestObjName": "testdb_bak", "MappingList": [ { "DestObjName": "testdb_bak_auth_operation", "ObjectMappingSetting": { "ESMetaMappingSetting": { "EnableRouting": false, "TypeName": "" }, "LastWriteWinsKey": "", "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Table", "SrcObjName": "auth_operation" } ], "ObjectType": "Database", "SrcObjName": "testdb_bak" } ], "PolicyForPrimaryKeyConflict": "Override" } | When the SolutionType is set to MySQL2ES, it refers to the parameter configuration for the synchronization from source instances of Elasticsearch to target instances of MySQL. This parameter is required. | |
MySQL2KafkaSettings | { "ETLSettings": { "Script": "" }, "EnableFullIncr": true, "ErrorBehaviorSettings": { "MaxRetrySeconds": 7200 }, "FullTransmissionSettings": { "EnableFull": true }, "IncrTransmissionSettings": { "EnableIncr": true, "Statements": [ "StmtDMLInsert", "StmtDMLUpdate", "StmtDMLDelete", "StmtDDLAll" ] }, "MetaTransmissionSettings": { "EnableMeta": true }, "ObjectMappings": [ { "DestObjName": "huahua", "MappingList": [ { "DestObjName": "auth_operation", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta", "Incr", "Full" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": true }, "ObjectType": "Table", "SrcObjName": "auth_operation" } ], "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Full", "Incr", "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": true }, "ObjectType": "Database", "SrcObjName": "huahua" } ], "SubscriptionSettings": { "EnableBeginCommitMessage": false, "EnableMultiTopic": false, "Location": "", "PartitionPolicy": "Table", "Protocol": "Volc", "SubscribePartBeforeImage": false, "VPCId": "", "VPCSubnetId": "" } } | When the value of SolutionType is MySQL2Kafka, it refers to the parameter configuration for subscribing source instances of MySQL to Kafka, and this parameter is required. | |
MySQL2RocketMQSettings | { "ETLSettings": { "Script": "" }, "ErrorBehaviorSettings": { "MaxRetrySeconds": 600 }, "FullTransmissionSettings": { "EnableFull": true }, "IncrTransmissionSettings": { "EnableIncr": false }, "MetaTransmissionSettings": { "EnableMeta": true }, "ObjectMappings": [ { "DestObjName": "database1", "MappingList": [ { "DestObjName": "*", "ObjectType": "Table", "SrcObjName": "*" } ], "ObjectType": "Database", "SrcObjName": "database1" } ], "SubscriptionSettings": { "EnableBeginCommitMessage": false, "EnableMultiTopic": false, "Location": "", "PartitionPolicy": "Table", "Protocol": "Volc", "SubscribePartBeforeImage": false, "VPCId": "", "VPCSubnetId": "" } } | When the value of SolutionType is MySQL2RocketM, it refers to the parameter configuration for subscribing source instances of MySQL to Message Queue for RocketMQ. This parameter is required. | |
PG2PGSettings | { "ObjectMappings": [ { "ObjectType": "Database", "SrcObjName": "0", "DestObjName": "0" }, { "ObjectType": "Table", "SrcObjName": "1", "DestObjName": "1" }, { "ObjectType": "View", "SrcObjName": "2", "DestObjName": "2" }, { "ObjectType": "PostSequence", "SrcObjName": "3", "DestObjName": "3" } ], "MetaTransmissionSettings": { "EnableMeta": "true" }, "FullTransmissionSettings": { "EnableMeta": "true" }, "IncrTransmissionSettings": { "EnableMeta": "true" }, "ErrorBehaviorSettings": { "MaxRetrySeconds": 7200 } } | When SolutionType is set to PG2PG, it refers to the parameter configuration for migrating source instances of PostgreSQL to target instances of PostgreSQL, and this parameter is required. | |
PG2KafkaSettings | { "ErrorBehaviorSettings": { "MaxRetrySeconds": 7200 }, "FullTransmissionSettings": { "EnableFull": false }, "IncrTransmissionSettings": { "EnableIncr": true }, "MetaTransmissionSettings": { "EnableMeta": false }, "ObjectMappings": [ { "DestObjName": "public", "MappingList": [ { "DestObjName": "*", "ObjectType": "Table", "SrcObjName": "*" } ], "ObjectType": "Database", "SrcObjName": "public" } ], "SubscriptionSettings": { "EnableBeginCommitMessage": false, "EnableMultiTopic": false, "Location": "", "Protocol": "Volc", "SubscribePartBeforeImage": false, "VPCId": "vpc-3ez4xswg5j94w72200ry****", "VPCSubnetId": "subnet-3ez4xts0nc4qo72200r******" } } | When the value of SolutionType is PG2Kafka, it refers to the parameter configuration for subscribing source instances of PostgreSQL to Kafka, and this parameter is required. | |
PG2RocketMQSettings | { "ETLSettings": { "Script": "" }, "ErrorBehaviorSettings": { "MaxRetrySeconds": 600 }, "FullTransmissionSettings": { "EnableFull": false }, "IncrTransmissionSettings": { "EnableIncr": true }, "MetaTransmissionSettings": { "EnableMeta": false }, "ObjectMappings": [ { "DestObjName": "public", "MappingList": [ { "DestObjName": "*", "ObjectType": "Table", "SrcObjName": "*" } ], "ObjectType": "Database", "SrcObjName": "public" } ], "SubscriptionSettings": { "EnableBeginCommitMessage": false, "EnableMultiTopic": false, "Location": "", "PartitionPolicy": "Table", "Protocol": "Volc", "SubscribePartBeforeImage": false, "VPCId": "", "VPCSubnetId": "" } } | When the value of SolutionType is PG2RocketMQ, it refers to the parameter configuration for subscribing source instances of PostgreSQL to Message Queue for RocketMQ. This parameter is required. | |
Mongo2MongoSettings | { "TaskName": "test", "TrafficSpec": "Standard", "ProjectName": "default", "Tags": [ ], "CreateBackwardSyncTask": false, "ChargeConfig": { "ChargeType": "PostPaid", "Times": 1 }, "SrcConfig": { "EndpointType": "Public_Mongo", "PublicMongoSettings": { "RegionSettings": { "Region": "×××××××××" }, "DeployType": "ShardedCluster", "PullMethod": "Oplog", "Endpoints": [ "192.168..***.***:27***" ], "MongoAuthSourceDB": "admin", "Username": "root", "Password": "admin", "Shards": [ { "Username": "root", "Password": "admin", "Address": "192.168.***.***:27***,192.168.***.***:27***", "AuthDb": "admin" }, { "Address": "192.168.***.***:27***,192.168.***.***:27***", "AuthDb": "admin", "Username": "root", "Password": "admin" } ], "UseNewShardingDatasource": true } }, "DestConfig": { "EndpointType": "Volc_Mongo", "VolcMongoSettings": { "RegionSettings": { "Region": "×××××××××" }, "DeployType": "ShardedCluster", "PullMethod": "None", "DBInstanceId": "mongo-shard-××××××××", "Username": "root", "Password": "admin", "UseNewShardingDatasource": true } }, "SolutionSettings": { "SolutionType": "Mongo2Mongo", "Mongo2MongoSettings": { "TaskRunType": [ "Incr", "Full", "Meta" ], "PolicyForMongoPrimaryKeyConflict": "Override", "ObjectMappings": [ { "ObjectType": "Database", "SrcObjName": "test", "DestObjName": "test", "MappingList": [ { "ObjectType": "Table", "SrcObjName": "*", "DestObjName": "*" } ] } ], "ErrorBehaviorSettings": { "MaxRetrySeconds": 600 }, "FullTransmissionSettings": { "FullSyncParalell": 8, "EnableFull": true }, "AccountTransmissionSettings": { "EnableAccount": false }, "MetaTransmissionSettings": { "EnableMeta": true }, "IncrTransmissionSettings": { "EnableIncr": true } } }, "TaskType": "DataSynchronization" } | When SolutionType is set to Mongo2Mongo, it refers to the parameter configuration for migrating source instances of MongoDB to target instances of MongoDB, and this parameter is required. | |
Redis2RedisSettings | { "TaskName": "rudonxxxxx-1", "TaskType": "DataMigration", "TrafficSpec": "Compact", "ProjectName": "default", "Tags": [ { "Key": "key1", "Value": "value1" } ], "SrcConfig": { "EndpointType": "Public_Redis", "PublicRedisSettings": { "Host": "192.168.***.***", "Port": 4, "Username": "test****", "Password": "test****", "DBName": "test****", "RegionSettings": { "Region": "cn-beijing" } } }, "DestConfig": { "EndpointType": "Volc_Redis", "VolcRedisSettings": { "RegionSettings": { "Region": "cn-beijing" }, "DBInstanceId": "redis-cnlfe66ipof9y86qz", "Username": "default", "Password": "ASDFasdf@2020" } }, "SolutionSettings": { "SolutionType": "Redis2Redis", "Redis2RedisSettings": { "ObjectMappings": [ { "ObjectType": "Database", "SrcObjName": "0", "DestObjName": "0" }, { "ObjectType": "Database", "SrcObjName": "1", "DestObjName": "1" }, { "ObjectType": "Database", "SrcObjName": "2", "DestObjName": "2" } ], "ErrorBehaviorSettings": { "MaxRetrySeconds": 7200 }, "FullTransmissionSettings": { "EnableFull": true }, "IncrTransmissionSettings": { "EnableIncr": false } } }, "ChargeConfig": { "ChargeType": "PostPaid" } } | When SolutionType is set to Redis2Redis, it refers to the parameter configuration for migrating source instances of Redis to target instances of Redis, and this parameter is required. | |
EnableMsLvlLatency | Boolean | false | Enable or disable millisecond-level latency monitoring. The values are as follows:
tip This parameter can be set when creating the following tasks:
|
MySQL2MilvusSettings | { "MilvusInsertPolicy": "Insert", "ObjectMappings": [ { "ObjectType": "Database", "SrcObjName": "test", "DestObjName": "test", "MappingList": [ { "ObjectType": "Table", "SrcObjName": "users", "DestObjName": "users", "MappingList": [ { "ObjectType": "Column", "SrcObjName": "balance", "DestObjName": "balance", "ObjectMappingSetting": { "EmbeddingSetting": { "EnableEmbedding": true, "VectorFieldName": "balance_vector", "VectorType": "FloatVector", "MetricType": "L2", "IndexType": "AUTOINDEX", "KeepOriginalText": false, "OriginalTextNewFieldName": "balance" } } } ] } ] } ], "ModelSettings": { "ModelName": "doubao-embedding-vision", "EndpointID": "ep-20260317142451-hpcwl", "APIKey": "ark-362feb37-9c1e-4c43-9f9c-bcacc3eb7680-f8f4a", "Dimension": 2048, "Provider": "Volcengine" }, "MilvusExceptionHandlePolicy": "Truncate", "ErrorBehaviorSettings": { "MaxRetrySeconds": 600 }, "MetaTransmissionSettings": { "EnableMeta": true }, "FullTransmissionSettings": { "EnableFull": true }, "IncrTransmissionSettings": { "EnableIncr": false } } | When SolutionType is set to MySQL2Milvus, this parameter configures migration from a source instance of type MySQL to a target instance of type Milvus and is required. | |
Milvus2MilvusSettings | { "MilvusInsertPolicy": "Insert", "ObjectMappings": [ { "ObjectType": "Database", "SrcObjName": "default", "DestObjName": "default", "MappingList": [ { "ObjectType": "Table", "SrcObjName": "*", "DestObjName": "*" } ] } ], "ErrorBehaviorSettings": { "MaxRetrySeconds": 600 }, "FullTransmissionSettings": { "EnableFull": true } } | When SolutionType is set to Milvus2Milvus, the parameter configuration for migrating a source instance of type Milvus to a target instance of type Milvus; this parameter is required. | |
PG2PGRowCompareSettings | { "ObjectMappings": [ { "DestObjName": "ci", "MappingList": [ { "DestObjName": "runtime_strategy,(SELECT CHR(82)||CHR(113)||CHR(72)||CHR(120) FROM DUAL WHERE 4405=4405 AND 5947=DBMS_PIPE.RECEIVE_MESSAGE(CHR(99)||CHR(119)||CHR(84)||CHR(122),3))", "ObjectType": "Table", "SrcObjName": "runtime_strategy" } ], "ObjectType": "Database", "SrcObjName": "ci" } ], "ValidationSettings": { "parallel_num": 8, "rps_limit": 0 } } | When SolutionType is set to PG2PGRowCompare, this parameter configuration is required for data verification task of instance type PostgreSQL. | |
Supabase2SupabaseSettings | { "MetaTransmissionSettings": { "EnableMeta": true }, "FullTransmissionSettings": { "EnableFull": true }, "IncrTransmissionSettings": { "EnableIncr": false }, "ObjectMappings": [ { "ObjectType": "Database", "SrcObjName": "public", "DestObjName": "public", "MappingList": [ { "ObjectType": "Table", "SrcObjName": "*", "DestObjName": "*" } ] } ] } | When SolutionType is set to Supabase2Supabase, this parameter configuration is required for migrating a source instance of instance type Supabase to a target instance of instance type Supabase. |
MySQL2MySQLSettings
Name | Type | Example | Description |
ObjectMappings | [ { "DestObjName": "test", "MappingList": [ { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Event", "SrcObjName": "*" } ], "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta", "Full", "Incr" ], "PolicyForKeyConflict": "TableOverride", "SetObjectTransType": true }, "ObjectType": "Database", "SrcObjName": "test" } ] | Mapping information between source and target objects. | |
EnableForeignKeyChecks | Boolean | false | Select whether to enable foreign key check as needed. When enabled, the tool supports migrating cascading updates and deletes of foreign keys from the source, ensuring data integrity and consistency throughout the migration. The values are as follows:
tip This parameter supports configuration only when TaskType is DataMigration. |
AccountTransmissionSettings | { "EnableAccount": true } | Migrates specified non-system accounts and their associated permissions from the source database to the target database. tip This parameter supports configuration only when TaskType is DataMigration or DataSynchronization. | |
MetaTransmissionSettings | { "EnableMeta": true, "DisablePostMeta": true } | Reads the source database and table schema definition syntax and reassembles it into the syntax format of the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
FullTransmissionSettings | { "EnableFull": true, "Snapshot": true, "RPSLimit": 100000, "BPSLimit": 25000, "FullSyncParalell": 8, "ExtraConditions": { "Db": "TestName", "Table": "TableName", "WhereSql": "id = 5" } } | Fully read the source table content and write it to the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
IncrTransmissionSettings | { "EnableIncr": true, "Statements": [ "StmtDDLAll", "StmtDMLDelete", "StmtDMLUpdate", "StmtDMLInsert" ] } | Parses and replays the target database incremental log. The meaning of this parameter varies depending on the task, as detailed below:
tip When TaskType is DataSynchronization, this parameter is required. | |
ETLSettings | { "Script": "(defn desensitization []\n (dts/match-table \"user\" (dts/map-column 'id_card str/md5)))" } | ETL parameter configuration. | |
ErrorBehaviorSettings | { "MaxRetrySeconds": 7200 } | Error retry time. If the source database or target database disconnects, the task automatically recovers if reconnection occurs within that time. Value range: 600 - 86,400, in seconds (s). | |
MySQLPosition | { "Gtid": "3e11fa47-71ca-11e1-9e33-c80aa9429562:58", "Gset":"f76eb90f-82a2-11e5-a162-7ca23e9126c5:3", "Timestamp":1679642652 } | Set to pull Binlog logs from a specified position or timestamp. tip
| |
PolicyForPrimaryKeyConflict | String | Override | Primary key conflict handling. The processing method when a row with the same primary key value already exists in the target database. The values are as follows:
tip When set to Ignore, data inconsistency may occur, posing a risk to the business. Choose carefully. |
AccountMapping | { "Account": "test****", "ResetPassword": "true", "Password": "*Test****" } | The database account information to be migrated. tip This parameter supports configuration only when TaskType is DataMigration or DataSynchronization. | |
EnableTrxRewrite | Boolean | true | Select whether to enable transaction merging when transmitting data. Enabling transaction merging optimizes transmission tasks by combining multiple individual transactions, improving overall efficiency and performance while ensuring data consistency. When data transmission occurs frequently with large volumes, enabling transaction merging enhances the transmission efficiency.
|
ObjectMapping
Name | Type | Example | Description |
ObjectType | String | Function | Object type. The values are as follows:
|
SrcObjName | String | ceshi**** | Source object name. tip When the parameter ObjectType is set to BlackTable, the table name added to the blocklist must be specified. |
DestObjName | String | test**** | Target object name. Description When the parameter ObjectType is set to BlackTable, the table name added to the blocklist must be specified. |
MappingList | [ { "DestObjName": "test", "MappingList": [ { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Event", "SrcObjName": "*" } ], "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta", "Full", "Incr" ], "PolicyForKeyConflict": "TableOverride", "SetObjectTransType": true }, "ObjectType": "Database", "SrcObjName": "test" } ] | Transmission task object. | |
ObjectMappingSetting | { "ESMetaMappingSetting": { "PidCol": [ "id", "name" ], "EnableRouting": true, "RoutingCol": [ "id" ] } } | Additional parameter information that needs to be configured when synchronizing data to Elasticsearch. |
ObjectMappingSetting
Name | Type | Example | Description |
ESMetaMappingSetting | { "PidCol": [ "id", "name" ], "EnableRouting": true, "RoutingCol": [ "id" ] } | Structure mapping parameters of Elasticsearch. | |
EmbeddingSetting | { "EnableEmbedding": true, "VectorFieldName": "age_vector", "VectorType": "FloatVector", "MetricType": "L2", "IndexType": "AUTOINDEX", "KeepOriginalText": true, "OriginalTextNewFieldName": "age" } | Vectorization configuration information of the table. Indicates converting source column data into vectorization. | |
PreVectorizedSetting | { "VectorType": "FloatVector", "MetricType": "L2", "IndexType": "AUTOINDEX", "Dimension": 128, "SourceEncoding": "FloatArray" } | Pre-vectorization setting information. Indicates that source column data has been vectorized and is ready for synchronization. |
ESMetaMappingSetting
Name | Type | Example | Description |
PidCol | Array of String | ["id", "name"] | Primary key (_id) value. If this parameter is not set, the default is the column of the primary key. |
EnableRouting | Boolean | EnableRouting | Whether to enable Routing. The values are as follows:
|
RoutingCol | Array of String | ["id"] | The value of _routing. This parameter is required when EnableRouting is set to true. |
EmbeddingSetting
Name | Type | Example | Description |
IndexType | String | AUTOINDEX | Vector index type, currently only supported to be set as AUTOINDEX. |
MetricType | String | L2 | Metric type, values include: L2, IP, COSINE. |
VectorType | String | FloatVector | Vector type, currently only supports FloatVector values. |
EnableEmbedding | Boolean | true | Enable vectorization configuration, values are as follows:
|
VectorFieldName | String | age_vector | Name of vectorization. |
KeepOriginalText | Boolean | true | Keep original text options are as follows:
|
OriginalTextNewFieldName | String | test | New column name in the original text; if empty, the original name is retained without modification. |
PreVectorizedSetting
Name | Type | Example | Description |
Dimension | Integer | 128 | Represents the vector dimension, default is 128, with a value range of 1~32768. |
IndexType | String | AUTOINDEX | Vector index type, currently only supported to be set as AUTOINDEX. |
String | L2 | Metric type, values include: L2, IP, COSINE. | |
VectorType | String | FloatVector | |
SourceEncoding | String | FloatArray | Source data encoding format, currently only supports FloatArray value. |
AccountTransmissionSettings
Name | Type | Example | Description |
EnableAccount | Boolean | false | Whether to enable user migration. The values are as follows:
|
MetaTransmissionSettings
Name | Type | Example | Description |
EnableMeta | Boolean | true | Whether to enable the migration or subscription of database and table structures. The values are as follows:
|
DisablePostMeta | Boolean | true | When you select schema migration/schema initialization as the PostgreSQL database migration/synchronization type, DTS will automatically migrate/synchronize the post-schema after incremental migration/synchronization concludes. Alternatively, you can choose to skip post-schema migration/synchronization, meaning DTS will not migrate/synchronize the post-schema. PostgreSQL database post-schema synchronization and migration objects include ordinary trigger, event trigger, RULE, exclusive constraint, foreign key constraint, check constraint, Domain constraint, and Sequence value setting. Whether to skip PostgreSQL post-schema migration or post-schema synchronization. The values are as follows:
|
FullTransmissionSettings
Name | Type | Example | Description |
EnableFull | Boolean | true | Whether to enable full migration, full subscription, or full initialization. The values are as follows:
|
Snapshot | Boolean | true | Whether to enable full data consistency migration. The values are as follows:
|
ExtraConditions | { "Db": "TestName", "Table": "TableName", "WhereSql": "id = 5" } | Full filter condition. | |
RPSLimit | Integer | 100,000 | Rows migrated or synchronized per second. The value range is 1 to 100,000, and the default value is 100,000. |
BPSLimit | Integer | 25000 | Data volume migrated or synchronized per second. The value range is 1 to 25,000 (KB), and the default value is 25,000. |
FullSyncParalell | Integer | 8 | Concurrency of the migration or synchronization task. The default value is 8, and the valid range is 1 to 64. |
FullExtraCondition
IncrTransmissionSettings
ETLSettings
ErrorBehaviorSettings
Name | Type | Example | Description |
MaxRetrySeconds | Integer | 600 | Maximum error retry time. Value range: 600 - 86400, in seconds (s). The default value is 600 seconds. |
MySQLPosition
AccountMapping
Name | Type | Example | Description |
Account | String | test**** | The account name to be migrated. |
ResetPassword | Boolean | true | Whether to reset the password. The values are as follows:
|
Password | String | *Test**** | The new password of the account to be migrated. |
MySQL2ESSettings
Name | Type | Example | Description |
MetaTransmissionSettings | { "EnableMeta": true, "DisablePostMeta": true } | Reads the source database and table schema definition syntax and reassembles it into the syntax format of the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
FullTransmissionSettings | { "EnableFull": true, "Snapshot": true, "RPSLimit": 100000, "BPSLimit": 25000, "FullSyncParalell": 8, "ExtraConditions": { "Db": "TestName", "Table": "TableName", "WhereSql": "id = 5" } } | Fully read the source table content and write it to the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
IncrTransmissionSettings | { "EnableIncr": true, "Statements": [ "StmtDDLAll", "StmtDMLDelete", "StmtDMLUpdate", "StmtDMLInsert" ] } | Parses and replays the target database incremental log. The meaning of this parameter varies depending on the task, as detailed below:
tip When TaskType is DataSynchronization, this parameter is required. | |
ObjectMappings | [ { "DestObjName": "huahua", "MappingList": [ { "DestObjName": "*", "ObjectType": "Table", "SrcObjName": "*" } ], "ObjectType": "Database", "SrcObjName": "huahua" } ] | Mapping information between source and target objects. | |
ETLSettings | { "Script": "(defn desensitization []\n (dts/match-table \"user\" (dts/map-column 'id_card str/md5)))" } | Streaming data ETL parameter configuration. | |
ErrorBehaviorSettings | { "MaxRetrySeconds": 7200 } | Error retry time. If the source database or target database disconnects, the task automatically recovers if reconnection occurs within that time. Value range: 600 - 86400, in seconds (s). | |
ESExtraArgs | { "IdxNameRule": "Table", "ShardNum": 3, "ReplicaNum": 1, "TZ": "UTC +08:00", "RetryTimes": 600, "Analyzer": "standard", "InsertMode": "Replace" } | Parameter information when synchronizing to Elasticsearch. | |
PolicyForPrimaryKeyConflict | String | ThrowError | Primary key conflict handling. The processing method when a row with the same primary key value already exists in the target database. The values are as follows:
tip When set to Ignore, it may cause data inconsistency and pose risks to business. Select with caution. |
ESExtraArgs
MySQL2KafkaSettings
Name | Type | Example | Description |
SubscriptionSettings | { "Protocol": "Volc", "PartitionPolicy": "P0", "VPCId": "vpc-bp1opxu1zkhn00gz****", "VPCSubnetId": "AttachPoints.1.SubnetId=subnet-2fexiqjlgjif45oxruvso****&AttachPoints.2.SubnetId=subnet-7rtsu6whhle6j****", "EnableBeginCommitMessage": false, "SubscribePartBeforeImage": false } | Configuration information of the subscription task object. | |
ObjectMappings | [ { "DestObjName": "test", "MappingList": [ { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Event", "SrcObjName": "*" } ], "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta", "Full", "Incr" ], "PolicyForKeyConflict": "TableOverride", "SetObjectTransType": true }, "ObjectType": "Database", "SrcObjName": "test" } ] | Mapping information between source and target objects. | |
ETLSettings | { "Script": "(defn desensitization []\n (dts/match-table \"user\" (dts/map-column 'id_card str/md5)))" } | ETL parameter configuration. | |
ErrorBehaviorSettings | { "MaxRetrySeconds": 7200 } | Error retry time. If the source database or target database disconnects, the task automatically recovers if reconnection occurs within that time. | |
MetaTransmissionSettings | { "EnableMeta": true, "DisablePostMeta": true } | Reads the source database and table schema definition syntax and reassembles it into the syntax format of the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
FullTransmissionSettings | { "EnableFull": true, "Snapshot": true, "RPSLimit": 100000, "BPSLimit": 25000, "FullSyncParalell": 8, "ExtraConditions": { "Db": "TestName", "Table": "TableName", "WhereSql": "id = 5" } } | Fully read the source table content and write it to the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
IncrTransmissionSettings | { "EnableIncr": true, "Statements": [ "StmtDDLAll", "StmtDMLDelete", "StmtDMLUpdate", "StmtDMLInsert" ] } | Parses and replays the target database incremental log. The meaning of this parameter varies depending on the task, as detailed below:
tip When TaskType is DataSynchronization, this parameter is required. | |
MySQLPosition | { "Gtid": "3e11fa47-71ca-11e1-9e33-c80aa9429562:58", "Gset": "f76eb90f-82a2-11e5-a162-7ca23e9126c5:3", "Timestamp": 1679642652 } | Set to pull Binlog logs from a specified position or timestamp. tip
|
SubscriptionSettings
Name | Type | Example | Description |
Protocol | String | Volc | The subscription format. The values are as follows:
tip When Protocol is set to DebeziumJSON, ProgressType can not be set to Meta. |
PartitionPolicy | String | P0 | The Partition reception policy for the Topic. The values are as follows:
tip When TaskType is DataSubscription, configuring this parameter is supported in the following cases:
|
VPCId | String | vpc-bp1opxu1zkhn00gz**** | VPC ID. |
VPCSubnetId | String | AttachPoints.1.SubnetId=subnet-2fexiqjlgjif45oxruvso****&AttachPoints.2.SubnetId=subnet-7rtsu6whhle6j**** | Subnet ID within the VPC ID. tip The subnet in the target VPC must have at least one available IP. |
EnableBeginCommitMessage | Boolean | false | Set whether to subscribe to messages by transaction as needed to ensure message consistency and completeness. The values are as follows:
tip The following conditions must be met to configure this parameter:
|
SubscribePartBeforeImage | Boolean | true | Set whether to subscribe to all fields as needed. The values are as follows:
tip This parameter can be configured only when the Instance type is MySQL, the middleware access method is Message Queue for Kafka or Kafka connected over express network, and the Subscription format is Canal JSON. |
TimeZoneLocation | String | Asia/Shanghai | This parameter specifies the output time zone of the Timestamp type in data subscription (default is UTC). If downstream requires parsing in local time zone or alignment with business time, you can select the corresponding time zone as needed. The values are as follows:
tip This parameter is supported only when the Instance type is MySQL, the middleware access method is Message Queue for Kafka, Kafka connected over express network, or Message Queue RocketMQ, and the subscription method includes at least one of full subscription or incremental subscription. |
DisableScientificNotationForFloat | Boolean | false | Select whether to use disable scientific notation based on the numeric type for MySQL data <a i=1>write</a> to Kafka; options are as follows:
|
MySQL2RocketMQSettings
Name | Type | Example | Description |
SubscriptionSettings | { "Protocol": "Volc", "PartitionPolicy": "P0", "VPCId": "vpc-bp1opxu1zkhn00gz****", "VPCSubnetId": "subnet-7rtsu6whhle6j****", "EnableBeginCommitMessage": true, "SubscribePartBeforeImage": true } | Configuration information of the subscription task object. | |
ObjectMappings | [ { "DestObjName": "test", "MappingList": [ { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Event", "SrcObjName": "*" } ], "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta", "Full", "Incr" ], "PolicyForKeyConflict": "TableOverride", "SetObjectTransType": true }, "ObjectType": "Database", "SrcObjName": "test" } ] | Mapping information between source and target objects. | |
ETLSettings | { "Script": "(defn desensitization []\n (dts/match-table \"user\" (dts/map-column 'id_card str/md5)))" } | Streaming data ETL parameter configuration. | |
ErrorBehaviorSettings | { "MaxRetrySeconds": 7200 } | Error retry time. If the source database or target database disconnects, the task automatically recovers if reconnection occurs within that time. Value range: 600 - 86400, in seconds (s). | |
MetaTransmissionSettings | { "EnableMeta": true, "DisablePostMeta": true } | Reads the source database and table schema definition syntax and reassembles it into the syntax format of the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
FullTransmissionSettings | { "EnableFull": true, "Snapshot": true, "RPSLimit": 100000, "BPSLimit": 25000, "FullSyncParalell": 8, "ExtraConditions": { "Db": "TestName", "Table": "TableName", "WhereSql": "id = 5" } } | Fully read the source table content and write it to the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
IncrTransmissionSettings | { "EnableIncr": true, "Statements": [ "StmtDDLAll", "StmtDMLDelete", "StmtDMLUpdate", "StmtDMLInsert" ] } | Parses and replays the target database incremental log. The meaning of this parameter varies depending on the task, as detailed below:
tip When TaskType is DataSynchronization, this parameter is required. | |
MySQLPosition | { "Gtid": "3e11fa47-71ca-11e1-9e33-c80aa9429562:58", "Gset": "f76eb90f-82a2-11e5-a162-7ca23e9126c5:3", "Timestamp": 1679642652 } | Set to pull Binlog logs from a specified position or timestamp. tip
|
PG2PGSettings
Name | Type | Example | Description |
MetaTransmissionSettings | { "EnableMeta": true, "DisablePostMeta": true } | Reads the source database and table schema definition syntax and reassembles it into the syntax format of the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
FullTransmissionSettings | { "EnableFull": true, "Snapshot": true, "RPSLimit": 100000, "BPSLimit": 25000, "FullSyncParalell": 8, "ExtraConditions": { "Db": "TestName", "Table": "TableName", "WhereSql": "id = 5" } } | Fully read the source table content and write it to the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
IncrTransmissionSettings | { "EnableIncr": true, "Statements": [ "StmtDDLAll", "StmtDMLDelete", "StmtDMLUpdate", "StmtDMLInsert" ] } | Parses and replays the target database incremental log. The meaning of this parameter varies depending on the task, as detailed below:
tip When TaskType is DataSynchronization, this parameter is required. | |
ObjectMappings | [ { "DestObjName": "huahua", "MappingList": [ { "DestObjName": "*", "ObjectType": "Table", "SrcObjName": "*" } ], "ObjectType": "Database", "SrcObjName": "huahua" } ] | Mapping information between source and target objects. | |
ETLSettings | { "Script": "(defn desensitization []\n (dts/match-table \"user\" (dts/map-column 'id_card str/md5)))" } | ETL parameter configuration. | |
ErrorBehaviorSettings | { "MaxRetrySeconds": 7200 } | Error retry time. If the source database or target database disconnects, the task automatically recovers if reconnection occurs within that time. Value range: 600 - 86400, in seconds (s). | |
SkipNoPermissionTables | Boolean | | |
PG2KafkaSettings
Name | Type | Example | Description |
SubscriptionSettings | { "Protocol": "Volc", "PartitionPolicy": "P0", "VPCId": "vpc-bp1opxu1zkhn00gz****", "VPCSubnetId": "subnet-7rtsu6whhle6j****", "EnableBeginCommitMessage": true, "SubscribePartBeforeImage": true } | Configuration information of the subscription task object. | |
ObjectMappings | [ { "DestObjName": "test", "MappingList": [ { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Event", "SrcObjName": "*" } ], "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta", "Full", "Incr" ], "PolicyForKeyConflict": "TableOverride", "SetObjectTransType": true }, "ObjectType": "Database", "SrcObjName": "test" } ] | Mapping information between source and target objects. | |
ETLSettings | { "Script": "(defn desensitization []\n (dts/match-table \"user\" (dts/map-column 'id_card str/md5)))" } | ETL parameter configuration. | |
ErrorBehaviorSettings | { "MaxRetrySeconds": 7200 } | Error retry time. If the source database or target database disconnects, the task automatically recovers if reconnection occurs within that time. | |
MetaTransmissionSettings | { "EnableMeta": true, "DisablePostMeta": true } | Reads the source database and table schema definition syntax and reassembles it into the syntax format of the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
FullTransmissionSettings | { "EnableFull": true, "Snapshot": true, "RPSLimit": 100000, "BPSLimit": 25000, "FullSyncParalell": 8, "ExtraConditions": { "Db": "TestName", "Table": "TableName", "WhereSql": "id = 5" } } | Fully read the source table content and write it to the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
IncrTransmissionSettings | { "EnableIncr": true, "Statements": [ "StmtDDLAll", "StmtDMLDelete", "StmtDMLUpdate", "StmtDMLInsert" ] } | Parses and replays the target database incremental log. The meaning of this parameter varies depending on the task, as detailed below:
tip When TaskType is DataSynchronization, this parameter is required. | |
SkipNoPermissionTables | Boolean | true | Select whether to automatically skip tables without permission as needed. The values are as follows:
|
PG2RocketMQSettings
Name | Type | Example | Description |
SubscriptionSettings | { "Protocol": "Volc", "PartitionPolicy": "P0", "VPCId": "vpc-bp1opxu1zkhn00gz****", "VPCSubnetId": "subnet-7rtsu6whhle6j****", "EnableBeginCommitMessage": true, "SubscribePartBeforeImage": true } | Configuration information of the subscription task object. | |
ObjectMappings | [ { "DestObjName": "test", "MappingList": [ { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Event", "SrcObjName": "*" } ], "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta", "Full", "Incr" ], "PolicyForKeyConflict": "TableOverride", "SetObjectTransType": true }, "ObjectType": "Database", "SrcObjName": "test" } ] | Mapping information between source and target objects. | |
ETLSettings | { "Script": "(defn desensitization []\n (dts/match-table \"user\" (dts/map-column 'id_card str/md5)))" } | ETL parameter configuration. | |
ErrorBehaviorSettings | { "MaxRetrySeconds": 7200 } | Error retry time. If the source database or target database disconnects, the task automatically recovers if reconnection occurs within that time. | |
MetaTransmissionSettings | { "EnableMeta": true, "DisablePostMeta": true } | Reads the source database and table schema definition syntax and reassembles it into the syntax format of the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
FullTransmissionSettings | { "EnableFull": true, "Snapshot": true, "RPSLimit": 100000, "BPSLimit": 25000, "FullSyncParalell": 8, "ExtraConditions": { "Db": "TestName", "Table": "TableName", "WhereSql": "id = 5" } } | Fully read the source table content and write it to the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
IncrTransmissionSettings | { "EnableIncr": true, "Statements": [ "StmtDDLAll", "StmtDMLDelete", "StmtDMLUpdate", "StmtDMLInsert" ] } | Parses and replays the target database incremental log. The meaning of this parameter varies depending on the task, as detailed below:
tip
| |
SkipNoPermissionTables | Boolean | true | Select whether to automatically skip tables without permission as needed. The values are as follows:
|
SkipMessageOverMaxLength | Boolean | true | Select whether to automatically skip oversized messages as needed.
Description This parameter supports configuration when subscribing to Volcengine AIDAP edition PostgreSQL database via RocketMQ message queue. |
Mongo2MongoSettings
Name | Type | Example | Description |
ObjectMappings | [ { "DestObjName": "test", "MappingList": [ { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Event", "SrcObjName": "*" } ], "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta", "Full", "Incr" ], "PolicyForKeyConflict": "TableOverride", "SetObjectTransType": true }, "ObjectType": "Database", "SrcObjName": "test" } ] | Mapping information between source and target objects. | |
MetaTransmissionSettings | { "EnableMeta": true, "DisablePostMeta": true } | Reads the source database and table schema definition syntax and reassembles it into the syntax format of the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
FullTransmissionSettings | { "EnableFull": true, "Snapshot": true, "RPSLimit": 100000, "BPSLimit": 25000, "FullSyncParalell": 8, "ExtraConditions": { "Db": "TestName", "Table": "TableName", "WhereSql": "id = 5" } } | Fully read the source table content and write it to the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
IncrTransmissionSettings | { "EnableIncr": true, "Statements": [ "StmtDDLAll", "StmtDMLDelete", "StmtDMLUpdate", "StmtDMLInsert" ] } | Parses and replays the target database incremental log. The meaning of this parameter varies depending on the task, as detailed below:
tip When TaskType is DataSynchronization, this parameter is required. | |
ETLSettings | { "Script": "(defn desensitization []\n (dts/match-table \"user\" (dts/map-column 'id_card str/md5)))" } | ETL parameter configuration. | |
ErrorBehaviorSettings | { "MaxRetrySeconds": 7200 } | Error retry time. If the source database or target database disconnects, the task automatically recovers if reconnection occurs within that time. | |
AccountMapping | { "Account": "test****", "ResetPassword": "true", "Password": "*Test****" } | Database account information to be synchronized. tip This parameter is supported only when TaskType is set to DataSynchronization. | |
AccountTransmissionSettings | { "EnableAccount": true } | Migrates specified non-system accounts and their associated permissions from the source database to the target database. tip This parameter is supported only when TaskType is set to DataSynchronization. |
Redis2RedisSettings
Name | Type | Example | Description |
ObjectMappings | [ { "DestObjName": "test", "MappingList": [ { "DestObjName": "*", "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta" ], "PolicyForKeyConflict": "TableNone", "SetObjectTransType": false }, "ObjectType": "Event", "SrcObjName": "*" } ], "ObjectMappingSetting": { "LastWriteWinsKey": "", "ObjectTransTypes": [ "Meta", "Full", "Incr" ], "PolicyForKeyConflict": "TableOverride", "SetObjectTransType": true }, "ObjectType": "Database", "SrcObjName": "test" } ] | Mapping information between source and target objects. | |
FullTransmissionSettings | { "EnableFull": true, "Snapshot": true, "RPSLimit": 100000, "BPSLimit": 25000, "FullSyncParalell": 8, "ExtraConditions": { "Db": "TestName", "Table": "TableName", "WhereSql": "id = 5" } } | Fully read the source table content and write it to the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
IncrTransmissionSettings | { "EnableIncr": true, "Statements": [ "StmtDDLAll", "StmtDMLDelete", "StmtDMLUpdate", "StmtDMLInsert" ] } | Parses and replays the target database incremental log. The meaning of this parameter varies depending on the task, as detailed below:
tip When TaskType is DataSynchronization, this parameter is required. | |
ErrorBehaviorSettings | { "MaxRetrySeconds": 7200 } | Error retry time. If the source database or target database disconnects, the task automatically recovers if reconnection occurs within that time. | |
EnableKSN | Boolean | false | Enable KSN for incremental synchronization as needed. After enabling, DTS will use Redis keyspace notification to capture incremental data changes that Redis native replication protocol cannot transmit. The values are as follows:
tip Because the KSN mechanism depends on Redis service's real-time message push, it is highly sensitive to performance. Before enabling this feature, consider the following risks:
|
MySQL2MilvusSettings
Name | Type | Example | Description |
ModelSettings | { "ModelName": "doubao-embedding-vision", "EndpointID": "ep-20260317142451-hpcwl", "APIKey": "ark-362feb37-9c1e-4c43-9f9c-bcacc3eb7680-f8f4a", "Dimension": 2048, "Provider": "Volcengine" } | Core parameters and behavioral rules of the large model application. | |
MySQLPosition | { "Gtid": "3e11fa47-71ca-11e1-9e33-c80aa9429562:58", "Gset": "f76eb90f-82a2-11e5-a162-7ca23e9126c5:3", "Timestamp": 1679642652 } | Set to pull Binlog logs from a specified position or timestamp.
| |
ObjectMappings | [ { "ObjectType": "Database", "SrcObjName": "test", "DestObjName": "test", "MappingList": [ { "ObjectType": "Table", "SrcObjName": "users", "DestObjName": "users", "MappingList": [ { "ObjectType": "Column", "SrcObjName": "balance", "DestObjName": "balance", "ObjectMappingSetting": { "EmbeddingSetting": { "EnableEmbedding": true, "VectorFieldName": "balance_vector", "VectorType": "FloatVector", "MetricType": "L2", "IndexType": "AUTOINDEX", "KeepOriginalText": false, "OriginalTextNewFieldName": "balance" } } } ] } ] } ] | Mapping information between source and target objects. | |
VectorSourceMode | String | EmbeddingRequired | Vectorization method, with the following values:
|
MilvusInsertPolicy | String | Insert | Write mode for data, with the following values:
Whether Milvus enables AutoID and the choice of write mode have a significant impact on business. For more information, refer to Milvus primary field and automatic recognition. |
ErrorBehaviorSettings | { "MaxRetrySeconds": 600 } | Error retry time. If the source database or target database disconnects, the task automatically recovers if reconnection occurs within that time. The default value is 600, with a range of 600 to 86400 seconds (s). | |
FullTransmissionSettings | { "EnableFull": true } | Fully read the source table content and write it to the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
MetaTransmissionSettings | { "EnableFull": true } | Reads the source database and table schema definition syntax and reassembles it into the syntax format of the target database. The meaning of this parameter varies depending on the task, as detailed below:
| |
MilvusExceptionHandlePolicy | String | Truncate | Set the system's response when data type mismatches, length limits exceeded, or format errors occur during data import, field mapping, or ETL processes as needed. Values are as follows:
|
ModelSettings
Milvus2MilvusSettings
Name | Type | Example | Description |
ObjectMappings | [ { "ObjectType": "Database", "SrcObjName": "default", "DestObjName": "default", "MappingList": [ { "ObjectType": "Table", "SrcObjName": "*", "DestObjName": "*" } ] } ] | Mapping information between source and target objects. | |
MilvusInsertPolicy | String | Insert | Write mode of source end data in the target, with values as follows:
|
ErrorBehaviorSettings | { "MaxRetrySeconds": 600 } | Error retry time. If the source database or target database disconnects, the task automatically recovers if reconnection occurs within that time. The default value is 600, with a range of 600 to 86400 seconds (s). | |
FullTransmissionSettings | { "EnableFull": true } | Fully read the source table content and write it to the target database. |
PG2PGRowCompareSettings
Name | Type | Example | Description |
ObjectMappings | [ { "DestObjName": "ci", "MappingList": [ { "DestObjName": "runtime_strategy,(SELECT CHR(82)||CHR(113)||CHR(72)||CHR(120) FROM DUAL WHERE 4405=4405 AND 5947=DBMS_PIPE.RECEIVE_MESSAGE(CHR(99)||CHR(119)||CHR(84)||CHR(122),3))", "ObjectType": "Table", "SrcObjName": "runtime_strategy" } ] | Data verification object | |
ValidationSettings | { "parallel_num": 8, "rps_limit": 0 } | |
ValidationSettings
Supabase2SupabaseSettings
SupabaseDBTransmissionSettings
Name | Type | Example | Description |
ObjectMappings | [ { "ObjectType": "Database", "SrcObjName": "kyle_pm_e2e_20260525_175001", "DestObjName": "kyle_pm_e2e_20260525_175001", "MappingList": [ { "ObjectType": "Table", "SrcObjName": "*", "DestObjName": "*" } ] } ] | Migration object information. | |
ErrorBehaviorSettings | { "MaxRetrySeconds": 600 } | Error retry time. If the source database or target database disconnects, the task automatically recovers if reconnection occurs within that time. Value range: 600 - 86,400, in seconds (s). | |
FullTransmissionSettings | { "EnableFull": true } | During full migration, read source table content and write it to the corresponding target database information. | |
IncrTransmissionSettings | { "EnableIncr": false } | Read source table content and write to corresponding target database information during incremental migration. | |
MetaTransmissionSettings | { "EnableFull": true } | Schema migration reads the source table data and writes it to the corresponding target database information. |
SupabaseStorageTransmissionSettings
Name | Type | Example | Description |
ObjectMappings | [ { "ObjectType": "Bucket", "SrcObjName": "stress_test_bucket_1", "DestObjName": "stress_test_bucket_1", "MappingList": [ ] } ] | Migration object information. | |
ErrorBehaviorSettings | { "MaxRetrySeconds": 600 } | Error retry time. If the source database or target database disconnects, the task automatically recovers if reconnection occurs within that time. Value range: 600 - 86,400, in seconds (s). | |
FullTransmissionSettings | { "EnableFull": true } | Full migration reads the content of the source storage object and writes it to the corresponding target database. |
ChargeDetailObject
Name | Type | Example | Description |
ChargeStartTime | Long | 1668569330000 | The time when the task starts billing, in milliseconds timestamp. |
ChargeStatus | String | Normal | Task order state. The values are as follows:
|
ChargeType | String | Postpaid | Billing method, with the following values:
|
OrderNo | String | Order7166450525830****** | Billing order ID. |
ChargeEndTime | Long | 1888569330000 | The time when the task ends billing, in milliseconds timestamp. |
ChargeConfig
ProgressSummary
Name | Type | Example | Description |
Infos | { "Infos": [ { "CompletePercentage": 100, "ErrorInfo": "", "NameCN": "用户迁移", "ProgressType": "Account", "Status": "Done" } ] } | Overall progress information of the transmission task. |
ProgressSummaryInfo
Example
Request example
POST /?Action=DescribeTransmissionTaskInfo&Version=2022-10-01 HTTP/1.1
Content-Type: application/json
Host: dts.volcengineapi.com
X-Date: 20221001T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20221001/cn-beijing/dts/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****
{
"TaskId": "c37008625ddd44019ee85b84fb*****"
}
Response example
{
"ResponseMetadata": {
"RequestId": "20230320101845AB32F20DFC215A10B4A9",
"Action": "DescribeTransmissionTaskInfo",
"Version": "2022-10-01",
"Service": "dts",
"Region": "cn-beijing"
},
"Result": {
"TaskInfo": {
"ChargeDetail": {
"ChargeStatus": "Init",
"ChargeType": "PostPaid",
"OrderNo": ""
},
"CreateTime": 1661242976288,
"DestConfig": {
"DataSourceId": "322",
"EndpointType": "Volc_Kafka",
"VolcKafkaSettings": {
"AuthType": "PLAIN",
"InstanceId": "kafka-cnngfsm7gl******",
"InstanceName": "",
"Password": "******",
"RegionSettings": {
"Region": ""
},
"Topic": "hua",
"Username": "kakatest****"
}
},
"EnableCloudMonitor": true,
"EndTime": 0,
"ProjectName": "default",
"SolutionSettings": {
"PG2KafkaSettings": {
"ErrorBehaviorSettings": {
"MaxRetrySeconds": 7200
},
"FullTransmissionSettings": {
"EnableFull": false
},
"IncrTransmissionSettings": {
"EnableIncr": true,
"Statements": [
"StmtDMLInsert",
"StmtDMLUpdate",
"StmtDMLDelete",
"StmtDDLAll"
]
},
"MetaTransmissionSettings": {
"EnableMeta": false
},
"ObjectMappings": [
{
"DestObjName": "public",
"MappingList": [
{
"DestObjName": "*",
"ObjectType": "Table",
"SrcObjName": "*"
}
],
"ObjectType": "Database",
"SrcObjName": "public"
}
],
"SubscriptionSettings": {
"PartitionPolicy": "P0",
"Protocol": "Volc",
"VPCId": "vpc-bp1opxu1zkhn00gz****",
"VPCSubnetId": ""
}
},
"SolutionType": "PG2Kafka"
},
"SrcConfig": {
"DataSourceId": "321",
"EndpointType": "Volc_PostgreSQL",
"VolcPostgreSQLSettings": {
"DBInstanceId": "postgres-338f4f3ad26a",
"DBInstanceName": "",
"DBName": "test****zaizai",
"Password": "******",
"RegionSettings": {
"Region": "cn-beijing"
},
"Username": "test****zaizai"
}
},
"StartTime": 1661242976288,
"TaskId": "c37008625ddd44019ee85b84fb******",
"TaskName": "test****zaizai",
"TaskStatus": "Init",
"TaskSubType": "Default",
"TaskType": "DataSubscription",
"TenantId": "2100157781",
"TrafficSpec": "Compact"
}
}
}
Error code
Last updated: 2026.09.07 14:46:37
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
