测试数据源连通性
功能介绍
测试数据源连通性
URI
POST /v2/{project_id}/fdi/instances/{instance_id}/datasources/{datasource_id}/test-connect
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。 最小长度:1 最大长度:64 |
instance_id |
是 |
String |
实例的ID 最小长度:1 最大长度:64 |
datasource_id |
是 |
String |
数据源ID 最小长度:1 最大长度:64 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
datasource_name |
是 |
String |
数据源名称,数据源名称不能包含&、<、>、"、'、(、) ,长度为1~255字符,参数不能全部为空格 最小长度:1 最大长度:255 |
datasource_type |
是 |
String |
数据源类型
最小长度:4 最大长度:32 |
app_id |
是 |
String |
数据源所属应用ID 最小长度:4 最大长度:255 |
content |
是 |
Content object |
数据源详细信息 |
description |
否 |
String |
最大长度:1024 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
gauss100_version |
否 |
String |
gauss100的版本号
最小长度:1 最大长度:64 |
host |
否 |
String |
主机IP地址
最小长度:4 最大长度:255 |
port |
否 |
String |
端口,端口号为0到65535
最小长度:1 最大长度:65535 |
database_name |
否 |
String |
数据库名称
最小长度:1 最大长度:2147483647 |
redis_database |
否 |
String |
REDIS数据源类型配置,数据库编号,纯数字编码 最小长度:1 最大长度:1000 |
user_name |
否 |
String |
访问服务的用户名
最小长度:1 最大长度:255 |
password |
否 |
String |
访问服务的密码
最小长度:4 最大长度:2147483647 |
mode |
否 |
String |
数据源连接模式,有三种:default (默认模式)、professional (专业模式)、multiAddress (多地址)
最小长度:4 最大长度:255 |
cdc_mode |
否 |
String |
cdc模式,只有组合任务使用 最小长度:4 最大长度:10 |
multi_oracle_address |
否 |
Array of MultiOracleAddress objects |
ORACLE集群地址,当“mode”为“multiAddress”时需要配置 数组长度:1 - 100 |
oracle_service_name |
否 |
String |
ORACLE集群服务名 最小长度:4 最大长度:64 |
ftp_connect_mode |
否 |
String |
访问FTP服务的连接模式
最小长度:4 最大长度:2147483647 |
ftp_protocol |
否 |
String |
访问FTP服务协议类型
最小长度:4 最大长度:2147483647 |
address |
否 |
String |
地址
最小长度:0 最大长度:256 |
ak |
否 |
String |
Access Key ID
最小长度:0 最大长度:256 |
sk |
否 |
String |
Secret Access Key
最小长度:0 最大长度:256 |
bucket_name |
否 |
String |
桶名称,数据源为OBS时需要配置 最小长度:0 最大长度:256 |
https |
否 |
Boolean |
是否使用https,数据源为OBS时需要配置,一般默认使用 |
url |
否 |
String |
连接字符串,访问url
最小长度:0 最大长度:256 |
api_method |
否 |
String |
访问API请求方式
最小长度:0 最大长度:10 |
auth_method |
否 |
String |
访问WEBSOCKET服务的认证方式
最小长度:0 最大长度:256 |
api_auth_detail |
否 |
ApiAuthDetail object |
Api鉴权详细字段 |
broker |
否 |
String |
KAFKA、MQS、ACTIVEMQ的服务器地址,多个IP:PORT,使用“,”分隔 最小长度:0 最大长度:256 |
ssl |
否 |
Boolean |
是否开启SSL认证
|
ssl_enable |
否 |
Boolean |
是否开启SSL认证
|
ssl_username |
否 |
String |
SSL用户名/应用Key
最小长度:0 最大长度:256 |
ssl_password |
否 |
String |
SSL密码/应用Secret
最小长度:0 最大长度:256 |
mongodb_auth_source |
否 |
String |
MONGODB认证源 最小长度:0 最大长度:60 |
mongodb_cluster_enable |
否 |
Boolean |
MONGODB集群模式
|
mongodb_replica_set |
否 |
String |
MONGODB副本集 当MONGODB为非集群模式时配置 最小长度:0 最大长度:256 |
encoding |
否 |
String |
编码格式
最小长度:0 最大长度:10 |
mysql_timeout |
否 |
Integer |
MYSQL连接超时时间(秒) 最小值:1 最大值:20000 |
trust_store_password |
否 |
String |
公钥库密码
最小长度:0 最大长度:256 |
trust_store |
否 |
String |
公钥库文件
最小长度:0 最大长度:1024 |
trust_store_file_type |
否 |
String |
公钥库文件类型
最小长度:0 最大长度:10 |
ssl_auth_method |
否 |
String |
ssl鉴权方式。 数据源类型为ACTIVEMQ、ARTEMISMQ且开启SSL认证时需要配置
最小长度:0 最大长度:10 |
key_store |
否 |
String |
私钥库文件内容
最小长度:0 最大长度:1024 |
key_store_file_type |
否 |
String |
私钥库文件类型
最小长度:0 最大长度:10 |
key_store_password |
否 |
String |
私钥库密码
最小长度:0 最大长度:256 |
key_store_key_password |
否 |
String |
私钥库私钥密码
最小长度:0 最大长度:256 |
dis_tunnel_name |
否 |
String |
DIS通道名称 最小长度:0 最大长度:256 |
dis_data_type |
否 |
String |
DIS数据类别
最小长度:0 最大长度:256 |
dis_setting_type |
否 |
String |
DIS配置类别
最小长度:0 最大长度:256 |
dis_endpoint |
否 |
String |
DIS Endpoint,当setting_type为senior时填写 最小长度:0 最大长度:256 |
dis_region |
否 |
String |
DIS Region,当setting_type为senior时填写 最小长度:0 最大长度:256 |
dis_source_project_id |
否 |
String |
DIS源端项目ID,当setting_type为senior时填写 最小长度:0 最大长度:256 |
hl7_position |
否 |
String |
HL7数据源方向
最小长度:0 最大长度:256 |
hl7_whitelist_enable |
否 |
Boolean |
HL7是否开启白名单设置 |
hl7_whitelist |
否 |
String |
HL7白名单。允许同步数据到源端HL7的服务器地址,当HL7为源端(position为source)并且开启白名单设置(open_whitelist为true)时填写 最小长度:0 最大长度:256 |
ldap_security_auth_type |
否 |
String |
LDAP安全认证类型 最小长度:0 最大长度:256 |
rabbitmq_virtual_host |
否 |
String |
RABBITMQ虚拟主机 最小长度:0 最大长度:256 |
rabbitmq_ssl_protocol |
否 |
String |
RABBITMQ SSL认证协议
最小长度:0 最大长度:10 |
sap_client |
否 |
String |
SAP客户端号 最小长度:0 最大长度:10 |
sap_sysnr |
否 |
String |
SAP实例编号 最小长度:0 最大长度:256 |
snmp_network_protocol |
否 |
String |
SNMP网络协议
最小长度:0 最大长度:10 |
snmp_version |
否 |
Integer |
SNMP版本号 最小值:0 最大值:3 |
snmp_community |
否 |
String |
SNMP团体名,用于访问SNMP管理代理的身份认证,相当于访问密码 最小长度:0 最大长度:256 |
ibmmq_ccs_id |
否 |
String |
IBMMQ字符集标识 最小长度:0 最大长度:65535 |
ibmmq_queue_manager |
否 |
String |
IBMMQ队列管理器 最小长度:0 最大长度:256 |
ibmmq_channel |
否 |
String |
IBMMQ通道名称 最小长度:0 最大长度:256 |
ibmmq_cipher_suite |
否 |
String |
IBMMQ密钥算法套件 最小长度:0 最大长度:256 |
hdfs_path |
否 |
String |
HDFS URL,数据源为MRSHIVE、MRSHDFS类型时配置 最小长度:0 最大长度:256 |
principal_name |
否 |
String |
机机交互用户名,数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA类型时配置 最小长度:0 最大长度:256 |
config_file_name |
否 |
String |
用户认证文件,文件获取方式参见API参考的“附录>获取数据源配置文件”章节
最小长度:0 最大长度:256 |
config_file_content |
否 |
String |
用户认证文件内容,config_file_name对应的文件内容BASE64编码。 数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA类型时配置 最小长度:0 最大长度:256 |
connection_instance_id |
否 |
String |
连接器实例ID,连接器发布后对应的实例ID 最小长度:0 最大长度:256 |
connector_params |
否 |
Object |
连接器对应的数据源参数,值按实际填写 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
oracle_address |
否 |
String |
ORACLE地址 最小长度:1 最大长度:64 |
oracle_port |
否 |
String |
ORACLE端口 最小长度:1 最大长度:10 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
auth_method |
否 |
String |
访问API服务的认证方式
最小长度:0 最大长度:256 |
app_auth_type |
否 |
String |
访问API服务的APP认证方式,认证方式为(apiGateway)时填写
最小长度:0 最大长度:2000 |
user_name |
否 |
String |
访问API服务的用户名
最小长度:4 最大长度:2000 |
password |
否 |
String |
访问API服务的密码
最小长度:4 最大长度:2000 |
app_key |
否 |
String |
访问API服务的AppKey
最小长度:0 最大长度:256 |
app_secret |
否 |
String |
访问API服务的AppSecret
最小长度:0 最大长度:256 |
secret |
否 |
String |
访问API服务的Secret
最小长度:0 最大长度:256 |
alt_ip |
否 |
String |
访问API服务的备用IP
最小长度:0 最大长度:256 |
access_token_url |
否 |
String |
访问API服务的AccessTokenUrl
最小长度:0 最大长度:256 |
client_id |
否 |
String |
访问API服务的客户端标识
最小长度:0 最大长度:256 |
client_secret |
否 |
String |
访问API服务的客户端密钥
最小长度:0 最大长度:256 |
scope |
否 |
String |
访问API服务的Scope
最小长度:0 最大长度:256 |
authorization |
否 |
String |
访问API服务的Authorization
最小长度:0 最大长度:256 |
grant_type |
否 |
String |
访问API服务的授权类型
最小长度:0 最大长度:256 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
Boolean |
返回结果
最小长度:0 最大长度:10 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
detail |
String |
描述详情 最小长度:2 最大长度:512 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
请求示例
测试指定MySQL数据源的连通性
{ "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" }
响应示例
状态码: 200
OK
{ "result" : true }
状态码: 400
Error response
{ "error_code" : "FDI.3016", "error_msg" : "Failed to test the connectivity.", "detail" : "Test connection failed." }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Error response |
404 |
Not Found |
错误码
请参见错误码。