错误码
5 数据集成 API
5.1 数据源管理
5.1.1 创建数据源
功能介绍
创建数据源
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/{project_id}/fdi/instances/{instance_id}/datasources
表5-1 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方式请参见API参 考的“附录 > 获取项目ID”章 节。
最小长度：1 最大长度：64
参数 是否必选 参数类型 描述 instance_id 是 String 实例ID
最小长度：1 最大长度：64
请求参数
表5-2 请求 Body 参数
参数 是否必选 参数类型 描述
datasource_n
ame 否 String 数据源名称，数据源名称不能包
含&、<、>、"、'、(、) ，长度 为1~255字符
最小长度：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 最小长度：4
参数 是否必选 参数类型 描述
最大长度：32
app_id 否 String 数据源所属应用ID
最小长度：4 最大长度：255 custom_plugi
n_id 否 String 数据源所属连接器Id，自定义数
据源必填 最小长度：4 最大长度：64 content 否 Content
object 数据源详细信息 description 否 String 数据源描述
最小长度：4 最大长度：1024
表5-3 Content
参数 是否必选 参数类型 描述
gauss100_vers
ion 否 String gauss100的版本号
● V100R003C20
● V300R001C00 最小长度：1 最大长度：64
参数 是否必选 参数类型 描述
host 否 String 主机IP地址
● 数据源为DWS、HANA、
RABBITMQ、SAP、SNMP、
port 否 String 端口，端口号为0到65535
● 数据源为DWS、HANA、
RABBITMQ、SAP、SNMP、
参数 是否必选 参数类型 描述 database_na
me 否 String 数据库名称
● 数据源为DWS、HANA、
RABBITMQ、SAP、SNMP、
● 数据源为ORACLE类型且 mode为（default、
multiAddress）时需要配置 最小长度：4
最大长度：2147483647 redis_databas
e 否 String REDIS数据源类型配置，数据库
编号, 纯数字编码 最小长度：1 最大长度：1000 user_name 否 String 访问服务的用户名
● 数据源为MYSQL、DWS、
FTP、ORACLE、
● 数据源为WEBSOCKET类 型，认证方式（basicauth）
参数 是否必选 参数类型 描述
password 否 String 访问服务的密码
● 数据源为MYSQL、DWS、
FTP、ORACLE、
● 数据源为WEBSOCKET，且 认证方式（basicauth）时需
default (默认模式)、
professional (专业模式)、
multiAddress (多地址)
● 数据源为DWS、
● 数据源为ORACLE时配置专有 的模式multiAddress。
最小长度：4 最大长度：255
cdc_mode 否 String cdc模式，只有组合任务使用 最小长度：4
最大长度：10 multi_oracle_
address 否 Array of MultiOracleA
参数 是否必选 参数类型 描述 oracle_service
_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类型时需要配 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、 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、 key_store 否 String 私钥库文件内容，
● 数据源类型为ACTIVEMQ、
ARTEMISMQ，开启SSL认证
● 数据源类型为ACTIVEMQ、
ARTEMISMQ，开启SSL认证 并且认证方式是two-way时 需要配置
最小长度：0 最大长度：10
参数 是否必选 参数类型 描述 key_store_pas
sword 否 String 私钥库密码
● 数据源类型为ACTIVEMQ、
ARTEMISMQ，开启SSL认证
_password 否 String 私钥库私钥密码
● 数据源类型为ACTIVEMQ、
ARTEMISMQ，开启SSL认证 dis_data_type 否 String DIS数据类别
● JSON
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、
● 数据源为MRSHIVE、
MRSHDFS、MRSHBASE、
● 数据源为MRSHIVE、
MRSHDFS、MRSHBASE、
stance_id 否 String 连接器实例ID，连接器发布后对 应的实例ID。
表5-4 MultiOracleAddress
参数 是否必选 参数类型 描述
oracle_addres
s 否 String ORACLE地址
最小长度：1 最大长度：30 oracle_port 否 String ORACLE端口
最小长度：1 最大长度：10
表5-5 ApiAuthDetail
参数 是否必选 参数类型 描述
auth_method 否 String 访问API服务的认证方式。
● none
● basicauth
● oauth2.0
● hmac
● secret
● md5
● apiGateway
● keyTop
● hikVision
● huaweiNetworkManageme nt
● liHe 最小长度：0 最大长度：256 app_auth_typ
e 否 String 访问API服务的APP认证方式，
认证方式为（apiGateway）时 填写。
● default
● secret
● jwt 最小长度：0 最大长度：2000
参数 是否必选 参数类型 描述
user_name 否 String 访问API服务的用户名。
● 认证方式为（lihe、
huaweiNetworkManageme nt、basicauth）时填写。
最小长度：4 最大长度：2000 password 否 String 访问API服务的密码。
● 认证方式为（lihe、
huaweiNetworkManageme nt、basicauth、secret、
md5、hmac）时填写。
最小长度：4 最大长度：2000
app_key 否 String 访问API服务的AppKey。
● 认证方式为（apiGateway）
时填写。
最小长度：0 最大长度：256
app_secret 否 String 访问API服务的AppSecret。
● 认证方式为（apiGateway）
时填写。
最小长度：0 最大长度：256
secret 否 String 访问API服务的Secret。
● 认证方式为（KeyTop、
HikVision、Secret、
HMAC、MD5）时填写。
最小长度：0 最大长度：256 alt_ip 否 String 访问API服务的备用IP
● 认证方式为
（HuaweiNetworkManage ment）时填写
最小长度：0 最大长度：256
参数 是否必选 参数类型 描述 access_token_
url 否 String 访问API服务的AccessTokenUrl
● 认证方式为（liHe、
oauth2.0
huaweiNetworkManageme nt）时填写
最小长度：0 最大长度：256
client_id 否 String 访问API服务的客户端标识
● 认证方式为Oauth2时填写 最小长度：0
最大长度：256
client_secret 否 String 访问API服务的客户端密钥
● 认证方式为Oauth2时填写 最小长度：0
最大长度：256 scope 否 String 访问API服务的Scope
● 认证方式为（LiHe、
Oauth2）时填写 最小长度：0 最大长度：256
authorization 否 String 访问API服务的Authorization
● 认证方式为（LiHe）时填写 最小长度：0
最大长度：256
grant_type 否 String 访问API服务的授权类型
● 认证方式为（LiHe、
Oauth2）时填写
● client_credentials
（oauth2.0使用）
最小长度：0 最大长度：256
响应参数
状态码： 201
表5-6 响应 Body 参数
参数 参数类型 描述
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-7 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类型且
ARTEMISMQ、POSTGRESQL、HIVE类型且