错误码
5 数据集成 API
5.1 数据源管理
5.1.2 查询数据源
}, "description" : "testAPI",
"app_id" : "9dbd2cd2-9622-4a1b-ad47-31018cf44cbd"
}
状态码
状态码 描述
201 Created 400 Bad Request
500 Internal Server Error
错误码
请参见错误码。
5.1.2 查询数据源
功能介绍
查询数据源
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/fdi/instances/{instance_id}/datasources
表5-12 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方式请参见API参 考的“附录 > 获取项目ID”章 节。
最小长度：1 最大长度：64 instance_id 是 String 实例ID
最小长度：1 最大长度：64
表5-13 Query 参数
参数 是否必选 参数类型 描述
limit 否 Integer 分页查询，每页显示的条目数
量，最大数量999，超过999后 只返回999
最小值：0 最大值：500
offset 否 Integer 分页查询，分页的偏移量，表示
从此偏移量开始查询，偏移量小 于0时，自动转换为0
最小值：0 最大值：999999
参数 是否必选 参数类型 描述
● MRSHBASE
● MRSHDFS
● MRSHIVE
● WEBSOCKET
● SQLSERVER
● ORACLE
● POSTGRESQL
● REDIS
● MONGODB
● DIS
● HL7
● RABBITMQ
● SNMP
● IBMMQ
● CUSTOMIZED (自定义类型)
● ACTIVEMQ
● ARTEMISMQ
● FTP
● HIVE
● HANA
● FIKAFKA
● MRSKAFKA
● FIHDFS
● FIHIVE
● GAUSS200
● GAUSS100
● LDAP
● DB2
● TAURUS 最小长度：0
参数 是否必选 参数类型 描述
最大长度：30
sort_field 否 String 排序字段（CREATED_DATE）
最小长度：0 最大长度：64
sort_type 否 String 查询数据源排序的类型，增序还 是降序，可为空
最小长度：0 最大长度：10
name 否 String 数据源名称,支持模糊匹配
最小长度：0 最大长度：30
app_id 否 String 集成应用ID
最小长度：0 最大长度：64 custom_plugi
n_id 否 String 连接器ID
最小长度：0 最大长度：64 customized 否 String 是否是自定义数据源
最小长度：0 最大长度：5
请求参数
无
响应参数
状态码： 200
表5-14 响应 Body 参数
参数 参数类型 描述
total Long 返回所有满足条件的对象个数
最小值：0
最大值：1000000 size Integer 返回对象的大小
最小值：0 最大值：200
参数 参数类型 描述 entities Array of
DataSourceR sp objects
返回的实体对象
表5-15 DataSourceRsp
参数 参数类型 描述
datasource_id String 数据源ID 最小长度：4 最大长度：64 datasource_n
ame String 数据源名称
最小长度：4 最大长度：255
参数 参数类型 描述
● MRSHBASE
● MRSHDFS
● MRSHIVE
● WEBSOCKET
● SQLSERVER
● ORACLE
● POSTGRESQL
● REDIS
● MONGODB
● DIS
● HL7
● RABBITMQ
● SNMP
● IBMMQ
● CUSTOMIZED (自定义类型)
● ACTIVEMQ
● ARTEMISMQ
● FTP
● HIVE
● HANA
● FIKAFKA
● MRSKAFKA
● FIHDFS
● FIHIVE
● GAUSS200
● GAUSS100
● LDAP
● DB2
● TAURUS 最小长度：1
参数 参数类型 描述
最大长度：32
vpc_id String 数据源所属虚拟私有云VpcId 最小长度：4
最大长度：64 app_id String 数据源所属应用ID
最小长度：4 最大长度：255 app_name String 数据源所属应用名称
最小长度：4 最大长度：255 instance_id String 数据源所属实例Id
最小长度：4 最大长度：255 create_time Integer 数据源创建时间
最小值：0
最大值：99999999999999999 update_time Integer 数据源修改时间
最小值：0
最大值：99999999999999999 custom_plugi
n_id String 数据源所属连接器Id 最小长度：0
最大长度：64 content Content
object 数据源详细信息 description String 数据源描述
最小长度：4
最大长度：2147483647 app_permissio
n Array of
strings 集成应用权限信息
● read (读权限)
● access (调用权限)
● delete (删除权限)
● modify (修改权限)
表5-16 Content
参数 参数类型 描述
gauss100_vers
ion String gauss100的版本号
● V100R003C20
● V300R001C00 最小长度：1 最大长度：64 host String 主机IP地址
● 数据源为DWS、HANA、RABBITMQ、SAP、
SNMP、IBMMQ类型时需要配置。
● 数据源为MYSQL、ORACLE、SQLSERVER、
DB2、GAUSS200、GAUSS100、TAURUS、
ARTEMISMQ、POSTGRESQL、HIVE类型且 mode为default时需要配置。
● 数据源为HL7类型且作为目标端（position为 target）时需要配置。
● 初始值为空，配置任务启动后生成host 最小长度：4
最大长度：255
port String 端口，端口号为0到65535
● 数据源为DWS、HANA、RABBITMQ、SAP、
SNMP、IBMMQ，obs类型时需要配置，
● 数据源为MYSQL、ORACLE、SQLSERVER、
DB2、GAUSS200、GAUSS100、TAURUS、
ARTEMISMQ、POSTGRESQL、HIVE类型且 mode为default时需要配置，
● 数据源为HL7类型且作为目标端（position为 target）时需要配置
最小长度：1 最大长度：65535 database_na
me String 数据库名称
● 数据源为DWS、HANA、RABBITMQ、SAP、
SNMP、IBMMQ，obs类型时需要配置，
● 数据源为MYSQL、SQLSERVER、DB2、
GAUSS200、GAUSS100、TAURUS、
ARTEMISMQ、POSTGRESQL、HIVE类型且 mode为default时需要配置，
● 数据源为ORACLE类型且mode为（default、
multiAddress）时需要配置 最小长度：4
最大长度：2147483647
参数 参数类型 描述 redis_databas
e String REDIS数据源类型配置，数据库编号, 纯数字编码 最小长度：1
最大长度：1000 user_name String 访问服务的用户名
● 数据源为MYSQL、DWS、FTP、ORACLE、
MONGODB、HANA、SQLSERVER、DB2、
GAUSS200、GAUSS100、TAURUS、
ACTIVEMQ、ARTEMISMQ、POSTGRESQL、
RABBITMQ、SAP、IBMMQ、HIVE类型时需 要配置
● 数据源为WEBSOCKET类型，认证方式
（basicauth）时需要配置
● 数据源为LDAP，安全认证类型
（security_auth_type）为simple时需要配置 最小长度：4
最大长度：2147483647 password String 访问服务的密码
● 数据源为MYSQL、DWS、FTP、ORACLE、
MONGODB、HANA、SQLSERVER、DB2、
GAUSS200、GAUSS100、TAURUS、
ACTIVEMQ、ARTEMISMQ、POSTGRESQL、
RABBITMQ、SAP、IBMMQ、HIVE类型时需 要配置
● 数据源为WEBSOCKET，且认证方式
（basicauth）时需要配置
● 数据源为LDAP，且安全认证类型
（security_auth_type）为simple时需要配置 最小长度：4
最大长度：2147483647
mode String 数据源连接模式，有三种：default (默认模式)、
professional (专业模式)、multiAddress (多地址)
● 数据源为DWS、MONGODB、REDIS、HANA 时配置default。
● 数据源为MYSQL、SQLSERVER、DB2、
GAUSS200、GAUSS100、TAURUS、
POSTGRESQL、HIVE时配置default或 professional。
● 数据源为ORACLE时配置专有的模式 multiAddress。
最小长度：4 最大长度：255
参数 参数类型 描述
cdc_mode String cdc模式，只有组合任务使用 最小长度：4
最大长度：10 multi_oracle_
address Array of MultiOracleA
_name String ORACLE集群服务名 最小长度：4 最大长度：64 ftp_connect_
mode String 访问FTP服务的连接模式
● active (主动模式)
● passive (被动模式) 最小长度：4
最大长度：2147483647 ftp_protocol String 访问FTP服务协议类型
● sftp
● ftp 最小长度：4
最大长度：2147483647 address String 地址
● OBS (obs远端地址，obs数据源使用)
● MONGODB (MONGODB数据源类型主机IP地 址，多个IP:PORT, 使用","隔开)
● REDIS (redis服务地址，多个IP:PORT, 使用
","隔开) 最小长度：0 最大长度：256 ak String Access Key ID
● 数据源为OBS，DIS类型时需要配置 最小长度：0
最大长度：256 sk String Secret Access Key
● 数据源为OBS，DIS类型时需要配置 最小长度：0
最大长度：256
参数 参数类型 描述
bucket_name String 桶名称，数据源为OBS时需要配置 最小长度：0
最大长度：256
https Boolean 是否使用https, 数据源为OBS时需要配置，一般 默认使用
最小长度：0 最大长度：10 url String 连接字符串，访问url
● 数据源为API、LDAP、WEBSOCKE类型时需要 配置，
● 数据源为MYSQL、ORACLE、DB2、
GAUSS200、GAUSS100、TAURUS、
POSTGRESQL，且mode配置为professional专 业时需要配置
最小长度：0 最大长度：256 api_method String 访问API请求方式
● POST
● PUT
● DELETE
● PATCH
● GET 最小长度：0 最大长度：10
auth_method String 访问WEBSOCKET服务的认证方式
● none
● basicauth 最小长度：0 最大长度：256 api_auth_deta
il ApiAuthDetai
l object Api鉴权详细字段
broker String KAFKA、ACTIVEMQ的服务器地址，多个 IP:PORT, 使用","分隔
最小长度：0 最大长度：256
参数 参数类型 描述
ssl_enable Boolean 是否开启SSL认证
● 数据源为KAFKA时需要配置，连接MQS内网 地址时，若MQS同时开启了SSL与VPC内网明 文访问，请选择“否”
● 数据源为ARTEMISMQ、ACTIVEMQ、
RABBITMQ、IBMMQ时需要配置，
● 数据源为HL7时且作为源端时需要配置 最小长度：0
最大长度：10 ssl_username String SSL用户名/应用Key
● 数据源为KAFKA且开启SSL认证时需要配置 最小长度：0
最大长度：256 ssl_password String SSL密码/应用Secret
● 数据源为KAFKA且开启SSL认证时需要配置 最小长度：0
最大长度：256 mongodb_aut
h_source String MONGODB认证源 最小长度：0 最大长度：60 mongodb_clu
ster_enable Boolean MONGODB集群模式
● true (集群模式)
● false （非集群模式）
最小长度：0 最大长度：256 mongodb_rep
lica_set String MONGODB副本集 当MONGODB为非集群模式 时配置
最小长度：0 最大长度：256 encoding String 编码格式
● 数据源为GAUSS200、GAUSS100、
POSTGRESQL类型时配置"big5"，
● 数据源为MYSQL、TAURUS类型且mode为 default时配置
最小长度：0 最大长度：10
参数 参数类型 描述 mysql_timeou
t Integer MYSQL连接超时时间（秒）
最小值：1 最大值：20000 trust_store_pa
ssword String 公钥库密码
● 数据源类型为ACTIVEMQ、ARTEMISMQ、
RABBITMQ、IBMMQ且开启SSL认证时需要配 置
● 数据源类为HL7且HL7为目标端（position为 target）时，并且开启SSL认证时需要配置 最小长度：0
最大长度：256 trust_store String 公钥库文件。
● 数据源类型为ACTIVEMQ、ARTEMISMQ、
RABBITMQ、IBMMQ且开启SSL认证时需要配
● 数据源类型为HL7且为目标端（position为 target），并且开启SSL认证时需要配置 最小长度：0
最大长度：1024 trust_store_fil
e_type String 公钥库文件类型。
● 数据源类型为ACTIVEMQ、ARTEMISMQ、
RABBITMQ、IBMMQ且开启SSL认证时需要配 置
● 数据源类型为HL7且为目标端（position为 target），并且开启SSL认证时需要配置 最小长度：0
最大长度：10 ssl_auth_meth
od String ssl鉴权方式。 数据源类型为ACTIVEMQ、
ARTEMISMQ且开启SSL认证时需要配置
● one-way (单向认证)
● two-way (双向认证) 最小长度：0
最大长度：10
参数 参数类型 描述
key_store String 私钥库文件内容，
● 数据源类型为ACTIVEMQ、ARTEMISMQ，开 启SSL认证并且认证方式是two-way时需要配 置
● 数据源类型HL7且为源端（position为 source），并且开启SSL认证时需要配置 最小长度：0
最大长度：1024 key_store_file
_type String 私钥库文件类型
● 数据源类型为ACTIVEMQ、ARTEMISMQ，开 启SSL认证并且认证方式是two-way时需要配 置
最小长度：0 最大长度：10 key_store_pas
sword String 私钥库密码
● 数据源类型为ACTIVEMQ、ARTEMISMQ，开 启SSL认证并且认证方式是two-way时需要配 置
● 数据源为HL7类型，为源端（position为 source）并且开启SSL认证时需要配置 最小长度：0
最大长度：256 key_store_key
_password String 私钥库私钥密码
● 数据源类型为ACTIVEMQ、ARTEMISMQ，开 启SSL认证并且认证方式是two-way时需要配 置
● 数据源为HL7类型，为源端（position为 source）并且开启SSL认证时需要配置 最小长度：0
最大长度：256 dis_tunnel_na
me String DIS通道名称
最小长度：0 最大长度：256 dis_data_type String DIS数据类别
● JSON 最小长度：0 最大长度：256
参数 参数类型 描述 dis_setting_ty
pe String DIS配置类别
● senior (高级)
● basic (基础) 最小长度：0 最大长度：256
dis_endpoint String DIS Endpoint，当setting_type为senior时填写 最小长度：0
最大长度：256
dis_region String DIS Region，当setting_type为senior时填写 最小长度：0
最大长度：256 dis_source_pr
oject_id String DIS源端项目id，当setting_type为senior时填写 最小长度：0
最大长度：256 hl7_position String HL7数据源方向
● source (源端)
● target (目标端) 最小长度：0 最大长度：256 hl7_whitelist_
enable Boolean HL7是否开启白名单设置 最小长度：0
最大长度：256 hl7_whitelist String HL7白名单
● 允许同步数据到源端HL7的服务器地址，当
auth_type String LDAP安全认证类型 最小长度：0 最大长度：256 rabbitmq_virt
ual_host String RABBITMQ虚拟主机 最小长度：0
最大长度：256
参数 参数类型 描述 rabbitmq_ssl_
protocol String RABBITMQ SSL认证协议
● TLS 最小长度：0 最大长度：10 sap_client String SAP客户端号
最小长度：0 最大长度：10 sap_sysnr String SAP实例编号
最小长度：0 最大长度：256 snmp_networ
k_protocol String SNMP网络协议
● udp
● tcp 最小长度：0 最大长度：10 snmp_version Integer SNMP版本号
最小值：0 最大值：3 snmp_commu
nity String SNMP团体名，用于访问SNMP管理代理的身份认 证，相当于访问密码
最小长度：0 最大长度：256 ibmmq_ccs_id String IBMMQ字符集标识
最小长度：0 最大长度：65535 ibmmq_queue
_manager String IBMMQ队列管理器 最小长度：0 最大长度：256 ibmmq_chann
el String IBMMQ通道名称
最小长度：0 最大长度：256 ibmmq_cipher
_suite String IBMMQ密钥算法套件 最小长度：0
最大长度：256
参数 参数类型 描述 hdfs_path String HDFS URL
● 数据源为MRSHIVE、MRSHDFS、FIHDFS、
FIHIVE类型时配置
● fihadfs (/fdi/autotest) 最小长度：0
最大长度：256 principal_nam
e String 机机交互用户名
● 数据源为MRSHIVE、MRSHDFS、
MRSHBASE、MRSKAFKA、FIHDFS、
● 数据源为MRSHIVE、MRSHDFS、
MRSHBASE、MRSKAFKA、FIHDFS、
FIHIVE、FIKAFKA类型时配置。
最小长度：0
最小长度：0