- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 开始使用ROMA Connect
- 实例管理
- 集成应用管理
-
数据源管理
- ROMA Connect支持的数据源
- 接入API数据源
- 接入ActiveMQ数据源
- 接入ArtemisMQ数据源
- 接入DB2数据源
- 接入DIS数据源
- 接入DWS数据源
- 接入DM数据源
- 接入Gauss100数据源
- 接入FTP数据源
- 接入HL7数据源
- 接入HANA数据源
- 接入HIVE数据源
- 接入LDAP数据源
- 接入IBM MQ数据源
- 接入Kafka数据源
- 接入MySQL数据源
- 接入MongoDB数据源
- 接入MQS数据源
- 接入MRS Hive数据源
- 接入MRS HDFS数据源
- 接入MRS HBase数据源
- 接入MRS Kafka数据源
- 接入OBS数据源
- 接入Oracle数据源
- 接入PostgreSQL数据源
- 接入Redis数据源
- 接入RabbitMQ数据源
- 接入RocketMQ数据源
- 接入SAP数据源
- 接入SNMP数据源
- 接入SQL Server数据源
- 接入GaussDB(for MySQL)数据源
- 接入WebSocket数据源
- 接入自定义数据源
- 数据集成指导
- 服务集成指导
- 服务集成指导(旧版界面)
- 消息集成指导
- 设备集成指导
- 应用业务模型使用指导
- 扩大资源配额
- 查看审计日志
- 查看监控指标
- 权限管理
- 用户指南(新版)
- 最佳实践
-
开发指南
- 数据集成开发指导
-
服务集成开发指导
- 开发说明
- API调用认证开发(APP认证)
- API调用认证开发(IAM认证)
-
自定义后端开发(函数后端)
- 函数后端脚本开发说明
- AesUtils类说明
- APIConnectResponse类说明
- Base64Utils类说明
- CacheUtils类说明
- CipherUtils类说明
- ConnectionConfig类说明
- DataSourceClient类说明
- DataSourceConfig类说明
- ExchangeConfig类说明
- HttpClient类说明
- HttpConfig类说明
- JedisConfig类说明
- JSON2XMLHelper类说明
- JSONHelper类说明
- JsonUtils类说明
- JWTUtils类说明
- KafkaConsumer类说明
- KafkaProducer类说明
- KafkaConfig类说明
- MD5Encoder类说明
- Md5Utils类说明
- QueueConfig类说明
- RabbitMqConfig类说明
- RabbitMqProducer类说明
- RedisClient类说明
- RomaWebConfig类说明
- RSAUtils类说明
- SapRfcClient类说明
- SapRfcConfig类说明
- SoapClient类说明
- SoapConfig类说明
- StringUtils类说明
- TextUtils类说明
- XmlUtils类说明
- 自定义后端开发(数据后端)
- 后端服务签名校验开发
- 消息集成开发指导
- 设备集成开发指导
-
API参考
- 使用前必读
- API概览
- 如何调用API
- 公共资源API
- 数据集成API
- 服务集成API
- 消息集成API
- 设备集成API
- 应用示例
- 权限和授权项
- 附录
- 历史API
- 修订记录
- SDK参考
-
常见问题
- 实例管理
-
数据集成
-
数据集成普通任务
- FDI各类数据库支持哪些数据类型?
- 跟踪号是什么,能跟踪到数据吗?
- FDI任务是否支持清空目标表?
- FDI任务只能采集单张表到单张表吗?
- 用户创建的FDI任务,同一账号的其他用户可见吗?
- FDI通过公网对接其他租户的MRS HIVE如何配置?
- 从OBS解析文件到RDS数据库,采集过一次后,后面采集会进行更新吗?
- OBS源端的CSV文件解析到关系型数据库时,列的值不对怎么办?
- MRS Hive目标字段和源端字段数据类型不匹配时,数据是否能集成到目标端?
- MRS Hive、MRS HBase和MongoDB的Mapping映射手动输入时,是否区分大小写?
- MRS Hive是否支持分区?
- 源端API类型数据源自定义周期如何设置?
- SAP是否支持分页读取视图?
- 数据集成组合任务
-
数据集成普通任务
- 服务集成
- 消息集成
- 设备集成
-
故障排除
-
数据集成任务
- MRS Hive目标端写入时出现数据乱码
- MRS Hive写入时数据全部写在第一个字段里
- 目标端任务报任务运行超时
- MySQL到MRS Hive时目标端报“could only be written to 0 of the 1 minReplication nodes. There are 2 datanode(s) running and 2 node(s) are excluded in this operation”错误
- Mysql到Mysql时源端报“Illegal mix of collations for operation 'UNION'”错误
- 源端Mysql增量采集每小时执行一次时部分数据丢失
- API到MySQL时源端报“401 unauthorized”错误
- Kafka集到Mysql目标端报“cannot find record mapping field”错误
- API到MySQL的定时任务时会出现源端报“connect timeout”错误
- Kafka到Mysql的实时任务时,MQS中的Topic下有数据,但是FDI任务没有采集到数据。
- Mysql到Mysql的定时任务,源端有类型为tinyint(1),值为2的字段,但是采集到目标端值就变成了1
- 目标端数据源为公网Kafka时,定时任务目标端报“The task executes failed.Writer data to kafka failed”错误
- 数据集成组合任务
- 数据源
- 服务集成
- 设备集成
-
数据集成任务
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
调用开放的API
概述
API在发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。
前提条件
在调用API前,确保您的业务系统所在网络与API的访问域名或地址互通。
获取API的调用信息
在调用API前,您需要向API提供方获取API的调用信息。
- 获取API的请求信息
在ROMA Connect实例控制台选择“服务集成 APIC > API管理”,在“API列表”页签中可获取API的“域名”、“请求方法”和“请求路径”。单击API的名称进入API详情页面,在“调用信息”页签下,获取API的“请求协议”、“入参定义”和“请求体内容描述”。
- 获取API的认证信息
根据API使用的安全认证方式不同,还要获取相关的请求认证信息:
认证方式
认证信息
APP认证(签名认证)
向API提供方获取该API所授权集成应用的Key和Secret(或客户端的AppKey和AppSecret),以及认证签名所使用的SDK。
APP认证(简易认证)
向API提供方获取该API所授权客户端的AppCode。
APP认证(绿色通道白名单)
向API提供方获取该API所授权集成应用的Key(或客户端的AppKey)。
APP认证(app_secret认证)
向API提供方获取该API所授权集成应用的Key和Secret(或客户端的AppKey和AppSecret)。
APP认证(app_basic认证)
向API提供方获取该API所授权集成应用的Key和Secret(或客户端的AppKey和AppSecret)。
APP认证(双重认证)
同时获取APP认证以及自定义认证所需的认证信息。
IAM认证(Token认证)
获取云服务平台的用户账号密码。
IAM认证(AK/SK认证)
获取云服务平台的用户账号的AK/SK,以及认证签名所使用的SDK。
IAM认证(双重认证)
同时获取IAM认证以及自定义认证所需的认证信息。
自定义认证
向API提供方获取请求参数中要携带的自定义认证信息。
无认证
无需认证信息。
- 获取集成应用的Key和Secret:
在ROMA Connect实例控制台选择“集成应用”,在集成应用列表中单击API所授权集成应用的名称,进入集成应用详情页面,在“基本信息”中获取集成应用的Key和Secret。
- 获取客户端的AppKey和AppSecret:
在ROMA Connect实例控制台选择“服务集成 APIC > API调用”,在“客户端配置”页签中单击API所绑定客户端的名称,进入客户端详情页面,获取客户端的AppKey和AppSecret。
- 获取认证签名所使用SDK:
在ROMA Connect实例控制台选择“服务集成 APIC > API调用”,在“SDK”页签中下载对应语言所使用SDK。
- 获取AppCode:
在ROMA Connect实例控制台选择“服务集成 APIC > API调用”,在“客户端配置”页签中单击API所绑定客户端的名称,进入客户端详情页面,在“AppCode”页签中获取AppCode。
- 获取集成应用的Key和Secret:
- 若您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。
- Site实例不支持使用子域名调用API,仅支持使用IP+Host头方式调用API。
调用API
- 构造API请求,示例如下:
POST https://{Address}/{Path}?{Query} {Header} { {Body} }
- POST:请求方法,需替换为获取API的请求信息中获取的请求方法。
- {Address}:请求地址,需替换为获取API的请求信息中获取的域名地址。您也可以使用IP地址访问API,
API调用场景
API请求参数配置
使用域名调用API
ROMA Connect允许使用分组分配的子域名或分组绑定的域名调用API,无需另外配置。
使用IP调用DEFAULT分组的API
ROMA Connect允许使用IP地址调用DEFAULT分组下的API,无需另外配置。
使用IP调用非DEFAULT分组的API
- ROMA Connect的实例配置参数“app_route”已设置为“on”,允许通过IP访问API。
- ROMA Connect不允许使用IP地址直接调用非DEFAULT分组下的API,需要在请求消息中添加Header参数“X-HW-ID”,参数值为API所授权集成应用的Key或客户端的AppKey。
- {Path}:请求路径,需替换为获取API的请求信息中获取的请求路径。
- {Query}:查询参数,可选,格式为“参数名=参数取值”,例如limit=10,多个查询参数之间使用“&”隔开。需根据获取API的请求信息中获取的请求参数进行设置。
- {Header}:请求头参数,格式为“参数名: 参数取值”,例如Content-Type: application/json。需根据获取API的请求信息中获取的请求参数进行设置。
- {Body}:请求消息体,JSON格式。需根据获取API的请求信息中获取的请求体内容描述进行设置。
- 为API请求添加认证信息。
API认证方式
API请求参数配置
APP认证(签名认证)
使用获取的SDK对API请求进行签名,具体请参考APP认证开发。
APP认证(简易认证)
在API请求中添加Header参数“X-Apig-AppCode”,参数值为获取API的认证信息中获取到的AppCode。
APP认证(绿色通道白名单)
在API请求中添加Header参数“X-HW-ID”,参数值为API所授权集成应用的Key或客户端的AppKey。
APP认证(app_secret认证)
- ROMA Connect的实例配置参数“app_secret”已设置为“on”,开启app_secret认证。
- 在API请求中添加Header参数“X-HW-ID”,参数值为API所授权集成应用的Key或客户端的AppKey。
- 在API请求中添加Header参数“X-HW-AppKey”,参数值为获取API的认证信息中获取到的Secret或AppSecret。
APP认证(app_basic认证)
- ROMA Connect的实例配置参数“app_basic”已设置为“on”,开启app_basic认证。
- 在API请求中添加Header参数“Authorization”,参数值为"Basic "+base64(appkey+":"+appsecret),其中appkey和appsecret分别为获取API的认证信息中获取到的Key和Secret(或AppKey和AppSecret)。
APP认证(双重认证)
在API请求中同时携带APP认证和自定义认证的认证信息。
IAM认证(Token认证)
先获取云服务平台的认证Token,然后在API请求中添加Header参数“X-Auth-Token”,参数值为认证Token,具体请参考IAM认证开发(Token)。
IAM认证(AK/SK认证)
使用获取的SDK对API请求进行签名,具体请参考IAM认证开发(AK/SK)。
IAM认证(双重认证)
在API请求中同时携带IAM认证和自定义认证的认证信息。
自定义认证
根据自定义认证的定义,在API请求参数中携带相关认证信息进行认证。
无认证
无需认证,可直接调用API。
须知:
Site实例中不支持华为IAM认证。