Call the ListDataSource API to query the list of data sources.

Request type

Synchronous request.

Request parameters

Parameter	Type	Is it required?	Sample	Description
PageNum	Long	No	1	Page number. The value range is 1 to 1000, with a default of 1.
PageSize	Long	No	10	Number of records per page. The value range is 1 to 1000, with a default of 10.
NamePrefix	String	No	test	Name prefix that supports fuzzy search of the data source.
EndpointTypes	Array of String	No	["Volc_MySQL"]	The access method of the instance. the values are as follows: Volc_MySQL: Indicates BytePlus NDB for MySQL. Volc_veDB_MySQL: Indicates BytePlus NDB for MySQL. Volc_PostgreSQL: Indicates Volcengine RDS for PostgreSQL. Volc_Mongo: Indicates Volcengine Database for MongoDB. Volc_ElasticSearch: Indicates Volcengine Cloud Search Service. Volc_Kafka: Indicates Message Queue for Kafka. Volc_RocketMQ: Indicates Message Queue for RocketMQ. Volc_Redis: Indicates Volcengine Cache for Redis. Public_MySQL: Indicates MySQL connected over public network. Public_PostgreSQL: Indicates connected over public network. Public_Mongo: Indicates MongoDB connected over public network.. Public_ElasticSearch: Indicates Cloud Search connected over public network. Public_Redis: Indicates Redis connected over express network. Builtin_Kafka: Indicates the built-in middleware. Express_MySQL: Indicates MySQL connected over express network. Express_PostgreSQL: Indicates PostgreSQL connected over express network. Express_Mongo: Indicates MongoDB connected over express network. Express_Redis: Indicates Redis connected over express network.
Categories	Array of String	No	["MySQL"]	Database type. The values are as follows: MySQL: Indicates that the database type of the data source is MySQL. MongoDB: Indicates that the database type of the data source is MongoDB. Redis: Indicates that the database type of the data source is Redis. PostgreSQL: Indicates that the database type of the data source is PostgreSQL. Elasticsearch: Indicates that the database type of the data source is Elasticsearch. Kafka: Indicates that the database type of the data source is Kafka. RocketMQ: Indicates that the database type of the data source is RocketMQ.
OrderByModifyTimeDesc	Boolean	No

Response parameters

Parameter	Type	Sample	Description
DataSourceList	Array of DataSource	[ { "Category": "MySQL", "CreateTime": 1713382724876, "DataSourceId": "178067480074262**", "EndpointType": "Volc_MySQL", "Name": "src", "VolcMySQLSettings": { "DBInstanceId": "mysql-7734b621", "DBInstanceName": "", "Password": "Admin@", "RegionSettings": { "Region": "cn-beijing" }, "Username": "test*" } } ]	Data source list.
Count	Long	1	The total number of data sources.

DataSource

Parameter	Type	Sample	Description
Category	String	MySQL	The type of instance. The values are as follows: MySQL: Indicates that the instance type is MySQL. PostgreSQL: Indicates that the instance type is PostgreSQL. ElasticSearch: Indicates that the instance type is Elasticsearch. MongoDB: Indicates that the instance type is MongoDB. Redis: Indicates that the instance type is Redis.
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: Volc_MySQL: Indicates BytePlus NDB for MySQL. Volc_veDB_MySQL: Indicates BytePlus NDB for MySQL. Volc_PostgreSQL: Indicates Volcengine RDS for PostgreSQL. Volc_Mongo: Indicates Volcengine Database for MongoDB. Volc_ElasticSearch: Indicates Volcengine Cloud Search Service. Volc_Kafka: Indicates Message Queue for Kafka. Volc_RocketMQ: Indicates Message Queue for RocketMQ. Volc_Redis: Indicates Volcengine Cache for Redis. Public_MySQL: Indicates MySQL connected over public network. Public_PostgreSQL: Indicates connected over public network. Public_Mongo: Indicates MongoDB connected over public network.. Public_ElasticSearch: Indicates Cloud Search connected over public network. Public_Redis: Indicates Redis connected over express network. Builtin_Kafka: Indicates the built-in middleware. Express_MySQL: Indicates MySQL connected over express network. Express_PostgreSQL: Indicates PostgreSQL connected over express network. Express_Mongo: Indicates MongoDB connected over express network. Express_Redis: Indicates Redis connected over express network. Express_Kafka: Indicates Kafka connected over express network. Express_ElasticSearch: Indicates ElasticSearch connected over express network.
VolcMySQLSettings	Object of 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	Object of 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	Object of 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	Object of 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	Object of 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	Object of 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	Object of 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	Object of 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	Object of 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	Object of 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	Object of 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	Object of 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	Object of 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	Object of 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	Object of 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 Express_Mongo.
ExpressMySQLSettings	Object of 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. Required when EndpointType is Express_MySQL.
ExpressPostgreSQLSettings	Object of 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 equals Express_PostgreSQL.
ExpressRedisSettings	Object of 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" }	This represents the information of the source database or target database with access method of Redis connected over express network. When EndpointType is Express_Redis, this parameter is required.
ExpressElasticSearchSettings	Object of 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	Object of 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.

VolcMySQLSettings

Parameter	Type	Sample	Description
DBInstanceId	String	mysql-3d224def****	Instance ID. tip This parameter is required when EndpointType is set to Volc_MySQL. You can call the DescribeDBInstances interface to query the instance ID.
DBInstanceName	String	testDB	Instance name.
Username	String	test****	Database account.
Password	String	test****	Database account password.
RegionSettings	Object of RegionSettings	{ "Region": "cn-shanghai" }	The region of the instance.
CrossAccountSettings	Object of CrossAccountSettings	{ "SourceAccount":"2100******", "Role":"test" }	The configuration information for cross-account data transmission.

RegionSettings

Parameter	Type	Sample	Description
Region	String	cn-beijing	Region ID.

CrossAccountSettings

Parameter	Type	Sample	Description
SourceAccount	String	2100******	Source account ID.
Role	String	test	The role name created by source accounts for the transmission of data.

VolcveDBMySQLSettings

Parameter	Type	Sample	Description
DBInstanceId	String	vedbm-r3xq0zdl****	Instance ID. tip This parameter is required when EndpointType is set to Volc_veDB_MySQL. You can call DescribeDBInstanceDetail interface to query the Instance ID.
DBInstanceName	String	TestveDB	Instance name.
Username	String	test****	Database account.
Password	String	test****	Database account password.
RegionSettings	Object of RegionSettings	{ "Region": "cn-shanghai" }	The region of the instance.
CrossAccountSettings	Object of CrossAccountSettings	{ "SourceAccount":"2100******", "Role":"test" }	The configuration information for cross-account data transmission.

VolcPostgreSQLSettings

Parameter	Type	Sample	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	Object of RegionSettings	{ "Region": "cn-shanghai" }	The region of the instance.
CrossAccountSettings	Object of CrossAccountSettings	{ "SourceAccount":"2100******", "Role":"test" }	The configuration information for cross-account data transmission.
ExtraParams	Array of ExtraParam

ExtraParam

Parameter	Type	Sample	Description
Key	String
Value	String

VolcMongoSettings

Parameter	Type	Example	Description
DBInstanceId	String	mongo-replica-e405f8e2****	Instance ID. tip This parameter is required when EndpointType is set to Volc_Mongo. You can call the DescribeDBInstanceDetail API to query the instance ID.
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: ReplicaSet: Indicates a replica set. ShardedCluster: Indicates a sharded cluster.
RegionSettings	Object of RegionSettings	{ "Region": "cn-shanghai" }	The region of the instance.
CrossAccountSettings	Object of 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: ChangeStream: This method provides a way to obtain change events of specific types of modified data from a data set (database, collection, or pipeline). For example, insert, update, or delete events. If this acquisition method is selected, the instance version must be 3.6 or higher. Oplog: This acquisition method means directly obtaining the operation log of the MongoDB. For MongoDB sharded clusters, all sharding addresses must be entered after selecting this acquisition method. This method offers better synchronization performance compared to ChangeStream. None: After selecting None, incremental migration is not available. Only full migration can be selected. tip This parameter is required when the DeployType parameter value is ShardedCluster.

VolcElasticSearchSettings

Parameter	Type	Sample	Description
DBInstanceId	String	ztuc43y38z4w****	Instance ID. tip This parameter is required when EndpointType is set to Volc_ElasticSearch. You can call the DescribeInstances interface to query the instance ID.
Username	String	test****	Database account.
Password	String	test****	Database account password.
RegionSettings	Object of RegionSettings	{ "Region": "cn-shanghai" }	The region of the instance.

VolcKafkaSettings

Parameter	Type	Sample	Description
InstanceId	String	kafka-****	Instance ID. tip This parameter is required when EndpointType is set to Volc_Kafka. You can call the DescribeInstancesSummary interface to query the Instance ID.
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	Object of RegionSettings	{ "Region": "cn-shanghai" }	The region of the instance.

VolcRocketMQSettings

Parameter	Type	Sample	Description
InstanceId	String	MQ_INST_*****	Instance ID. tip This parameter is required when EndpointType is set to Volc_RocketMQ. You can call the GetInstance API to query the Instance ID.
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	Object of RegionSettings	{ "Region": "cn-shanghai" }	The region of the instance.

VolcRedisSettings

Parameter	Type	Sample	Description
DBInstanceId	String	redis-cn0212gzmh2xs****	Instance ID. tip This parameter is required when EndpointType is set to Volc_Redis. You can call the DescribeDBInstances interface to query the Instance ID.
Username	String	test****	Database account.
Password	String	test****	Database account password.
RegionSettings	Object of RegionSettings	{ "Region": "cn-shanghai" }	The region of the instance.
CrossAccountSettings	Object of CrossAccountSettings	{ "SourceAccount":"2100******", "Role":"test" }	The configuration information for cross-account data transmission.

PublicMySQLSettings

Parameter	Type	Sample	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	Object of SSLSettings	{ "EnableSSL": true, "Cert":"-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----" }	Instance encryption information.
RegionSettings	Object of RegionSettings	{ "Region": "cn-shanghai" }	The region of the instance.

SSLSettings

Parameter	Type	Sample	Description
EnableSSL	Boolean	false	Whether to enable SSL encryption connection method. The values are as follows: true: Indicates that SSL encryption is enabled. false: Indicates that SSL encryption is not enabled.
Cert	String	-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----	CA certificate content. tip When EnableSSL is set to true, this parameter is required.

PublicPostgreSQLSettings

Parameter	Type	Sample	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	Object of RegionSettings	{ "Region": "cn-shanghai" }	The region of the instance.
ExtraParams	Array of ExtraParam

PublicMongoSettings

Parameter	Type	Sample	Description
RegionSettings	Object of RegionSettings	{ "Region": "cn-shanghai" }	The region of the instance.
DeployType	String	Standalone	The type of MongoDB instance. The values are as follows: Standalone: Indicates a single node. ReplicaSet: Indicates a replica set. ShardedCluster: Indicates a sharded cluster.
PullMethod	String	ChangeStream	Incremental acquisition method at the source end. The values are as follows: ChangeStream: This method provides a way to obtain change events of specific types of modified data from a data set (database, collection, or pipeline). For example, insert, update, or delete events. If this acquisition method is selected, the instance version must be 3.6 or higher. Oplog: This acquisition method means directly obtaining the operation log of the MongoDB. For MongoDB sharded clusters, all sharding addresses must be entered after selecting this acquisition method. This method offers better synchronization performance compared to ChangeStream. None: After selecting None, incremental migration is not available. Only full migration can be selected. 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	Array of MongoShardSetting	{ "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: false: Indicates that the new shard access method is not used. true: Indicates that the new shard method is used. The default value is the shard set scenario for the deployment type.

MongoShardSetting

Parameter	Type	Sample	Description
Address	String	192.168.0.1:27019,192.168.0.1:27020	Shard address, such as IP:Port or Domain:Port. If multiple addresses exist, separate them with commas (,). Up to 5 addresses are supported.
Username	String	test****	Database account.
Password	String	test****	Database account password.
AuthDb	String	admin	Account verification database.

PublicElasticSearchSettings

Parameter	Type	Sample	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	Object of RegionSettings	{ "Region": "cn-shanghai" }	The region of the instance.

PublicRedisSettings

Parameter	Type	Sample	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	Object of RegionSettings	{ "Region": "cn-shanghai" }	The region of the instance.

BuiltinKafkaSettings

Parameter	Type	Sample	Description
Brokers	Array of String	[ "100.67.158.158:9092", "100.67.158.158:9192", "100.67.158.158:9292", "100.67.158.158:9392", "100.67.158.158:9492" ]	The IP address and port number of the Broker, in the format of host:port.
Topic	String	6f2fd63c0ea947b280877f5d2a******	Kafka's Topic ID.

ExpressMongoSettings

Name	Type	Sample	Description
RegionSettings	Object of RegionSettings	{ "Region": "cn-shanghai" }	Region ID.
DeployType	String	ShardedCluster	The instance type of the instance. The values are as follows: Standalone: Indicates a single node. ReplicaSet: Indicates a replica set. ShardedCluster: Indicates a sharded cluster.
PullMethod	String	ChangeStream	Incremental acquisition method at the source end. The values are as follows: ChangeStream: This method provides a way to obtain change events of specific types of modified data from a data set (database, collection, or pipeline). For example, insert, update, or delete events. If this acquisition method is selected, the instance version must be 3.6 or higher. Oplog: This acquisition method means directly obtaining the operation log of the MongoDB. For MongoDB sharded clusters, all sharding addresses must be entered after selecting this acquisition method. This method offers better synchronization performance compared to ChangeStream. None: After selecting None, incremental migration is not available. Only full migration can be selected. tip This parameter is required when the DeployType is set to ShardedCluster.
PrivateNetworkSettings	Object of 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	Array of MongoShardSetting	{ "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: false: Indicates that the new shard access method is not used. true: Indicates that the new shard method is used. The default value is the shard set scenario for the deployment type.

PrivateNetworkSettings

Parameter	Type	Sample	Description
VPCId	String	vpc-bp1opxu1zkhn00gz****	VPC ID. The VPC ID values are as follows, based on the connection method of the virtual private cloud: Direct connect: Set any VPC ID of the CEN when achieving data connectivity through a dedicated line CEN. VPN connection: Set the VPC ID bound to the VPN gateway when achieving data connectivity through VPN.
SubnetId	String	subnet-bpkdt37pq72zv****	Subnet ID within the VPC ID. tip The subnet CIDR block must be added to the allowlist or security group rule of the target database.

ExpressMySQLSettings

Parameter	Type	Sample	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	Object of PrivateNetworkSettings	{ "VpcId": "vpc-bp1opxu1zkhn00gz**", "SubnetId": "subnet-bpkdt37pq72zv**" }	Configuration of the virtual private cloud.
RegionSettings	Object of RegionSettings	{ "Region": "cn-shanghai" }	Region ID.

ExpressPostgreSQLSettings

Parameter	Type	Sample	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	Object of PrivateNetworkSettings	{ "VpcId": "vpc-bp1opxu1zkhn00gz**", "SubnetId": "subnet-bpkdt37pq72zv**" }	Configuration of the virtual private cloud.
RegionSettings	Object of RegionSettings	{ "Region": "cn-shanghai" }	Region ID.
ExtraParams	Array of ExtraParam

ExpressRedisSettings

Parameter	Type	Sample	Description
ArchType	String	Standalone	Architecture type. The values are as follows: Standalone: Standalone edition. Cluster: Cluster edition. 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	Object of PrivateNetworkSettings	{ "VpcId": "vpc-bp1opxu1zkhn00gz**", "SubnetId": "subnet-bpkdt37pq72zv**" }	Configuration of the virtual private cloud.
RegionSettings	Object of 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

Parameter	Type	Sample	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	Object of PrivateNetworkSettings	{ "VpcId": "vpc-bp1opxu1zkhn00gz**", "SubnetId": "subnet-bpkdt37pq72zv**" }	Configuration of the virtual private cloud.
RegionSettings	Object of RegionSettings	{ "Region": "cn-shanghai" }	Region ID.

ExpressKafkaSettings

Parameter	Type	Sample	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	Object of PrivateNetworkSettings	{ "VpcId": "vpc-bp1opxu1zkhn00gz**", "SubnetId": "subnet-bpkdt37pq72zv**" }	Configuration of the virtual private cloud.
RegionSettings	Object of RegionSettings	{ "Region": "cn-shanghai" }	Region ID.

Example

Request example

POST /?Action=ListDataSource&Version=2022-10-01 HTTP/1.1​
Content-Type: application/json​
Host:dts.cn-beijing.volcengineapi.com​
X-Date: 20221001T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20221001/cn-beijing/dts/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****​
{​
    "Categories":["Mongo"]​
}​

Response example

{​
    "ResponseMetadata": {​
        "RequestId": "202406121112198BD27340EB1C38A9E28E-fbd62a",​
        "Action": "ListDataSource",​
        "Version": "2022-10-01",​
        "Service": "dts",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "Count": 1,​
        "DataSourceList": [​
            {​
                "Category": "MongoDB",​
                "CreateTime": 1718104049581,​
                "DataSourceId": "1800470012301987863",​
                "EndpointType": "Volc_Mongo",​
                "Name": "w",​
                "VolcMongoSettings": {​
                    "DBInstanceId": "mongo-replica-386df9f4****",​
                    "DBInstanceName": "",​
                    "DeployType": "ReplicaSet",​
                    "MongoAuthSourceDB": "",​
                    "Password": "c",​
                    "RegionSettings": {​
                        "Region": "cn-beijing"​
                    },​
                    "Username": "c"​
                }​
            }​
        ]​
    }​
}​

Error code

For more details, see Error code.

Database Transmission Service