Help Center/ ROMA Connect/ API Reference/ Data Integration APIs/ Data Source Management/ Testing Data Source Connectivity

Updated on 2023-06-29 GMT+08:00

View PDF

Testing Data Source Connectivity

Function

This API is used to test the data source connectivity.

URI

POST /v2/{project_id}/fdi/instances/{instance_id}/datasources/{datasource_id}/test-connect

**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. Minimum: 1 Maximum: 64
instance_id	Yes	String	Instance ID. Minimum: 1 Maximum: 64
datasource_id	Yes	String	Data source ID. Minimum: 1 Maximum: 64

Request Parameters

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
datasource_name	Yes	String	Data source name. The value is a string of 1 to 255 characters and cannot contain the following special characters: & < > " ' ( ) Minimum: 1 Maximum: 255
datasource_type	Yes	String	Data source type. DB2 GAUSS100 MYSQL ORACLE POSTGRESQL/OPENGAUSS SQL SERVER GAUSSDB(FOR MYSQL) DIS DWS HIVE MRS HBASE MRS HDFS MRS HIVE MRS KAFKA FTP OBS ACTIVEMQ ARTEMISMQ IBM MQ KAFKA MQS RABBITMQ HANA MONGODB REDIS API WEBSOCKET LDAP SAP SNMP AOMDP ROCKETMQ DM CLICKHOUSE Minimum: 4 Maximum: 32
app_id	Yes	String	ID of the application to which the data source belongs. Minimum: 4 Maximum: 255
content	Yes	Content object	Data source details.
description	No	String	Data source description. Minimum: 4 Maximum: 1024

**Table 4** Content
Parameter	Mandatory	Type	Description
gauss100_version	No	String	Gauss100 version. V100R003C20 V300R001C00 Minimum: 1 Maximum: 64
host	No	String	Host IP address. This parameter is mandatory when the data source is DWS, HANA, RABBITMQ, SAP, SNMP or IBMMQ. This parameter is mandatory when the data source is MYSQL, ORACLE, SQLSERVER, DB2, GAUSS100, GaussDB(for MySQL), ARTEMISMQ, POSTGRESQL/OPENGAUSS or HIVE and mode is set to default. The initial value is empty. The host is generated after the configuration task is started. Minimum: 4 Maximum: 255
port	No	String	Port number. The value ranges from 0 to 65535. This parameter is mandatory when the data source is DWS, HANA, RABBITMQ, SAP, SNMP, IBMMQ or OBS. This parameter is mandatory when the data source is MYSQL, ORACLE, SQLSERVER, DB2, GAUSS100, GaussDB(for MySQL), ARTEMISMQ, POSTGRESQL/OPENGAUSS or HIVE and mode is set to default. Minimum: 1 Maximum: 65535
database_name	No	String	Database name. This parameter is mandatory when the data source is DWS, HANA, RABBITMQ, SAP, SNMP, IBMMQ or OBS. This parameter is mandatory when the data source is MYSQL, SQLSERVER, DB2, GAUSS100, GaussDB(for MySQL), ARTEMISMQ, POSTGRESQL/OPENGAUSS or HIVE and mode is set to default. This parameter is mandatory when the data source is ORACLE and mode is set to default or multiAddress. Minimum: 1 Maximum: 2147483647
redis_database	No	String	Redis data source type, which is a database ID containing only digits. Minimum: 1 Maximum: 1000
user_name	No	String	User name for accessing the service. This parameter is mandatory when the data source is MYSQL, DWS, FTP, ORACLE, MONGODB, HANA, SQLSERVER, DB2, GAUSS100, GaussDB(for MySQL), ACTIVEMQ, ARTEMISMQ, POSTGRESQL/OPENGAUSS, RABBITMQ, SAP, IBMMQ or HIVE. This parameter is mandatory when the data source is WEBSOCKET and the authentication mode is basicauth. This parameter is mandatory when the data source is LDAP and the security authentication type (security_auth_type) is simple. Minimum: 4 Maximum: 2147483647
password	No	String	Password for accessing the service. This parameter is mandatory when the data source is MYSQL, DWS, FTP, ORACLE, MONGODB, HANA, SQLSERVER, DB2, GAUSS100, GaussDB(for MySQL), ACTIVEMQ, ARTEMISMQ, POSTGRESQL/OPENGAUSS, RABBITMQ, SAP, IBMMQ or HIVE. This parameter is mandatory when the data source is WEBSOCKET type and the authentication mode is basicauth. This parameter is mandatory when the data source is LDAP and the security authentication type (security_auth_type) is simple. Minimum: 4 Maximum: 2147483647
mode	No	String	Data source connection mode. The value can be default, professional, or multiAddress. Set to default when the data source is DWS, MONGODB, REDIS, or HANA. Set to default or professional when the data source is MYSQL, SQLSERVER, DB2, GAUSS100, GaussDB(for MySQL), POSTGRESQL/OPENGAUSS or HIVE. Set to multiAddress when the data source is ORACLE. Minimum: 4 Maximum: 255
cdc_mode	No	String	CDC mode, which is used only for composite tasks. Minimum: 4 Maximum: 10
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. Minimum: 4 Maximum: 64
ftp_connect_mode	No	String	Connection mode for accessing the FTP service. The value can be active or passive. Minimum: 4 Maximum: 2147483647
ftp_protocol	No	String	Protocol for accessing the FTP service. The value can be SFTP or FTP. Minimum: 4 Maximum: 2147483647
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 (,)) Minimum: 0 Maximum: 256
ak	No	String	Access key ID. This parameter is mandatory when the data source is OBS or DIS. Minimum: 0 Maximum: 256
sk	No	String	Secret access key. This parameter is mandatory when the data source is OBS or DIS. Minimum: 0 Maximum: 256
bucket_name	No	String	Bucket name. This parameter is mandatory when the data source is OBS. Minimum: 0 Maximum: 256
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 string, indicating the access URL. This parameter is mandatory when the data source is API, LDAP, or WEBSOCKE. This parameter is mandatory when the data source is MYSQL, ORACLE, DB2, GAUSS100, GaussDB(for MySQL) or POSTGRESQL/OPENGAUSS and mode is set to professional. Minimum: 0 Maximum: 256
api_method	No	String	API access request mode. POST PUT DELETE PATCH GET Minimum: 0 Maximum: 10
auth_method	No	String	Authentication mode for accessing the WEBSOCKET service. none basicauth Minimum: 0 Maximum: 256
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. Minimum: 0 Maximum: 256
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. Minimum: 0 Maximum: 256
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. Minimum: 0 Maximum: 256
mongodb_auth_source	No	String	MONGODB authentication source. Minimum: 0 Maximum: 60
mongodb_cluster_enable	No	Boolean	MONGODB cluster mode. true (cluster mode) false (non-cluster mode)
mongodb_replica_set	No	String	MONGODB replica set. This parameter is mandatory when the MONGODB is in non-cluster mode. Minimum: 0 Maximum: 256
encoding	No	String	Encoding format. This parameter is set to big5 when the data source is GAUSS100 or POSTGRESQL/OPENGAUSS. This parameter is mandatory when the data source is MYSQL or GaussDB(for MySQL) and mode is set to default. Minimum: 0 Maximum: 10
mysql_timeout	No	Integer	MySQL connection timeout time (seconds). Minimum: 1 Maximum: 20000
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. Minimum: 0 Maximum: 256
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. Minimum: 0 Maximum: 1024
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. Minimum: 0 Maximum: 10
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 Minimum: 0 Maximum: 10
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. Minimum: 0 Maximum: 1024
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. Minimum: 0 Maximum: 10
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. Minimum: 0 Maximum: 256
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. Minimum: 0 Maximum: 256
dis_tunnel_name	No	String	DIS tunnel name. Minimum: 0 Maximum: 256
dis_data_type	No	String	DIS data type. JSON Minimum: 0 Maximum: 256
dis_setting_type	No	String	DIS configuration type. senior basic Minimum: 0 Maximum: 256
dis_endpoint	No	String	DIS endpoint. This parameter is mandatory when setting_type is set to senior. Minimum: 0 Maximum: 256
dis_region	No	String	DIS region. This parameter is mandatory when setting_type is set to senior. Minimum: 0 Maximum: 256
dis_source_project_id	No	String	Project ID of the DIS source. This parameter is mandatory when setting_type is set to senior. Minimum: 0 Maximum: 256
hl7_position	No	String	HL7 data source direction. source target Minimum: 0 Maximum: 256
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). Minimum: 0 Maximum: 256
ldap_security_auth_type	No	String	LDAP security authentication type. Minimum: 0 Maximum: 256
rabbitmq_virtual_host	No	String	RabbitMQ virtual host. Minimum: 0 Maximum: 256
rabbitmq_ssl_protocol	No	String	RabbitMQ SSL authentication protocol. TLS Minimum: 0 Maximum: 10
sap_client	No	String	SAP client ID. Minimum: 0 Maximum: 10
sap_sysnr	No	String	SAP instance ID. Minimum: 0 Maximum: 256
snmp_network_protocol	No	String	SNMP network protocol. udp tcp Minimum: 0 Maximum: 10
snmp_version	No	Integer	SNMP version number. Minimum: 0 Maximum: 3
snmp_community	No	String	SNMP community name, which is used as an authentication password for access to the SNMP management agent. Minimum: 0 Maximum: 256
ibmmq_ccs_id	No	String	IBMMQ character set ID. Minimum: 0 Maximum: 65535
ibmmq_queue_manager	No	String	IBMMQ queue manager. Minimum: 0 Maximum: 256
ibmmq_channel	No	String	IBMMQ channel name. Minimum: 0 Maximum: 256
ibmmq_cipher_suite	No	String	IBMMQ cipher algorithm suite. Minimum: 0 Maximum: 256
hdfs_path	No	String	HDFS URL. This parameter is mandatory when the data source is MRSHIVE or MRSHDFS. Minimum: 0 Maximum: 256
principal_name	No	String	Machine-machine interaction username. This parameter is mandatory when the data source is MRSHIVE, MRSHDFS, MRSHBASE or MRSKAFKA. Minimum: 0 Maximum: 256
config_file_name	No	String	User authentication file. For details about how to obtain the file, see Appendix > Obtaining the Data Source Configuration File in the ROMA Connect API Reference. Compress the obtained files into a .zip package, set config_file_name to the file name, and place the file content in config_file_content in Base64 encoding mode. This parameter is mandatory when the data source is MRSHIVE, MRSHDFS, MRSHBASE, MRSKAFKA, FIHDFS, FIHIVE or FIKAFKA. Minimum: 0 Maximum: 256
config_file_content	No	String	Content of the user authentication file. the Content of the config_file_name file is encoded in Base64. This parameter is mandatory when the data source is MRSHIVE, MRSHDFS, MRSHBASE or MRSKAFKA. Minimum: 0 Maximum: 256
connection_instance_id	No	String	Connector instance ID, which is generated when a connector is published Minimum: 0 Maximum: 256
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. Minimum: 1 Maximum: 30
oracle_port	No	String	Oracle port number. Minimum: 1 Maximum: 10

**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 Minimum: 0 Maximum: 256
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 Minimum: 0 Maximum: 2000
user_name	No	String	Username for accessing the API service. This parameter is mandatory when the authentication mode is LiHe, huaweiNetworkManagement, or basicauth. Minimum: 4 Maximum: 2000
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. Minimum: 4 Maximum: 2000
app_key	No	String	AppKey for accessing the API service. This parameter is mandatory when the authentication mode is apiGateway. Minimum: 0 Maximum: 256
app_secret	No	String	AppSecret for accessing the API service. This parameter is mandatory when the authentication mode is apiGateway. Minimum: 0 Maximum: 256
secret	No	String	Secret for accessing the API service. This parameter is mandatory when the authentication mode is KeyTop, HiKVision, Secret, HMAC, or MD5. Minimum: 0 Maximum: 256
alt_ip	No	String	Alternative IP address for accessing the API service. This parameter is mandatory when the authentication mode is HuaweiNetworkManagement. Minimum: 0 Maximum: 256
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. Minimum: 0 Maximum: 256
client_id	No	String	Client ID for accessing the API service. This parameter is mandatory when the authentication mode is Oauth2. Minimum: 0 Maximum: 256
client_secret	No	String	Client secret for accessing the API service. This parameter is mandatory when the authentication mode is Oauth2. Minimum: 0 Maximum: 256
scope	No	String	Scope for accessing the API service. This parameter is mandatory when the authentication mode is LiHe or Oauth2. Minimum: 0 Maximum: 256
authorization	No	String	Authorization for accessing the API service. This parameter is mandatory when the authentication mode is LiHe. Minimum: 0 Maximum: 256
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. Minimum: 0 Maximum: 256

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
result	Boolean	Returned result. true (success) Minimum: 0 Maximum: 10

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 8 Maximum: 36
error_msg	String	Error message. Minimum: 2 Maximum: 512
detail	String	Description details. Minimum: 2 Maximum: 512

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 8 Maximum: 36
error_msg	String	Error message. Minimum: 2 Maximum: 512

Example Requests

{
  "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"
}

Example Responses

Status code: 200

{
  "result" : true
}

Status code: 400

Error response

{
  "error_code" : "FDI.3016",
  "error_msg" : "Failed to test the connectivity.",
  "detail" : "Test connection failed."
}

Status Codes

Status Code	Description
200	OK
400	Error response
404	Not Found

Error Codes

See Error Codes.

Parent topic: Data Source Management

Previous topic: Obtaining All Fields in a Table in the Data Source

Next topic: Task Monitoring and Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot