调用 CreateDataSource 接口创建数据源。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
DataSource	Object of DataSource	否	{ "DataSource": { "EndpointType": "Volc_MySQL", "VolcMySQLSettings": { "RegionSettings": { "Region": "cn-beijing" }, "DBInstanceId": "mysql-0ed701a3**", "Username": "dede", "Password": "Admin@**" }, "Category": "MySQL", "Name": "ce" } }	数据源的配置信息。

DataSource

参数	类型	是否必选	示例值	描述
Category	String	否	MySQL	实例的类型，取值如下： MySQL：表示实例类型为 MySQL。 PostgreSQL：表示实例类型为 PostgreSQL。 ElasticSearch：表示实例类型为 ElasticSearch。 MongoDB：表示实例类型为 MongoDB。 Redis：表示实例类型为 Redis。
CreateTime	Long	否	1734070854504	数据源的创建时间。毫秒时间戳。
DataSourceId	String	否	1867454442941460510	源端或目标端实例 ID。
ModifyTime	Long	否	1734070873088	最近一次更新数据源的时间。毫秒时间戳。
EndpointType	String	否	Volc_MySQL	实例的接入方式，取值如下： Volc_MySQL：表示火山引擎版 MySQL。 Volc_veDB_MySQL：表示火山引擎版 veDB MySQL。 Volc_PostgreSQL：表示火山引擎版 PostgreSQL。 Volc_Mongo：表示火山引擎版 MongoDB。 Volc_ElasticSearch：表示火山引擎版 ElasticSearch。 Volc_Kafka：表示消息队列 Kafka 版。 Volc_RocketMQ：表示消息队列 RocketMQ 版。 Volc_Redis：表示火山引擎版 Redis。 Public_MySQL：表示公有网络 MySQL。 Public_PostgreSQL：表示公有网络 PostgreSQL。 Public_Mongo：表示公有网络 MongoDB。 Public_ElasticSearch：表示公有网络 ElasticSearch。 Public_Redis：表示公有网络 Redis。 Builtin_Kafka：表示内置中间件。 Express_MySQL：表示专有网络 MySQL。 Express_PostgreSQL：表示专有网络 PostgreSQL。 Express_Mongo：表示专有网络 MongoDB。 Express_Redis：表示专有网络 Redis。 Express_Kafka：表示专有网络 Kafka。 Express_ElasticSearch：表示专有网络 ElasticSearch。 Volc_AIDapPG：表示 EndpointVolcAIDapPG。 Volc_Milvus：表示 EndpointVolcMilvus。 Public_Milvus：表示 EndpointPublicMilvus。 Express_Milvus：表示 EndpointExpressMilvus。
VolcMySQLSettings	Object of VolcMySQLSettings	否	{ "DBInstanceId": "mysql-0b5d385f***", "DBInstanceName": "", "Password": "****", "RegionSettings": { "Region": "cn-shanghai" }, "Username": "huahua" }	表示接入方式为火山引擎版 MySQL 的源库或目标库信息。在 EndpointType 取值为 Volc_MySQL 时，该参数必选。
VolcveDBMySQLSettings	Object of VolcveDBMySQLSettings	否	{ "DBInstanceId": "vedbm-arjlc5di**", "DBInstanceName": "", "Password": "****", "RegionSettings": { "Region": "cn-beijing" }, "Username": "root" }	表示接入方式为火山引擎版 veDB MySQL 的源库或目标库信息。在 EndpointType 取值为 Volc_veDB_MySQL 时，该参数必选。
VolcPostgreSQLSettings	Object of VolcPostgreSQLSettings	否	{ "DBInstanceId": "postgres-5d17bd5c**", "DBInstanceName": "", "DBName": "huahua", "Password": "****", "RegionSettings": { "Region": "cn-guangzhou" }, "Username": "huahua" }	表示接入方式为火山引擎版 PostgreSQL 的源库或目标库的信息。在 EndpointType 取值为 Volc_PostgreSQL 时，该参数必选。
VolcMongoSettings	Object of VolcMongoSettings	否	{ "DBInstanceId": "mongo-replica-8ea79132**", "DBInstanceName": "", "DeployType": "ReplicaSet", "MongoAuthSourceDB": "", "Password": "****", "RegionSettings": { "Region": "cn-guangzhou" }, "Username": "root" }	表示接入方式为火山引擎版 MongoDB 的源库或目标库的信息。在 EndpointType 取值为 Volc_Mongo 时，该参数必选。
VolcElasticSearchSettings	Object of VolcElasticSearchSettings	否	{ "DBInstanceId": "o-00g0sqi***", "DBInstanceName": "", "Password": "****", "RegionSettings": { "Region": "cn-shanghai" }, "Username": "admin" }	表示接入方式为火山引擎版 ElasticSearch 的目标库的信息。在 EndpointType 取值为 Volc_ElasticSearch 时，该参数必选。
VolcKafkaSettings	Object of VolcKafkaSettings	否	{ "AuthType": "PLAIN", "InstanceId": "kafka-cnnge0tckudy**", "InstanceName": "", "Password": "****", "RegionSettings": { "Region": "cn-beijing" }, "Topic": "huahua", "Username": "huahua" }	表示接入方式为火山引擎版 Kafka 的目标库的信息。在 EndpointType 取值为 Volc_Kafka 时，该参数必选。
VolcRocketMQSettings	Object of VolcRocketMQSettings	否	{ "AuthType": "PLAIN", "InstanceId": "rocketmq-cnou964d1e****", "InstanceName": "", "Password": "****", "RegionSettings": { "Region": "cn-guangzhou" }, "Topic": "zaizai", "Username": "uSmQgOHNTy5Uh98nqBGPvCzK" }	表示接入方式为火山引擎版 RocketMQ 的目标库的信息。在 EndpointType 取值为 Volc_RocketMQ 时，该参数必选。
VolcRedisSettings	Object of VolcRedisSettings	否	{ "DBInstanceId": "redis-cnlf1xx7vjjw9**", "DBInstanceName": "", "Password": "****", "RegionSettings": { "Region": "cn-beijing" }, "Username": "default" }	表示接入方式为火山引擎版 Redis 的目标库的信息。在 EndpointType 取值为 Volc_Redis 时，该参数必选。
PublicMySQLSettings	Object of PublicMySQLSettings	否	{ "Host": "rm-2zey7i58n36x0**.mysql.rds.aliyuncs.com", "Password": "****", "Port": 3306, "RegionSettings": { "Region": "cn-beijing" }, "Username": "rootgg" }	表示接入方式为公有网络 MySQL 的源库或目标库的信息。在 EndpointType 取值为 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" }	表示接入方式为公有网络 PostgreSQL 的源库或目标库的信息。在 EndpointType 取值为 Public_PostgreSQL 时，该参数必选。
PublicMongoSettings	Object of PublicMongoSettings	否	{ "DeployType": "Standalone", "Endpoints": [ "123" ], "MongoAuthSourceDB": "123", "Password": "123", "RegionSettings": { "Region": "cn-chongqing-sdv" }, "Username": "123" }	表示接入方式为公网自建 MongoDB 的源库或目标库的信息。在 EndpointType 取值为 Public_Mongo 时，该参数必选。
PublicElasticSearchSettings	Object of PublicElasticSearchSettings	否	{ "Endpoints": [ "********" ], "Password": "dddd", "RegionSettings": { "Region": "cn-beijing" }, "Username": "ddd" }	表示接入方式为公有网络 ElasticSearch 的源库或目标库的信息。在 EndpointType 取值为 Public_ElasticSearch 时，该参数必选。
PublicRedisSettings	Object of PublicRedisSettings	否	{ "Host": "redis-sy013ku146****.redis.inner.ivolces.com", "Password": "****", "Port": 6379, "RegionSettings": { "Region": "cn-beijing" }, "Username": "default" }	表示接入方式为公有网络 Redis 的源库或目标库的信息。在 EndpointType 取值为 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****" }	表示在数据订阅任务中，将数据订阅到内置中间件的参数信息。在 EndpointType 取值为 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" }	表示接入方式为专有网络 MongoDB 的源库或目标库的信息。在 EndpointType 取值为 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" }	表示接入方式为专有网络 MySQL 的源库或目标库的信息。在 EndpointType 取值为 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" }	表示接入方式为专有网络 PostgreSQL 的源库或目标库的信息。在 EndpointType 取值为 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" }	表示接入方式为专有网络 Redis 的源库或目标库的信息，在 EndpointType 取值为 Express_Redis 时，该参数必选。
ExpressElasticSearchSettings	Object of ExpressElasticSearchSettings	否	{ "Endpoints": [ "http://192.**.0.:9200" ], "Password": "123456", "PrivateNetworkSettings": { "SubnetId": "subnet-2d6asbw971nnk58ozfeei", "VPCId": "vpc-3rebt5uf5fr405zsk2if9**" }, "RegionSettings": { "Region": "cn-beijing" }, "Username": "elastic" }	表示接入方式为专有网络 ElasticSearch 的源库或目标库信息。在 EndpointType 取值为 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" }	表示接入方式为专有网络 Kafka 的源库或目标库信息。在 EndpointType 取值为 Express_Kafka 时，该参数必选。
Name	String	否	test	数据源的任务名称。在调用 CreateDataSource 接口创建数据源时需要配置该参数。
VolcMilvusSettings	Object of VolcMilvusSettings	否	{ "DBInstanceId": "milvus-004otp****", "DBInstanceName": "test", "Password": "test@", "RegionSettings": { "Region": "cn-beijing" }, "Username": "test**" }	表示接入方式为火山引擎版 Milvus 的源库或目标库的信息。在 EndpointType 取值为 Volc_Milvus 时，该参数必选。
PublicMilvusSettings	Object of PublicMilvusSettings	否	{ "RegionSettings": { "Region": "cn-beijing" }, "Endpoints": [ "milvus-008ks86g****.milvus.ivolces.com:5432" ], "Username": "admin", "Password": "admin@**" }	表示接入方式为公有网络 Milvus 的源库或目标库的信息。在 EndpointType 取值为 Public_Milvus 时，该参数必选。
ExpressMilvusSettings	Object of ExpressMilvusSettings	否	{ "RegionSettings": { "Region": "cn-beijing" }, "Endpoints": [ "milvus-008ks8****.milvus.ivolces.com:5432" ], "PrivateNetworkSettings": { "VPCId": "vpc-1a1c2ylbygnwg8nvepj***", "SubnetId": "subnet-3ptgi78ypps006csxyv**" }, "Username": "admin", "Password": "Admin@***" }	表示接入方式为专有网络 Milvus 的源库或目标库的信息。在 EndpointType 取值为 Express_Milvus 时，该参数必选。

VolcMySQLSettings

参数	类型	是否必选	示例值	描述
DBInstanceId	String	否	mysql-3d224def****	实例 ID。说明在 EndpointType 取值为 Volc_MySQL 时，该参数必选。您可以调用 DescribeDBInstances接口查询实例 ID。
DBInstanceName	String	否	testDB	实例名称。
Username	String	否	test****	数据库账号。
Password	String	否	test****	数据库密码。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域。
CrossAccountSettings	Object of CrossAccountSettings	否	{ "SourceAccount":"2100******", "Role":"test" }	跨账号传输数据的配置信息。

RegionSettings

参数	类型	是否必选	示例值	描述
Region	String	否	cn-beijing	地域 ID。

CrossAccountSettings

参数	类型	是否必选	示例值	描述
SourceAccount	String	否	2100******	源端账号 ID。
Role	String	否	test	通过源端账号创建的用于传输数据的角色名称。

VolcveDBMySQLSettings

参数	类型	是否必选	示例值	描述
DBInstanceId	String	否	vedbm-r3xq0zdl****	实例 ID。说明当 EndpointType 取值为 Volc_veDB_MySQL 时，该参数必选。您可以调用 DescribeDBInstanceDetail接口查询实例 ID。
DBInstanceName	String	否	TestveDB	实例名称。
Username	String	否	test****	数据库账号。
Password	String	否	test****	数据库密码。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域。
CrossAccountSettings	Object of CrossAccountSettings	否	{ "SourceAccount":"2100******", "Role":"test" }	跨账号传输数据的配置信息。

VolcPostgreSQLSettings

参数	类型	是否必选	示例值	描述
DBInstanceId	String	否	postgres-h441603c68aaa****	实例 ID。说明在 EndpointType 取值为 Volc_PostgreSQL时，该参数必选。
Username	String	否	test****	数据库账号。
Password	String	否	test****	数据库密码。
DBName	String	否	test****	数据库名称。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域。
CrossAccountSettings	Object of CrossAccountSettings	否	{ "SourceAccount":"2100******", "Role":"test" }	跨账号传输数据的配置信息。

VolcMongoSettings

参数	类型	是否必选	示例值	描述
DBInstanceId	String	否	mongo-replica-e405f8e2****	实例 ID。说明在 EndpointType 取值为 Volc_Mongo 时，该参数必选。您可以调用 DescribeDBInstanceDetail接口查询实例 ID。
Username	String	否	test****	数据库账号。
Password	String	否	test****	数据库密码。
MongoAuthSourceDB	String	否	ReplicaSet	账号校验数据库，在 EndpointType 取值为 Volc_Mongo 时，该参数默认值为 root。
DeployType	String	否	ShardedCluster	MongoDB 的实例类型。取值如下： ReplicaSet：表示副本集。 ShardedCluster：表示分片集群。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域。
CrossAccountSettings	Object of CrossAccountSettings	否	{ "SourceAccount":"2100******", "Role":"test" }	跨账号传输数据的配置信息。
PullMethod	String	否	ChangeStream	源端增量获取方式。取值如下： ChangeStream：该获取方式提供从数据集（数据库、集合或管道）中获取特定类型已修改数据的改变事件的方法。例如插入、更新或删除事件。如果选择该获取方式，那么实例的版本需大于等于 3.6。 Oplog：该获取方式表示直接获取 MongoD 操作日志。对于 MongoDB 分片集，选择该获取方式后需要填写所有分片地址。该方式相较于 ChangeStream 能提供更好的同步性能。 None：选择 None 后无法选择增量迁移，只能选择全量迁移。说明当 DeployType 参数取值为 ShardedCluster时，需设置该参数信息。

VolcElasticSearchSettings

参数	类型	是否必选	示例值	描述
DBInstanceId	String	否	ztuc43y38z4w****	实例 ID。说明在 EndpointType 取值为 Volc_ElasticSearch 时，该参数必选。您可以调用 DescribeInstances接口查询实例 ID。
Username	String	否	test****	数据库账号。
Password	String	否	test****	数据库密码。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域。

VolcKafkaSettings

参数	类型	是否必选	示例值	描述
InstanceId	String	否	kafka-****	实例 ID。说明在 EndpointType 取值为 Volc_Kafka 时，该参数必选。您可以调用 DescribeInstancesSummary接口查询实例 ID。
AuthType	String	否	plain	认证方式，默认取值 plain。
Username	String	否	test****	Kafka 实例使用 PLAIN 模式的用户名称。
Password	String	否	test****	Kafka 实例使用 PLAIN 模式的用户密码。
Topic	String	否	my_topic	Kafka 的 Topic 名称。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域。

VolcRocketMQSettings

参数	类型	是否必选	示例值	描述
InstanceId	String	否	MQ_INST_*****	实例 ID。说明在 EndpointType 取值为 Volc_RocketMQ 时，该参数必选。您可以调用 GetInstance接口查询实例 ID。
AuthType	String	否	plain	认证方式，默认取值 plain。
Username	String	否	test****	RocketMQ 实例的用户名称。
Password	String	否	test****	RocketMQ 实例的用户密码。
Topic	String	否	my_topic	RocketMQ 的 Topic 名称。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域。

VolcRedisSettings

参数	类型	是否必选	示例值	描述
DBInstanceId	String	否	redis-cn0212gzmh2xs****	实例 ID。说明在 EndpointType 取值为 Volc_Redis 时，该参数必选。您可以调用 DescribeDBInstances接口查询实例 ID。
Username	String	否	test****	数据库账号。
Password	String	否	test****	数据库密码。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域。
CrossAccountSettings	Object of CrossAccountSettings	否	{ "SourceAccount":"2100******", "Role":"test" }	跨账号传输数据的配置信息。

PublicMySQLSettings

参数	类型	是否必选	示例值	描述
Host	String	否	192.168.*.*	自建实例的主机地址。
Port	Integer	否	4	自建实例的端口号。
Username	String	否	test****	数据库账号。
Password	String	否	test****	数据库密码。
SSLSettings	Object of SSLSettings	否	{ "EnableSSL": true, "Cert":"-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----" }	实例加密信息。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域。

SSLSettings

参数	类型	是否必选	示例值	描述
EnableSSL	Boolean	否	false	是否开启 SSL 加密连接方式。取值如下： true：表示开启 SSL 加密。 false：表示不开启 SSL 加密。
Cert	String	否	-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----	CA 证书内容。说明在 EnableSSL 取值为 true时，该参数必选。

PublicPostgreSQLSettings

参数	类型	是否必选	示例值	描述
Host	String	否	192.168.*.*	自建实例的主机地址。
Port	Integer	否	4	自建实例的端口号。
Username	String	否	test****	数据库账号。
Password	String	否	test****	数据库密码。
DBName	String	否	test****	数据库名称。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域。
ExtraParams	Array of ExtraParam	否	[ { "Key": "sslmode", "Value": "require" } ]	表示实例的连接方式，当需要通过公网连接在 AI 原生数据库管理平台（AIDAP）托管的 PostgreSQL 实例，或连接已配置 SSL 的自建实例时需要配置该参数。

ExtraParam

参数	类型	是否必选	示例值	描述
Key	String	否	sslmode	表示启用 SSL 连接方式，当需要通过公网自建或专有网络的方式连接在 AI 原生数据库管理平台（AIDAP）托管的 PostgreSQL 实例，或连接已配置 SSL 的自建实例时，需配置该参数，取值为 sslmode。
Value	String	否	require	表示启用 SSL 连接方式，当需要通过公网自建或专有网络的方式连接在 AI 原生数据库管理平台（AIDAP）托管的 PostgreSQL 实例，或连接已配置 SSL 的自建实例时，需配置该参数，取值为 require。

PublicMongoSettings

参数	类型	是否必选	示例值	描述
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域。
DeployType	String	否	Standalone	MongoDB 实例的类型。取值如下： Standalone：表示单节点。 ReplicaSet：表示副本集。 ShardedCluster：表示分片集群。
PullMethod	String	否	ChangeStream	源端增量获取方式。取值如下： ChangeStream：该获取方式提供从数据集（数据库、集合或管道）中获取特定类型已修改数据的改变事件的方法。例如插入、更新或删除事件。如果选择该获取方式，那么实例的版本需大于等于 3.6。 Oplog：该获取方式表示直接获取 MongoD 操作日志。对于 MongoDB 分片集，选择该获取方式后需要填写所有分片地址。该方式相较于 ChangeStream 能提供更好的同步性能。 None：选择 None 后无法选择增量迁移，只能选择全量迁移。说明当 DeployType 参数取值为 ShardedCluster时，需设置该参数信息。
Endpoints	Array of String	否	192.168.*.*:4	mongos 地址，格式为 host:port。在存在多个地址时，需使用英文逗号（,）隔开，最多支持配置 5 个地址。
Username	String	否	test****	mongos 数据库账号。
Password	String	否	test****	mongos 的数据库密码。
MongoAuthSourceDB	String	否	admin	mongos 的账号校验数据库名称。
Shards	Array of MongoShardSetting	否	{ "Address": "192.168.0.1:27019,192.168.0.1:27020", "Username": "test**", "Password": "test**", "AuthDb": "admin" }	分片地址信息。说明作为返回参数时，则不返回该参数的相关信息。
UseNewShardingDatasource	Boolean	否	true	是否选择使用新版分片接入方式，取值如下： false：表示不使用新版分片接入方式。 true：表示使用新版分片接入方式。部署类型为分片集场景时为默认值。

MongoShardSetting

参数	类型	是否必选	示例值	描述
Address	String	否	192.168.0.1:27019,192.168.0.1:27020	分片地址，例如 IP:端口或域名:端口。在存在多个地址时，需使用英文逗号（,）隔开，最多支持配置 5 个地址。
Username	String	否	test****	数据库账号。
Password	String	否	test****	数据库密码。
AuthDb	String	否	admin	账号校验数据库。

PublicElasticSearchSettings

参数	类型	是否必选	示例值	描述
Endpoints	Array of String	否	192.168.*.*	自建实例主机地址。
Username	String	否	test****	数据库账号。
Password	String	否	test****	数据库密码。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域。

PublicRedisSettings

参数	类型	是否必选	示例值	描述
Host	String	否	192.168.*.*	自建实例的主机地址。
Port	Integer	否	4	自建实例的端口号。
Username	String	否	test****	数据库账号。
Password	String	否	test****	数据库密码。
DBName	String	否	test****	数据库名称。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域。

BuiltinKafkaSettings

参数	类型	是否必选	示例值	描述
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" ]	Broker 的 IP 地址及端口号，格式为 host:port。
Topic	String	否	6f2fd63c0ea947b280877f5d2a******	Kafka 的 Topic ID。

ExpressMongoSettings

参数	类型	是否必选	示例值	描述
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	地域 ID。
DeployType	String	否	ShardedCluster	实例的实例类型。取值如下： Standalone：表示单节点。 ReplicaSet：表示副本集。 ShardedCluster：表示分片集群。
PullMethod	String	否	ChangeStream	源端增量获取方式。取值如下： ChangeStream：该获取方式提供从数据集（数据库、集合或管道）中获取特定类型已修改数据的改变事件的方法。例如插入、更新或删除事件。如果选择该获取方式，那么实例的版本需大于等于 3.6。 Oplog：该获取方式表示直接获取 MongoD 操作日志。对于 MongoDB 分片集，选择该获取方式后需要填写所有分片地址。该方式相较于 ChangeStream 能提供更好的同步性能。 None：选择 None 后无法选择增量迁移，只能选择全量迁移。说明当 DeployType 参数取值为 ShardedCluster时，需设置该参数信息。
PrivateNetworkSettings	Object of PrivateNetworkSettings	否	{ "VpcId": "vpc-bp1opxu1zkhn00gz**", "SubnetId": "subnet-bpkdt37pq72zv**" }	私有网络的配置信息。
Endpoints	Array of String	否	192.168.*.*:4	mongos 地址，格式为 host:port。在存在多个地址时，需使用英文逗号（,）隔开，最多支持配置 5 个地址。
Username	String	否	test****	mongos 数据库账号。
Password	String	否	test****	mongos 的数据库密码。
MongoAuthSourceDB	String	否	admin	mongos 的账号校验数据库名称。
Shards	Array of MongoShardSetting	否	{ "Address": "192.168.0.1:27019,192.168.0.1:27020", "Username": "test**", "Password": "test**", "AuthDb": "admin" }	分片地址信息。说明作为返回参数时，则不返回该参数的相关信息。
UseNewShardingDatasource	Boolean	否	true	是否选择使用新版分片接入方式，取值如下： false：表示不使用新版分片接入方式。 true：表示使用新版分片接入方式。部署类型为分片集场景时为默认值。

PrivateNetworkSettings

参数	类型	是否必选	示例值	描述
VPCId	String	否	vpc-bp1opxu1zkhn00gz****	私有网络 ID。根据专有网络的连接方式，私有网络 ID 取值如下所示：专线连接：通过专线 CEN 实现数据连通时，设置 CEN 所属的任意私有网络的 ID。 VPN 连接：通过 VPN 实现数据连通时，设置 VPN 网关绑定的私有网络的 ID。
SubnetId	String	否	subnet-bpkdt37pq72zv****	私有网络 ID 内的子网 ID。说明子网网段需加入到目标数据库对应的白名单或安全组规则中。

ExpressMySQLSettings

参数	类型	是否必选	示例值	描述
Host	String	否	192.168.*.*	专有网络 MySQL 实例的主机地址。
Port	Integer	否	4	专有网络 MySQL 实例的端口。
Username	String	否	test***	专有网络 MySQL 实例的数据库账号。
Password	String	否	Admin@***	专有网络 MySQL 实例的数据库账号密码。
PrivateNetworkSettings	Object of PrivateNetworkSettings	否	{ "VpcId": "vpc-bp1opxu1zkhn00gz**", "SubnetId": "subnet-bpkdt37pq72zv**" }	私有网络的配置信息。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	地域 ID。

ExpressPostgreSQLSettings

参数	类型	是否必选	示例值	描述
Host	String	否	192.168.*.*	专有网络 PostgreSQL 实例的主机地址。
Port	Integer	否	4	专有网络 PostgreSQL 实例的端口。
Username	String	否	test***	专有网络 PostgreSQL 实例的数据库账号。
Password	String	否	Admin@***	专有网络 PostgreSQL 实例的数据库账号密码。
DBName	String	否	test****	数据库名称。
PrivateNetworkSettings	Object of PrivateNetworkSettings	否	{ "VpcId": "vpc-bp1opxu1zkhn00gz**", "SubnetId": "subnet-bpkdt37pq72zv**" }	私有网络的配置信息。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	地域 ID。
ExtraParams	Array of ExtraParam	否	[ { "Key": "sslmode", "Value": "require" } ]	表示实例的连接方式，当需要通过专网连接在 AI 原生数据库管理平台（AIDAP）托管的 PostgreSQL 实例，或连接已配置 SSL 的自建实例时需要配置该参数。

ExpressRedisSettings

参数	类型	是否必选	示例值	描述
ArchType	String	否	Standalone	架构类型，取值如下： Standalone：单机版。 Cluster：集群版。说明如果专有网络 Redis 实例的集群有 Proxy 服务，那么 ArchType 需要设置为 Standalone。
Host	String	否	192.168.*.*	专有网络 Redis 实例实例的主机地址。说明当参数 ArchType 设置为 Standalone时，需设置该参数。
Port	Integer	否	4	专有网络 Redis 实例的端口。说明当参数 ArchType 设置为 Standalone时，需设置该参数。
Endpoints	Array of String	否	10.10.10.10:3717	请输入专线打通的私有网络内 Redis 集群各分片主节点的 IP:端口，以英文逗号分隔，例如：ip1:port1,ip2:port2,ip3:port3。说明当参数 ArchType 设置为 Cluster时，需设置该参数。
PrivateNetworkSettings	Object of PrivateNetworkSettings	否	{ "VpcId": "vpc-bp1opxu1zkhn00gz**", "SubnetId": "subnet-bpkdt37pq72zv**" }	私有网络的配置信息。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	地域 ID。
Username	String	否	test***	专有网络 Redis 实例的数据库账号。
Password	String	否	Admin@***	专有网络 Redis 实例的数据库账号密码。说明当参数 ArchType 设置为 Cluster时，多个分片的密码需一致，否则无法成功连接。

ExpressElasticSearchSettings

参数	类型	是否必选	示例值	描述
Endpoints	Array of String	否	[192.168.*.*]	专有网络 ElasticSearch 实例的主机地址。
Username	String	否	test***	专有网络 ElasticSearch 实例的数据库账号。
Password	String	否	Admin@***	专有网络 ElasticSearch 实例的数据库账号密码。
PrivateNetworkSettings	Object of PrivateNetworkSettings	否	{ "VpcId": "vpc-bp1opxu1zkhn00gz**", "SubnetId": "subnet-bpkdt37pq72zv**" }	私有网络的配置信息。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	地域 ID。

ExpressKafkaSettings

参数	类型	是否必选	示例值	描述
BrokerEndpoints	Array of String	否	[10.1.*.*:9093]	专有网络 Kafka 实例 Broker 的 IP 地址及端口号，格式为 host1:port1。当存在多个 Broker 时，需使用英文逗号（,）隔开。
AuthType	String	否	plain	认证方式，默认取值 plain。
Username	String	否	test***	专有网络 Kafka 实例的数据库账号。
Password	String	否	Admin@***	专有网络 Kafka 实例的数据库账号密码。
Topic	String	否	dts_sydtest	专有网络 Kafka 实例的 Topic 信息。
PrivateNetworkSettings	Object of PrivateNetworkSettings	否	{ "VpcId": "vpc-bp1opxu1zkhn00gz**", "SubnetId": "subnet-bpkdt37pq72zv**" }	私有网络的配置信息。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	地域 ID。

VolcMilvusSettings

参数	类型	是否必选	示例值	描述
Password	String	否	admin@******	数据库密码。
Username	String	否	test****	数据库账号。
DBInstanceId	String	否	milvus-008ks8******	实例 ID。
DBInstanceName	String	否	test****	实例名称。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-shanghai" }	实例所属地域 ID。

PublicMilvusSettings

参数	类型	是否必选	示例值	描述
Password	String	否	test@*****	数据库密码。
Username	String	否	test****	数据库账号。
Endpoints	Array of String	否	[ "milvus-008ks86gpuw8.milvus.ivolces.com" ]	表示公网自建 Milvus 实例的主机地址，当存在多个主机地址时，需使用英文逗号（,）隔开。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-beijing" }	实例所属地域 ID。

ExpressMilvusSettings

参数	类型	是否必选	示例值	描述
Password	String	否	test@*****	数据库密码。
Username	String	否	test****	数据库账号。
Endpoints	Array of String	否	[ "milvus-008ks8******.milvus.ivolces.com:5432" ]	表示专有网络 Milvus 实例的主机地址，当存在多个主机地址时，需使用英文逗号（,）隔开。
RegionSettings	Object of RegionSettings	否	{ "Region": "cn-beijing" }	实例所属地域 ID。
PrivateNetworkSettings	Object of PrivateNetworkSettings	否	{ "VPCId": "vpc-1a1c2ylbygnwg8nvepj****", "SubnetId": "subnet-3ptgi78ypps006csxy****" }	私有网络的配置信息。

返回参数

参数	类型	示例值	描述
DataSourceId	String	180039483277496****	数据源 ID。

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

数据库传输服务