查询数据源 - ListDatasources_数据源管理_数据集成API_API参考_应用与数据集成平台 ROMA Connect-华为云

功能介绍

查询数据源。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目的ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。
instance_id	是	String	实例ID。

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	分页查询，每页显示的条目数量，最大数量999，超过999后只返回999。
offset	否	Integer	分页查询，分页的偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0。
datasource_type	否	String	数据源类型。 DB2：DB2数据源 GAUSS100：Gauss100数据源 OPENGAUSS：GaussDB数据源 MYSQL：MySQL数据源 ORACLE：Oracle数据源 POSTGRESQL：PostgreSQL数据源 SQLSERVER：SQL Server数据源 TAURUS：GAUSSDB(FOR MYSQL)数据源 DIS：DIS数据源 DWS：DWS数据源 HIVE：HIVE数据源 MRSHBASE：MRS HBASE数据源 MRSHDFS：MRS HDFS数据源 MRSHIVE：MRS HIVE数据源 MRSKAFKA：MRS KAFKA数据源 MRSREDIS：MRS REDIS数据源 MRSCLICKHOUSE：MRS CLICKHOUSE数据源 FTP：FTP数据源 OBS：OBS数据源 ACTIVEMQ：ActiveMQ数据源 ARTEMISMQ：ArtemisMQ数据源 IBMMQ：IBM MQ数据源 KAFKA：Kafka数据源 MQS：MQS数据源 RABBITMQ：RabbitMQ数据源 HANA：HANA数据源 MONGODB：MongoDB数据源 REDIS：Redis数据源 API：API数据源 WEBSOCKET：WebSocket数据源 LDAP：LDAP数据源 SAP：SAP数据源 SNMP：SNMP数据源 AOMDP：AOMDP数据源 ROCKETMQ：RocketMQ数据源 DM：DM数据源 CLICKHOUSE：Clickhouse数据源 HL7：HL7数据源(site形态不支持) ROMA20MQS：ROMA20.0 MQS数据源 IMF：IMF数据源(仅支持HCS形态)
sort_field	否	String	排序字段（CREATED_DATE）。
sort_type	否	String	查询数据源排序的类型，增序还是降序，可为空。
name	否	String	数据源名称，支持模糊匹配。
app_id	否	String	集成应用ID。
custom_plugin_id	否	String	连接器ID。
customized	否	String	是否是自定义数据源。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
total	Long	返回所有满足条件的对象个数。
size	Integer	返回对象的大小。
entities	Array of DataSourceRsp objects	返回的实体对象。

表5 DataSourceRsp
参数	参数类型	描述
datasource_id	String	数据源ID。
datasource_name	String	数据源名称。
datasource_type	String	数据源类型。 DB2：DB2数据源 GAUSS100：Gauss100数据源 OPENGAUSS：GaussDB数据源 MYSQL：MySQL数据源 ORACLE：Oracle数据源 POSTGRESQL：PostgreSQL数据源 SQLSERVER：SQL Server数据源 TAURUS：GAUSSDB(FOR MYSQL)数据源 DIS：DIS数据源 DWS：DWS数据源 HIVE：HIVE数据源 MRSHBASE：MRS HBASE数据源 MRSHDFS：MRS HDFS数据源 MRSHIVE：MRS HIVE数据源 MRSKAFKA：MRS KAFKA数据源 MRSREDIS：MRS REDIS数据源 MRSCLICKHOUSE：MRS CLICKHOUSE数据源 FTP：FTP数据源 OBS：OBS数据源 ACTIVEMQ：ActiveMQ数据源 ARTEMISMQ：ArtemisMQ数据源 IBMMQ：IBM MQ数据源 KAFKA：Kafka数据源 MQS：MQS数据源 RABBITMQ：RabbitMQ数据源 HANA：HANA数据源 MONGODB：MongoDB数据源 REDIS：Redis数据源 API：API数据源 WEBSOCKET：WebSocket数据源 LDAP：LDAP数据源 SAP：SAP数据源 SNMP：SNMP数据源 AOMDP：AOMDP数据源 ROCKETMQ：RocketMQ数据源 DM：DM数据源 CLICKHOUSE：Clickhouse数据源 HL7：HL7数据源(site形态不支持) ROMA20MQS：ROMA20.0 MQS数据源 IMF：IMF数据源(仅支持HCS形态)
vpc_id	String	数据源所属虚拟私有云VPC ID。
app_id	String	数据源所属应用ID。
app_name	String	数据源所属应用名称。
instance_id	String	数据源所属实例ID。
create_time	Long	数据源创建时间。
update_time	Long	数据源修改时间。
custom_plugin_id	String	数据源所属连接器ID。
content	Content object	数据源详细信息。
description	String	数据源描述。
app_permission	Array of strings	集成应用权限信息。 read (读权限) access (调用权限) delete (删除权限) modify (修改权限)

表6 Content
参数	参数类型	描述
gauss100_version	String	gauss100的版本号。数据源类型为gauss100的时候必填 V100R003C20 V300R001C00
host	String	主机IP地址。数据源为DWS、HANA、RABBITMQ、SAP、SNMP、IBMMQ类型时需要配置。数据源为MYSQL、ORACLE、SQLSERVER、DB2、GAUSS100、GaussDB(for 数据源为IMF类型且mq_type为RabbitMQ时需要配置。初始值为空，配置任务启动后生成host。 MySQL)、ARTEMISMQ、POSTGRESQL、 GaussDB、HIVE类型且mode为default时需要配置。
port	String	端口，端口号为0到65535。数据源为DWS、HANA、RABBITMQ、SAP、SNMP、IBMMQ，obs类型时需要配置。数据源为MYSQL、ORACLE、SQLSERVER、DB2、GAUSS100、GaussDB(for 数据源为IMF类型且mq_type为RabbitMQ时需要配置。 MySQL)、ARTEMISMQ、POSTGRESQL、 GaussDB、HIVE类型且mode为default时需要配置。
database_name	String	数据库名称。数据源为DWS、HANA、RABBITMQ、SAP、SNMP、IBMMQ，obs类型时需要配置。数据源为MYSQL、SQLSERVER、DB2、GAUSS100、GaussDB(for 数据源为ORACLE类型且mode为（default、multiAddress）时需要配置。 MySQL)、ARTEMISMQ、POSTGRESQL、 GaussDB、HIVE类型且mode为default时需要配置。
redis_database	String	REDIS数据源类型配置，数据库编号，纯数字编码。
user_name	String	访问服务的用户名。数据源为MYSQL、DWS、FTP、ORACLE、MONGODB、HANA、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ACTIVEMQ、ARTEMISMQ、POSTGRESQL、 GaussDB、RABBITMQ、SAP、IBMMQ、HIVE、IMF、RocketMQ类型时需要配置。数据源为WEBSOCKET类型，认证方式（basicauth）时需要配置。数据源为LDAP，安全认证类型（security_auth_type）为simple时需要配置。
password	String	访问服务的密码。数据源为MYSQL、DWS、FTP、ORACLE、MONGODB、HANA、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ACTIVEMQ、ARTEMISMQ、POSTGRESQL、 GaussDB、RABBITMQ、SAP、IBMMQ、HIVE、IMF、RocketMQ类型时需要配置。数据源为WEBSOCKET，且认证方式（basicauth）时需要配置。数据源为LDAP，且安全认证类型（security_auth_type）为simple时需要配置。
mode	String	数据源连接模式，有三种：default (默认模式)、professional (专业模式)、multiAddress (多地址)。数据源为DWS、MONGODB、REDIS、HANA时配置default。数据源为MYSQL、SQLSERVER、DB2、GAUSS100、GaussDB(for 数据源为ORACLE时配置专有的模式multiAddress。 MySQL)、POSTGRESQL、 GaussDB、HIVE时配置default或professional。
cdc_mode	String	cdc模式，只有组合任务使用。
multi_oracle_address	Array of MultiOracleAddress objects	ORACLE集群地址，当“mode”为“multiAddress”时需要配置。
oracle_service_name	String	ORACLE集群服务名。
ftp_connect_mode	String	访问FTP服务的连接模式。 active (主动模式) passive (被动模式)
ftp_protocol	String	访问FTP服务协议类型。 sftp ftp
auth_type	String	访问SFTP服务认证类型。 password privateKey
private_key	String	访问SFTP服务私钥。将私钥文件base64之后的字符串
private_key_password	String	访问SFTP服务私钥密码。当使用无密码私钥时可不填
address	String	地址。 OBS (obs远端地址，obs数据源使用)。 MONGODB (MONGODB数据源类型主机IP地址，多个IP:PORT，使用","隔开)。 REDIS (redis服务地址，多个IP:PORT，使用","隔开)。
ak	String	Access Key ID。数据源为OBS，DIS类型时需要配置。
sk	String	Secret Access Key。数据源为OBS，DIS类型时需要配置。
bucket_name	String	桶名称，数据源为OBS时需要配置。
https	Boolean	是否使用https, 数据源为OBS时需要配置，一般默认使用。
url	String	连接字符串，访问url。数据源为API、LDAP、WEBSOCKE类型时需要配置。数据源为MYSQL、ORACLE、DB2、GAUSS100、GaussDB(for MySQL)、POSTGRESQL、 GaussDB，且mode配置为professional专业时需要配置。
api_method	String	访问API请求方式。 POST PUT DELETE PATCH GET
auth_method	String	访问WEBSOCKET服务的认证方式。 none basicauth
api_auth_detail	ApiAuthDetail object	API鉴权详细字段。
broker	String	KAFKA、MQS、ACTIVEMQ的服务器地址，多个IP:PORT，使用","分隔。
ssl	Boolean	是否开启SSL认证。连接MQS内网地址时，若MQS开启了SSL，请选择“是”。
ssl_enable	Boolean	是否开启SSL认证。数据源为KAFKA时需要配置。数据源为ARTEMISMQ、ACTIVEMQ、RABBITMQ、IBMMQ时需要配置。
ssl_username	String	SSL用户名/应用Key。数据源为KAFKA或者MQS时，且开启SSL认证时需要配置。
ssl_password	String	SSL密码/应用Secret。数据源为KAFKA或者MQS时，且开启SSL认证时需要配置。
acl_enable	Boolean	是否开启ACL认证。数据源为RocketMQ时需要配置。
mq_type	String	IMF数据源消息队列类型。 RocketMQ RabbitMQ
mongodb_auth_source	String	MONGODB认证源。
mongodb_cluster_enable	Boolean	MONGODB集群模式。 true (集群模式) false （非集群模式）
mongodb_replica_set	String	MONGODB副本集。当MONGODB为非集群模式时配置。
encoding	String	编码格式。数据源为GAUSS100、POSTGRESQL类型时配置“big5”。数据源为MYSQL、GaussDB(for MySQL)类型且mode为default时配置。
mysql_timeout	Integer	MYSQL连接超时时间（秒）。
trust_store_password	String	公钥库密码。数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置。
trust_store	String	公钥库文件。数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置。
trust_store_file_type	String	公钥库文件类型。数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置。
ssl_auth_method	String	SSL鉴权方式。数据源类型为ACTIVEMQ、ARTEMISMQ且开启SSL认证时需要配置。 one-way (单向认证) two-way (双向认证)
key_store	String	私钥库文件内容。数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置。
key_store_file_type	String	私钥库文件类型。数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置。
key_store_password	String	私钥库密码。数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置。
key_store_key_password	String	私钥库私钥密码。数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置。
dis_tunnel_name	String	DIS通道名称。
dis_data_type	String	DIS数据类别。包含：JSON。
dis_setting_type	String	DIS配置类别。 senior (高级) basic (基础)
dis_endpoint	String	DIS Endpoint，当setting_type为senior时填写。
dis_region	String	DIS Region，当setting_type为senior时填写。
dis_source_project_id	String	DIS源端项目ID，当setting_type为senior时填写。
hl7_position	String	HL7数据源方向。 source (源端) target (目标端)
hl7_whitelist_enable	Boolean	HL7是否开启白名单设置。
hl7_whitelist	String	HL7白名单。允许同步数据到源端HL7的服务器地址，当HL7为源端（position为source）并且开启白名单设置(open_whitelist为true)时填写。
ldap_security_auth_type	String	LDAP安全认证类型。
rabbitmq_virtual_host	String	RabbitMQ虚拟主机。
rabbitmq_ssl_protocol	String	RABBITMQ SSL认证协议。包含：TLS。
rocketmq_namesrv_addr	String	IMF数据源RocketMQ连接地址，mq_type为RocketMQ时填写，多个地址以‘,’分隔。
namesrv_addr	String	ROMA 20.0 MQS连接地址。
app_id	String	ROMA 20.0 MQS APP Key
app_secret	String	ROMA 20.0 APP Secret
sap_client	String	SAP客户端号。
sap_sysnr	String	SAP实例编号。
snmp_network_protocol	String	SNMP网络协议。 udp tcp
snmp_version	Integer	SNMP版本号。
snmp_community	String	SNMP团体名，用于访问SNMP管理代理的身份认证，相当于访问密码。
ibmmq_ccs_id	String	IBMMQ字符集标识。
ibmmq_queue_manager	String	IBMMQ队列管理器。
ibmmq_channel	String	IBMMQ通道名称。
ibmmq_cipher_suite	String	IBMMQ密钥算法套件。
hdfs_path	String	HDFS URL，数据源为MRSHIVE、MRSHDFS类型时配置。
principal_name	String	机机交互用户名，数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA、MRSREDIS类型时配置。
config_file_name	String	用户认证文件，文件获取方式参见API参考的“附录 > 获取数据源配置文件”章节。将获取到的文件打包成zip文件，文件名配置在config_file_name中，内容以BASE64编码形式放到config_file_content。数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA、MRSREDIS、MRSCLICKHOUSE类型时配置。
config_file_content	String	用户认证文件内容，config_file_name对应的文件内容BASE64编码。数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA、MRSREDIS、MRSCLICKHOUSE类型时配置。
connection_instance_id	String	连接器实例ID，连接器发布后对应的实例ID。
connector_params	Object	连接器对应的数据源参数，值按实际填写。

表7 MultiOracleAddress
参数	参数类型	描述
oracle_address	String	ORACLE地址。
oracle_port	String	ORACLE端口。

表8 ApiAuthDetail
参数	参数类型	描述
auth_method	String	访问API服务的认证方式。 none basicauth oauth2.0 hmac secret md5 apiGateway，对应控制台上的AppKey Auth认证 keyTop hikVision huaweiNetworkManagement liHe
app_auth_type	String	访问API服务的APP认证方式，认证方式为（apiGateway）时填写。 default secret jwt
user_name	String	访问API服务的用户名。认证方式为（liHe、huaweiNetworkManagement、basicauth）时填写。
password	String	访问API服务的密码。认证方式为（liHe、huaweiNetworkManagement、basicauth、secret、md5、hmac）时填写。
app_key	String	访问API服务的AppKey。认证方式为（apiGateway）时填写。
app_secret	String	访问API服务的AppSecret。认证方式为（apiGateway）时填写。
secret	String	访问API服务的Secret。认证方式为（keyTop、hikVision、secret、hamc、md5）时填写。
alt_ip	String	访问API服务的备用IP。认证方式为（huaweiNetworkManagement）时填写。
access_token_url	String	访问API服务的AccessTokenUrl。认证方式为（liHe、oauth2.0 huaweiNetworkManagement）时填写。
client_id	String	访问API服务的客户端标识。认证方式为oauth2.0时填写。
client_id_key	String	访问API服务的客户端传参标识key。认证方式为oauth2.0时填写，不填写默认为client_id。
client_secret	String	访问API服务的客户端密钥。认证方式为oauth2.0时填写。
client_secret_key	String	访问API服务的客户端密钥key。认证方式为oauth2.0时填写，不填写默认为client_secret。
scope	String	访问API服务的Scope。认证方式为（liHe、oauth2.0）时填写。
authorization	String	访问API服务的Authorization。认证方式为（liHe）时填写。
grant_type	String	访问API服务的授权类型。认证方式为（liHe、oauth2.0）时填写。 client_credentials （oauth2.0使用）。

状态码：400

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。

状态码：500

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。

请求示例

无

响应示例

状态码：200

OK

{
  "total" : "658,",
  "size" : "1,",
  "entities" : [ {
    "datasource_id" : "acd5502992254b3ab2dfd5b6900159db",
    "datasource_name" : "TY_KAFKA",
    "datasource_type" : "KAFKA",
    "content" : {
      "project_id" : "c53626012ba84727b938ca8bf03108ef",
      "type" : "KAFKA",
      "instance_id" : "05173009-2e5f-4773-8303-8e05cc9c9302",
      "broker" : "10.01.01.01:9092",
      "ssl_username" : "1",
      "ssl_password" : "******",
      "ssl_enable" : true
    },
    "create_time" : 1616784907101,
    "update_time" : 1619650507230,
    "app_id" : "141bbdf5-131e-4111-898d-5a6292a2113b",
    "app_name" : "app-zhe",
    "instance_id" : "05173009-2e5f-4773-8303-8e05cc9c9302",
    "remark" : "No change.",
    "app_permission" : [ "read", "access", "delete", "modify" ]
  } ]
}

状态码

状态码	描述
200	OK
400	Bad Request
500	Internal Server Error

错误码

请参见错误码。

查询数据源 - ListDatasources

功能介绍

授权信息

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

意见反馈

文档内容是否对您有帮助？