Creating Data Sources

Updated on 2025-03-26 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to create a data source.

URI

POST /v2/{project_id}/fdi/instances/{instance_id}/datasources

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.
instance_id	Yes	String	Instance ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
datasource_name	Yes	String	Data source name. The value can contain 1 to 255 characters. It cannot be all spaces or contain the following special characters: &<>"'()
datasource_type	Yes	String	Data source type. DB2 GAUSS100 OPENGAUSS: GaussDB MYSQL ORACLE POSTGRESQL SQLSERVER TAURUS DIS DWS HIVE MRSHBASE MRSHDFS MRSHIVE MRSKAFKA MRSREDIS MRSCLICKHOUSE FTP OBS ACTIVEMQ ARTEMISMQ IBMMQ KAFKA MQS RABBITMQ HANA MONGODB REDIS API WEBSOCKET LDAP SAP SNMP AOMDP ROCKETMQ DM CLICKHOUSE HL7 (not supported on Site instances) ROMA20MQS IMF (only for Huawei Cloud Stack)
app_id	Yes	String	ID of the application to which the data source belongs.
content	Yes	Content object	Data source details.
description	No	String	description.

**Table 4** Content
Parameter	Mandatory	Type	Description
gauss100_version	No	String	GaussDB 100 version. This parameter is mandatory for a GaussDB 100 data source. V100R003C20 V300R001C00
host	No	String	Host IP address. Mandatory when the data source type is DWS, HANA, RabbitMQ, SAP, SNMP or IBM MQ. Mandatory when the data source type is MySQL, Oracle, SQL Server, Db2, GaussDB 100, TAURUS, ArtemisMQ, PostgreSQL, GaussDB, or HIVE and mode is set to default. Mandatory when the data source type is IMF and mq_type is set to RabbitMQ. The initial value is null and host is generated after a configuration task is started.
port	No	String	Port number, which ranges from 0 to 65535. Mandatory when the data source type is DWS, HANA, RabbitMQ, SAP, SNMP, IBM MQ, or OBS. Mandatory when the data source type is MySQL, Oracle, SQL Server, Db2, GaussDB 100, TAURUS, ArtemisMQ, PostgreSQL, GaussDB, or HIVE and mode is set to default. Mandatory when the data source type is IMF and mq_type is set to RabbitMQ.
database_name	No	String	Database name. Mandatory when the data source type is DWS, HANA, RabbitMQ, SAP, SNMP, IBM MQ, or OBS. Mandatory when the data source type is MySQL, SQL Server, Db2, GaussDB 100, TAURUS, ArtemisMQ, PostgreSQL, GaussDB, or HIVE and mode is set to default. Mandatory when the data source type is Oracle and mode is set to default or multiAddress.
redis_database	No	String	Redis data source type, which is a database ID containing only digits.
user_name	No	String	Username for logging in to the service. Mandatory when the data source type is MySQL, DWS, FTP, Oracle, MongoDB, HANA, SQL Server, Db2, GaussDB 100, TAURUS, ActiveMQ, ArtemisMQ, PostgreSQL, GaussDB, RabbitMQ, SAP, IBM MQ, Hive, IMF, or RocketMQ. Mandatory when the data source type is Websocket and the authentication mode is basicauth. Mandatory when the data source type is LDAP and security_auth_type is set to simple.
password	No	String	Password for logging in to the service. Mandatory when the data source type is MySQL, DWS, FTP, Oracle, MongoDB, HANA, SQL Server, Db2, GaussDB 100, TAURUS, ActiveMQ, ArtemisMQ, PostgreSQL, GaussDB, RabbitMQ, SAP, IBM MQ, Hive, IMF, or RocketMQ. Mandatory when the data source type is Websocket and the authentication mode is basicauth. Mandatory when the data source type is LDAP and security_auth_type is set to simple.
mode	No	String	Data source connection mode. Options: default, professional, and multiAddress. default: The data source type is DWS, MongoDB, Redis, or HANA. default/professional: The data source type is MySQL, SQL Server, Db2, GaussDB 100, and TAURUS, PostgreSQL, GaussDB, or Hive. multiAddress: The data source type is Oracle.
cdc_mode	No	String	CDC mode, which is used only for composite tasks.
multi_oracle_address	No	Array of MultiOracleAddress objects	IP address of the Oracle cluster. This parameter is mandatory when mode is set to multiAddress.
oracle_service_name	No	String	Service name of the Oracle cluster.
ftp_connect_mode	No	String	Connection mode for accessing the FTP service. The value can be active or passive.
ftp_protocol	No	String	Protocol for accessing the FTP service. The value can be SFTP or FTP.
address	No	String	Address. OBS (OBS remote address, which is used by the OBS data source) MONGODB (addresses of the host of the MongoDB data source type, in the format of IP address:Port number, and separated by commas (,)) REDIS (addresses of the host of the Redis data source type, in the format of IP address:Port number, and separated by commas (,))
ak	No	String	Access key ID. This parameter is mandatory when the data source is OBS or DIS.
sk	No	String	Secret access key. This parameter is mandatory when the data source is OBS or DIS.
bucket_name	No	String	Bucket name. This parameter is mandatory when the data source is OBS.
https	No	Boolean	Whether to use HTTPS. This parameter is mandatory when the data source is OBS. Generally, HTTPS is used by default.
url	No	String	Connection URL. Mandatory when the data source type is API, LDAP, or Websocke. Mandatory when the data source type is MySQL, Oracle, Db2, GaussDB 100, TAURUS, PostgreSQL, or GaussDB and mode is set to professional.
api_method	No	String	API access request mode. POST PUT DELETE PATCH GET
auth_method	No	String	Authentication mode for accessing the WEBSOCKET service. none basicauth
api_auth_detail	No	ApiAuthDetail object	API authentication field details.
broker	No	String	Addresses of the Kafka, MQS and ActiveMQ servers, in the format of IP address:Port number. Use commas (,) to separate multiple IP addresses and port numbers.
ssl	No	Boolean	Whether to enable SSL authentication. If the internal MQS address is connected and MQS has enabled SSL, enable SSL authentication for the data source.
ssl_enable	No	Boolean	Whether to enable SSL authentication. This parameter is mandatory when the data source is KAFKA. This parameter is mandatory when the data source is ARTEMISMQ, ACTIVEMQ, RABBITMQ, or IBMMQ.
ssl_username	No	String	SSL user name or application key. This parameter is mandatory when the data source is KAFKA or MQS and SSL authentication is enabled.
ssl_password	No	String	SSL password or application secret. This parameter is mandatory when the data source is KAFKA or MQS and SSL authentication is enabled.
acl_enable	No	Boolean	Whether to enable access control authentication. Mandatory when the data source type is RocketMQ.
mq_type	No	String	Message queue type of the IMF data source. RocketMQ RabbitMQ
mongodb_auth_source	No	String	MONGODB authentication source.
mongodb_cluster_enable	No	Boolean	MONGODB cluster mode. true (cluster mode) false (non-cluster mode)
mongodb_replica_set	No	String	MongoDB replica set. Mandatory when MongoDB is in non-cluster mode.
encoding	No	String	Encoding format. If the data source type is GAUSS100 or POSTGRESQL, set this parameter to big5. This parameter is mandatory when the data source type is MySQL or TAURUS and mode is default.
mysql_timeout	No	Integer	MySQL connection timeout time (seconds).
trust_store_password	No	String	Password of the public key library. This parameter is mandatory when the data source is ACTIVEMQ, ARTEMISMQ, RABBITMQ, or IBMMQ and SSL authentication is enabled.
trust_store	No	String	Public key library file. This parameter is mandatory when the data source is ACTIVEMQ, ARTEMISMQ, RABBITMQ, or IBMMQ and SSL authentication is enabled.
trust_store_file_type	No	String	Type of a public key library file. This parameter is mandatory when the data source is ACTIVEMQ, ARTEMISMQ, RABBITMQ, or IBMMQ and SSL authentication is enabled.
ssl_auth_method	No	String	Authentication method. This parameter is mandatory when the data source is ACTIVEMQ or ARTEMISMQ and SSL authentication is enabled. one-way two-way
key_store	No	String	Content of the private key library file. This parameter is mandatory when the data source is ACTIVEMQ or ARTEMISMQ and the SSL authentication is enabled and the authentication mode is two-way.
key_store_file_type	No	String	Type of the private key library file. This parameter is mandatory when the data source is ACTIVEMQ or ARTEMISMQ, SSL authentication is enabled, and the authentication mode is two-way.
key_store_password	No	String	Private key library password. This parameter is mandatory when the data source is ACTIVEMQ or ARTEMISMQ, SSL authentication is enabled, and the authentication mode is two-way.
key_store_key_password	No	String	Private key of the private key library. This parameter is mandatory when the data source is ACTIVEMQ or ARTEMISMQ, SSL authentication is enabled, and the authentication mode is two-way.
dis_tunnel_name	No	String	DIS tunnel name.
dis_data_type	No	String	DIS data type. JSON
dis_setting_type	No	String	DIS configuration type. senior basic
dis_endpoint	No	String	DIS endpoint. This parameter is mandatory when setting_type is set to senior.
dis_region	No	String	DIS region. This parameter is mandatory when setting_type is set to senior.
dis_source_project_id	No	String	Project ID of the DIS source. This parameter is mandatory when setting_type is set to senior.
hl7_position	No	String	HL7 data source direction. source target
hl7_whitelist_enable	No	Boolean	Whether to enable the HL7 whitelist setting.
hl7_whitelist	No	String	HL7 whitelist. IP address of the server that allows data synchronization to the HL7 source end. Set this parameter when HL7 is the source (position set to source) and the whitelist setting is enabled (open_whitelist set to true).
ldap_security_auth_type	No	String	LDAP security authentication type.
rabbitmq_virtual_host	No	String	RabbitMQ virtual host.
rabbitmq_ssl_protocol	No	String	RabbitMQ SSL authentication protocol. TLS
rocketmq_namesrv_addr	No	String	RocketMQ connection address of the IMF data source. This parameter is mandatory when mq_type is set to RocketMQ. Use commas (,) to separate multiple addresses.
namesrv_addr	No	String	ROMA 20.0 MQS connection address
app_id	No	String	ROMA 20.0 MQS APP Key
app_secret	No	String	ROMA 20.0 APP Secret
sap_client	No	String	SAP client ID.
sap_sysnr	No	String	SAP instance ID.
snmp_network_protocol	No	String	SNMP network protocol. udp tcp
snmp_version	No	Integer	SNMP version number.
snmp_community	No	String	SNMP community name, which is used as an authentication password for access to the SNMP management agent.
ibmmq_ccs_id	No	String	IBMMQ character set ID.
ibmmq_queue_manager	No	String	IBMMQ queue manager.
ibmmq_channel	No	String	IBMMQ channel name.
ibmmq_cipher_suite	No	String	IBMMQ cipher algorithm suite.
hdfs_path	No	String	HDFS URL. This parameter is mandatory when the data source is MRSHIVE or MRSHDFS.
principal_name	No	String	Machine-machine interaction username. This parameter is mandatory when the data source is MRS Hive, MRS HDFS, MRS HBase, MRS Kafka, or MRS Redis.
config_file_name	No	String	User authentication file. For details about how to obtain the file, see "Appendix" > "Obtaining a Data Source Configuration File" in the API Reference. Compress the obtained files into a ZIP package, and set config_file_name to the file name and config_file_content to the Base64-encoded file content. Mandatory when the data source type is MRS Hive, MRS HDFS, MRS HBase, MRS Kafka, MRS Redis or MRS ClickHouse.
config_file_content	No	String	Content of the user authentication file. Base64-encoded file content corresponding to config_file_name. Mandatory when the data source type is MRS Hive, MRS HDFS, MRS HBase, MRS Kafka, MRS Redis, or MRS ClickHouse.
connection_instance_id	No	String	Connector instance ID, which is generated when a connector is published
connector_params	No	Object	Data source parameter corresponding to the connector. Set this parameter based on actual requirements.

**Table 5** MultiOracleAddress
Parameter	Mandatory	Type	Description
oracle_address	No	String	Oracle address.
oracle_port	No	String	Oracle port number.

**Table 6** ApiAuthDetail
Parameter	Mandatory	Type	Description
auth_method	No	String	Authentication mode for accessing the API service. none basicauth oauth2.0 hmac secret md5 apiGateway, which corresponds to AppKey Auth authentication on the console. keyTop hikVision huaweiNetworkManagement liHe
app_auth_type	No	String	App authentication mode for accessing the API service. This parameter is mandatory when the authentication mode is apiGateway. default secret jwt
user_name	No	String	Username for accessing the API service. This parameter is mandatory when the authentication mode is LiHe, huaweiNetworkManagement, or basicauth.
password	No	String	Password for accessing the API service. This parameter is mandatory when the authentication mode is LiHe, huaweiNetworkManagement, basicauth, secret, md5 or hmac.
app_key	No	String	AppKey for accessing the API service. This parameter is mandatory when the authentication mode is apiGateway.
app_secret	No	String	AppSecret for accessing the API service. This parameter is mandatory when the authentication mode is apiGateway.
secret	No	String	Secret for accessing the API service. This parameter is mandatory when the authentication mode is KeyTop, HiKVision, Secret, HMAC, or MD5.
alt_ip	No	String	Alternative IP address for accessing the API service. This parameter is mandatory when the authentication mode is HuaweiNetworkManagement.
access_token_url	No	String	AccessTokenUrl for accessing the API service. This parameter is mandatory when the authentication mode is liHe or oauth2.0 huaweiNetworkManagement.
client_id	No	String	Client ID for accessing the API service. This parameter is mandatory when the authentication mode is Oauth2.
client_id_key	No	String	Client ID for accessing the API service. Set this parameter if the authentication mode is OAuth 2.0. The default value is client_id if not specified.
client_secret	No	String	Client secret for accessing the API service. This parameter is mandatory when the authentication mode is Oauth2.
client_secret_key	No	String	Client key for accessing the API service. Set this parameter if the authentication mode is OAuth 2.0. The default value is client_secret if not specified.
scope	No	String	Scope for accessing the API service. This parameter is mandatory when the authentication mode is LiHe or Oauth2.
authorization	No	String	Authorization for accessing the API service. This parameter is mandatory when the authentication mode is LiHe.
grant_type	No	String	Authorization type for accessing the API service. This parameter is mandatory when the authentication mode is LiHe or Oauth2. The value is client_credentials. This value is used in OAuth2.0.

Response Parameters

Status code: 201

**Table 7** Response body parameters
Parameter	Type	Description
datasource_id	String	Data source ID.
datasource_name	String	Data source name
datasource_type	String	Data source type. DB2 GAUSS100 OPENGAUSS: GaussDB MYSQL ORACLE POSTGRESQL SQLSERVER TAURUS DIS DWS HIVE MRSHBASE MRSHDFS MRSHIVE MRSKAFKA MRSREDIS MRSCLICKHOUSE FTP OBS ACTIVEMQ ARTEMISMQ IBMMQ KAFKA MQS RABBITMQ HANA MONGODB REDIS API WEBSOCKET LDAP SAP SNMP AOMDP ROCKETMQ DM CLICKHOUSE HL7 (not supported on Site instances) ROMA20MQS IMF (only for Huawei Cloud Stack)
vpc_id	String	ID of the VPC to which the data source belongs.
app_id	String	ID of the application to which the data source belongs.
app_name	String	Name of the application to which the data source belongs.
instance_id	String	ID of the instance to which the data source belongs.
create_time	Long	Data source creation time.
update_time	Long	Data source modification time.
custom_plugin_id	String	ID of the connector to which the data source belongs.
content	Content object	Data source details.
description	String	Data source description.
app_permission	Array of strings	Integration application permission. read access delete modify

**Table 8** Content
Parameter	Type	Description
gauss100_version	String	GaussDB 100 version. This parameter is mandatory for a GaussDB 100 data source. V100R003C20 V300R001C00
host	String	Host IP address. Mandatory when the data source type is DWS, HANA, RabbitMQ, SAP, SNMP or IBM MQ. Mandatory when the data source type is MySQL, Oracle, SQL Server, Db2, GaussDB 100, TAURUS, ArtemisMQ, PostgreSQL, GaussDB, or HIVE and mode is set to default. Mandatory when the data source type is IMF and mq_type is set to RabbitMQ. The initial value is null and host is generated after a configuration task is started.
port	String	Port number, which ranges from 0 to 65535. Mandatory when the data source type is DWS, HANA, RabbitMQ, SAP, SNMP, IBM MQ, or OBS. Mandatory when the data source type is MySQL, Oracle, SQL Server, Db2, GaussDB 100, TAURUS, ArtemisMQ, PostgreSQL, GaussDB, or HIVE and mode is set to default. Mandatory when the data source type is IMF and mq_type is set to RabbitMQ.
database_name	String	Database name. Mandatory when the data source type is DWS, HANA, RabbitMQ, SAP, SNMP, IBM MQ, or OBS. Mandatory when the data source type is MySQL, SQL Server, Db2, GaussDB 100, TAURUS, ArtemisMQ, PostgreSQL, GaussDB, or HIVE and mode is set to default. Mandatory when the data source type is Oracle and mode is set to default or multiAddress.
redis_database	String	Redis data source type, which is a database ID containing only digits.
user_name	String	Username for logging in to the service. Mandatory when the data source type is MySQL, DWS, FTP, Oracle, MongoDB, HANA, SQL Server, Db2, GaussDB 100, TAURUS, ActiveMQ, ArtemisMQ, PostgreSQL, GaussDB, RabbitMQ, SAP, IBM MQ, Hive, IMF, or RocketMQ. Mandatory when the data source type is Websocket and the authentication mode is basicauth. Mandatory when the data source type is LDAP and security_auth_type is set to simple.
password	String	Password for logging in to the service. Mandatory when the data source type is MySQL, DWS, FTP, Oracle, MongoDB, HANA, SQL Server, Db2, GaussDB 100, TAURUS, ActiveMQ, ArtemisMQ, PostgreSQL, GaussDB, RabbitMQ, SAP, IBM MQ, Hive, IMF, or RocketMQ. Mandatory when the data source type is Websocket and the authentication mode is basicauth. Mandatory when the data source type is LDAP and security_auth_type is set to simple.
mode	String	Data source connection mode. Options: default, professional, and multiAddress. default: The data source type is DWS, MongoDB, Redis, or HANA. default/professional: The data source type is MySQL, SQL Server, Db2, GaussDB 100, and TAURUS, PostgreSQL, GaussDB, or Hive. multiAddress: The data source type is Oracle.
cdc_mode	String	CDC mode, which is used only for composite tasks.
multi_oracle_address	Array of MultiOracleAddress objects	IP address of the Oracle cluster. This parameter is mandatory when mode is set to multiAddress.
oracle_service_name	String	Service name of the Oracle cluster.
ftp_connect_mode	String	Connection mode for accessing the FTP service. The value can be active or passive.
ftp_protocol	String	Protocol for accessing the FTP service. The value can be SFTP or FTP.
address	String	Address. OBS (OBS remote address, which is used by the OBS data source) MONGODB (addresses of the host of the MongoDB data source type, in the format of IP address:Port number, and separated by commas (,)) REDIS (addresses of the host of the Redis data source type, in the format of IP address:Port number, and separated by commas (,))
ak	String	Access key ID. This parameter is mandatory when the data source is OBS or DIS.
sk	String	Secret access key. This parameter is mandatory when the data source is OBS or DIS.
bucket_name	String	Bucket name. This parameter is mandatory when the data source is OBS.
https	Boolean	Whether to use HTTPS. This parameter is mandatory when the data source is OBS. Generally, HTTPS is used by default.
url	String	Connection URL. Mandatory when the data source type is API, LDAP, or Websocke. Mandatory when the data source type is MySQL, Oracle, Db2, GaussDB 100, TAURUS, PostgreSQL, or GaussDB and mode is set to professional.
api_method	String	API access request mode. POST PUT DELETE PATCH GET
auth_method	String	Authentication mode for accessing the WEBSOCKET service. none basicauth
api_auth_detail	ApiAuthDetail object	API authentication field details.
broker	String	Addresses of the Kafka, MQS and ActiveMQ servers, in the format of IP address:Port number. Use commas (,) to separate multiple IP addresses and port numbers.
ssl	Boolean	Whether to enable SSL authentication. If the internal MQS address is connected and MQS has enabled SSL, enable SSL authentication for the data source.
ssl_enable	Boolean	Whether to enable SSL authentication. This parameter is mandatory when the data source is KAFKA. This parameter is mandatory when the data source is ARTEMISMQ, ACTIVEMQ, RABBITMQ, or IBMMQ.
ssl_username	String	SSL user name or application key. This parameter is mandatory when the data source is KAFKA or MQS and SSL authentication is enabled.
ssl_password	String	SSL password or application secret. This parameter is mandatory when the data source is KAFKA or MQS and SSL authentication is enabled.
acl_enable	Boolean	Whether to enable access control authentication. Mandatory when the data source type is RocketMQ.
mq_type	String	Message queue type of the IMF data source. RocketMQ RabbitMQ
mongodb_auth_source	String	MONGODB authentication source.
mongodb_cluster_enable	Boolean	MONGODB cluster mode. true (cluster mode) false (non-cluster mode)
mongodb_replica_set	String	MongoDB replica set. Mandatory when MongoDB is in non-cluster mode.
encoding	String	Encoding format. If the data source type is GAUSS100 or POSTGRESQL, set this parameter to big5. This parameter is mandatory when the data source type is MySQL or TAURUS and mode is default.
mysql_timeout	Integer	MySQL connection timeout time (seconds).
trust_store_password	String	Password of the public key library. This parameter is mandatory when the data source is ACTIVEMQ, ARTEMISMQ, RABBITMQ, or IBMMQ and SSL authentication is enabled.
trust_store	String	Public key library file. This parameter is mandatory when the data source is ACTIVEMQ, ARTEMISMQ, RABBITMQ, or IBMMQ and SSL authentication is enabled.
trust_store_file_type	String	Type of a public key library file. This parameter is mandatory when the data source is ACTIVEMQ, ARTEMISMQ, RABBITMQ, or IBMMQ and SSL authentication is enabled.
ssl_auth_method	String	Authentication method. This parameter is mandatory when the data source is ACTIVEMQ or ARTEMISMQ and SSL authentication is enabled. one-way two-way
key_store	String	Content of the private key library file. This parameter is mandatory when the data source is ACTIVEMQ or ARTEMISMQ and the SSL authentication is enabled and the authentication mode is two-way.
key_store_file_type	String	Type of the private key library file. This parameter is mandatory when the data source is ACTIVEMQ or ARTEMISMQ, SSL authentication is enabled, and the authentication mode is two-way.
key_store_password	String	Private key library password. This parameter is mandatory when the data source is ACTIVEMQ or ARTEMISMQ, SSL authentication is enabled, and the authentication mode is two-way.
key_store_key_password	String	Private key of the private key library. This parameter is mandatory when the data source is ACTIVEMQ or ARTEMISMQ, SSL authentication is enabled, and the authentication mode is two-way.
dis_tunnel_name	String	DIS tunnel name.
dis_data_type	String	DIS data type. JSON
dis_setting_type	String	DIS configuration type. senior basic
dis_endpoint	String	DIS endpoint. This parameter is mandatory when setting_type is set to senior.
dis_region	String	DIS region. This parameter is mandatory when setting_type is set to senior.
dis_source_project_id	String	Project ID of the DIS source. This parameter is mandatory when setting_type is set to senior.
hl7_position	String	HL7 data source direction. source target
hl7_whitelist_enable	Boolean	Whether to enable the HL7 whitelist setting.
hl7_whitelist	String	HL7 whitelist. IP address of the server that allows data synchronization to the HL7 source end. Set this parameter when HL7 is the source (position set to source) and the whitelist setting is enabled (open_whitelist set to true).
ldap_security_auth_type	String	LDAP security authentication type.
rabbitmq_virtual_host	String	RabbitMQ virtual host.
rabbitmq_ssl_protocol	String	RabbitMQ SSL authentication protocol. TLS
rocketmq_namesrv_addr	String	RocketMQ connection address of the IMF data source. This parameter is mandatory when mq_type is set to RocketMQ. Use commas (,) to separate multiple addresses.
namesrv_addr	String	ROMA 20.0 MQS connection address
app_id	String	ROMA 20.0 MQS APP Key
app_secret	String	ROMA 20.0 APP Secret
sap_client	String	SAP client ID.
sap_sysnr	String	SAP instance ID.
snmp_network_protocol	String	SNMP network protocol. udp tcp
snmp_version	Integer	SNMP version number.
snmp_community	String	SNMP community name, which is used as an authentication password for access to the SNMP management agent.
ibmmq_ccs_id	String	IBMMQ character set ID.
ibmmq_queue_manager	String	IBMMQ queue manager.
ibmmq_channel	String	IBMMQ channel name.
ibmmq_cipher_suite	String	IBMMQ cipher algorithm suite.
hdfs_path	String	HDFS URL. This parameter is mandatory when the data source is MRSHIVE or MRSHDFS.
principal_name	String	Machine-machine interaction username. This parameter is mandatory when the data source is MRS Hive, MRS HDFS, MRS HBase, MRS Kafka, or MRS Redis.
config_file_name	String	User authentication file. For details about how to obtain the file, see "Appendix" > "Obtaining a Data Source Configuration File" in the API Reference. Compress the obtained files into a ZIP package, and set config_file_name to the file name and config_file_content to the Base64-encoded file content. Mandatory when the data source type is MRS Hive, MRS HDFS, MRS HBase, MRS Kafka, MRS Redis or MRS ClickHouse.
config_file_content	String	Content of the user authentication file. Base64-encoded file content corresponding to config_file_name. Mandatory when the data source type is MRS Hive, MRS HDFS, MRS HBase, MRS Kafka, MRS Redis, or MRS ClickHouse.
connection_instance_id	String	Connector instance ID, which is generated when a connector is published
connector_params	Object	Data source parameter corresponding to the connector. Set this parameter based on actual requirements.

**Table 9** MultiOracleAddress
Parameter	Type	Description
oracle_address	String	Oracle address.
oracle_port	String	Oracle port number.

**Table 10** ApiAuthDetail
Parameter	Type	Description
auth_method	String	Authentication mode for accessing the API service. none basicauth oauth2.0 hmac secret md5 apiGateway, which corresponds to AppKey Auth authentication on the console. keyTop hikVision huaweiNetworkManagement liHe
app_auth_type	String	App authentication mode for accessing the API service. This parameter is mandatory when the authentication mode is apiGateway. default secret jwt
user_name	String	Username for accessing the API service. This parameter is mandatory when the authentication mode is LiHe, huaweiNetworkManagement, or basicauth.
password	String	Password for accessing the API service. This parameter is mandatory when the authentication mode is LiHe, huaweiNetworkManagement, basicauth, secret, md5 or hmac.
app_key	String	AppKey for accessing the API service. This parameter is mandatory when the authentication mode is apiGateway.
app_secret	String	AppSecret for accessing the API service. This parameter is mandatory when the authentication mode is apiGateway.
secret	String	Secret for accessing the API service. This parameter is mandatory when the authentication mode is KeyTop, HiKVision, Secret, HMAC, or MD5.
alt_ip	String	Alternative IP address for accessing the API service. This parameter is mandatory when the authentication mode is HuaweiNetworkManagement.
access_token_url	String	AccessTokenUrl for accessing the API service. This parameter is mandatory when the authentication mode is liHe or oauth2.0 huaweiNetworkManagement.
client_id	String	Client ID for accessing the API service. This parameter is mandatory when the authentication mode is Oauth2.
client_id_key	String	Client ID for accessing the API service. Set this parameter if the authentication mode is OAuth 2.0. The default value is client_id if not specified.
client_secret	String	Client secret for accessing the API service. This parameter is mandatory when the authentication mode is Oauth2.
client_secret_key	String	Client key for accessing the API service. Set this parameter if the authentication mode is OAuth 2.0. The default value is client_secret if not specified.
scope	String	Scope for accessing the API service. This parameter is mandatory when the authentication mode is LiHe or Oauth2.
authorization	String	Authorization for accessing the API service. This parameter is mandatory when the authentication mode is LiHe.
grant_type	String	Authorization type for accessing the API service. This parameter is mandatory when the authentication mode is LiHe or Oauth2. The value is client_credentials. This value is used in OAuth2.0.

Status code: 400

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
detail	String	Description details.

Status code: 500

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Create a MySQL data source with the default connection mode.

{
  "datasource_name" : "fdi_ds_y3k674",
  "datasource_type" : "MYSQL",
  "content" : {
    "host" : "**.**.**.**",
    "port" : "3306",
    "database_name" : "testfdi",
    "user_name" : "fditest",
    "password" : "******",
    "mode" : "default"
  },
  "app_id" : "9dbd2cd2-9622-4a1b-ad47-31018cf44cbd",
  "description" : "testtesttest"
}

Create an FTP data source with connection mode as active and protocol type as ftp.

{
  "datasource_name" : "fdi_ds_v2frp",
  "datasource_type" : "FTP",
  "content" : {
    "ftp_connect_mode" : "active",
    "host" : "**.**.**.**",
    "port" : "21",
    "user_name" : "ftpuser",
    "password" : "******",
    "ftp_protocol" : "ftp"
  },
  "app_id" : "9dbd2cd2-9622-4a1b-ad47-31018cf44cbd",
  "description" : "testtesttest"
}

Create an API data source with request method as GET and authentication mode as none.

{
  "datasource_name" : "fdi_ds_api_v2",
  "datasource_type" : "API",
  "content" : {
    "url" : "http%3A%2F%2FVM6_ip%3A1080%2F0928njapi",
    "api_method" : "GET",
    "api_auth_detail" : {
      "auth_method" : "none"
    }
  },
  "description" : "testAPI",
  "app_id" : "9dbd2cd2-9622-4a1b-ad47-31018cf44cbd"
}

Example Responses

Status code: 201

Created

{
  "datasource_id" : "123",
  "datasource_name" : "fdi_ds_api_v2",
  "datasource_type" : "API",
  "content" : {
    "url" : "http%3A%2F%2FVM6_ip%3A1080%2F0928njapi",
    "api_method" : "GET",
    "ApiAuthDetail" : {
      "auth_method" : "none"
    }
  },
  "description" : "testAPI",
  "app_id" : "9dbd2cd2-9622-4a1b-ad47-31018cf44cbd"
}