网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

对接ROMA Connect调用服务的API

更新时间:2024-12-04 GMT+08:00
分享

应用与数据集成平台(ROMA Connect)是一个全栈式的服务平台,聚焦应用和数据连接,提供数据、API、消息和设备集成能力,帮助企业快速联接云上云下,消除数字鸿沟,实现数字化转型。在AstroZero中,通过连接器和ROMA Connect对接后,可调用ROMA Connect的API集成服务。

前提条件

AstroZero提供了默认对接的ROMA Connect服务器,也支持对接通过华为云开通的自有ROMA Connect实例。本章节以AstroZero对接自有ROMA Connect为例进行说明,默认对接的ROMA Connect服务器配置类似。

  • 已在ROMA Connect平台上完成应用创建(创建时,应用的“Key”字符长度必须小于60,否则后续向AstroZero同步时会失败)、函数API创建、API分组创建、API创建、调试、发布和授权操作。关于ROMA Connect的具体操作,请参见使用ROMA Connect集成服务配置API授权

    图1所示,已在ROMA Connect平台创建“人员管理”应用。如图2所示,已发布“获取人员信息”API,且该API已授权给“人员管理”应用。

    图1 集成应用
    图2 授权API
  • 已在ROMA Connect上,设置“app_secret”和“app_route”值为“on”。

    修改方法:在ROMA Connect实例控制台的“实例信息”页面,选择“配置参数”,修改“app_secret”和“app_route”的“参数运行值”为“on”。

  • 对接自有ROMA Connect实例时,请确保已参考设置应用中对接的ROMA Connect信息中操作,在AstroZero中设置ROMA Connect实例信息。

在AstroZero上调用ROMA Connect的API

在ROMA Connect上创建的应用和发布的API,可以直接同步到AstroZero。通过AstroZero的ROMA Connect类型连接器,可在服务编排或事件中调用ROMA Connect的API。

  1. 查看ROMA Connect侧创建的应用Key值是否带有前缀,如果带有前缀,则需要在AstroZero新建系统参数。

    1. 在ROMA Connect实例控制台左侧的导航栏中,选择“集成应用”。单击应用名,即图1中应用名“人员管理”,进入概览页面查看Key值。
      • 如果Key值带有前缀,例如为“test__com.appcube.user”,带有前缀“test__”,则需要执行1.b
      • 如果Key值不带前缀,例如为“com.appcube.user”,则执行2
    2. 新建系统参数。
      1. 登录AstroZero服务控制台。
      2. 在主页中,单击“进入首页”,进入应用开发页面。
      3. 单击页面左上角的,选择环境管理 > 环境配置,进入环境配置页面。
      4. 在左侧导航栏中,选择“系统设置 > 系统参数”。
      5. 单击“新建”,创建系统参数“roma_app_prefix”,配置参数值为此前缀取值“test__”,AstroZero在后续同步API和调用API时会主动拼上此前缀。
        图3 创建系统参数

  2. 在连接器中同步ROMA Connect应用和API,并查看具体API。

    1. 参考登录AstroZero新版应用设计器中操作,进入应用设计器。
    2. 在左侧导航栏中,选择“集成”
    3. 单击“连接器”中的“ 连接器实例”,进入连接器实例页面。
    4. 在左侧导航栏中,选择“HTTP > ROMA连接器”。
    5. 单击“同步应用”,将ROMA Connect上注册的应用直接同步到平台。
      图4 单击“同步应用”

      同步后,可在ROMA Connect连接器列表中,查看到“人员管理”应用。

      图5 查看人员管理应用
      说明:

      ROMA Connect连接器中的应用,可以由ROMA Connect同步而来,也可以通过安装包导入。通过安装包导入的ROMA Connect连接器中的应用,在ROMA Connect平台并不存在。需要将ROMA Connect资产导入到ROMA Connect平台,用户才可正常使用ROMA Connect连接器。

    6. 单击对应的连接器名称,在右侧“API接口”页签单击“同步API”,将ROMA Connect上发布并授权的API直接同步到AstroZero。

      同步后,在“API接口”页签中,可查看到“获取人员信息”API。

      图6 获取人员信息API
    7. 单击API名称,可查看API具体信息,包括基本信息、消息头入参、输入和输出参数。
      说明:

      如果ROMA Connect上该API有更新,请在ROMA Connect平台重新发布并授权API,然后在AstroZero重新同步应用和API。

      图7 查看API具体信息

      API参数说明,如表1所示。

      表1 API参数说明

      参数类别

      参数名称

      说明

      消息头入参

      X-HW-APPKEY

      X-HW-APPKEY:ROMA应用的请求密钥,用于私钥认证。

      1. 登录ROMA Connect实例控制台。
      2. 在左侧导航栏中,选择“集成应用”。
      3. 单击应用名,即图1中应用名“人员管理”,进入概览页面。
      4. 单击Secret右侧的,即可查看Secret信息。

      X-HW-ID

      ROMA应用的Key值。

      1. 登录ROMA Connect实例控制台。
      2. 在左侧导航栏中,选择“集成应用”。
      3. 单击应用名,即图1中应用名“人员管理”,进入概览页面。
      4. 在概览页,查看Key值。

      Accept

      接收类型,默认值“application/json”。

      输入参数

      userID

      用户ID,为自定义输入参数。

      输出参数

      retCode

      结果码。

      retJSON

      接收JSON格式化的ROMA Connect返回数据。

      $out

      接收非格式化的ROMA Connect返回数据。

      须知:

      对于POST请求类型,输入参数会有“$body”,通过此入参传递body结构体。可使用出参“$out”接收非格式化的ROMA Connect返回数据,$out为结构体类型。

      如果业务需要在API中,增加其他消息头入参或输入参数,需要在ROMA Connect的API管理侧重新编辑API,定义好入参,重新发布并授权API,然后在AstroZero重新同步该API。

      图8 ROMA Connect的API管理侧编辑API
      图9 添加入参

在服务编排中调用ROMA Connect的API

  1. 参考创建空白AstroZero服务编排中操作,创建一个服务编排。
  2. 在服务编排设计页面左侧,选择“连接器 > ROMA”,拖拽“人员管理”(连接器名称为ROMA应用名称)图元至画布中。

    图10 拖拽连接器图元到画布中

  3. 参考表1,设置变量和服务编排的输入输出参数。

    1. 选中开始图元,在服务编排设计页面右侧,选择
    2. 在私有结构体页面,单击“新增”。
      创建输出参数结构体类型变量前,首先需要创建私有结构体类型。
      图11 添加私有结构体类型
    3. 新增一个空的私有结构体“retJson”,不用设置结构体成员。
      图12 新建私有结构体
    4. 在服务编排设计页面右侧,选择
    5. 在全局上下文页面,单击“对象变量”后的加号。
      图13 添加对象变量
    6. 选择“私有结构体”,设置页面参数,名称为“retJson”,结构体选择已创建的私有结构体“retJson”。
      图14 配置私有结构体变量

    7. 参照上述操作,新增“out”私有结构体变量,结构体选择创建的私有结构体“out”。
      图15 对象out对象变量
    8. 在服务编排设计页面右侧,选择
    9. 在全局上下文页面,单击“变量”后的加号,新增图17中两个变量。
      图16 创建变量
      图17 添加两个变量
    10. 单击工作区域开始图元或空白区域,在服务编排设计页面右侧,选择,设置该服务编排的入参和出参。
      图18 设置服务编排的入参和出参
    11. 参考设置AstroZero系统参数中操作,新建系统参数“appkey”,值填写为ROMA应用的请求密钥。

      由于“X-HW-APPKEY”为ROMA应用的请求密钥,可能发生变化,您可以新建系统参数,加密存储此入参,并通过公式引用。当请求密钥变化时,修改系统参数即可。

      图19 新建系统参数appkey
    12. 在服务编排设计页面右侧,选择
    13. 在全局上下文页面,单击“公式”后的加号,新建公式变量“appkey”,表达式为“SYSPARAMETER("appkey")”。
      图20 新建公式变量

  4. 在“连接器”页面进行配置,“动作”选择具体调用的API,例如“获取人员信息”,根据表1配置入参和出参,并连接图元。

    图21 设置动作连接图元
    • 动作:具体调用的API,API选项由2.f同步而来。
    • 输入参数:调用API的输入参数。
    • 输出参数:调用API的输出参数。

  5. 单击服务编排页面上方的,保存服务编排。
  6. 保存成功后,单击编辑器页面上方的,执行服务编排。
  7. 设置如下输入参数,单击“运行”

    输入参数样例如下:

    {
        "userid": "001"
    }

    若显示如下信息,表示成功调用ROMA Connect的API。

    {
      "interviewId": "002N000000cOeh5XCDrc",
      "outputs": {
        "out": {
          "retCode": "0",
          "retJSON": {
            "result": {
              "employ_name": "zhangsan",
              "employ_no": "00xxxxxx"
            }
          }
        },
        "retCode": "0",
        "retJson": {
          "result": {
            "employ_name": "zhangsan",
            "employ_no": "00xxxxxx"
          }
        }
      }
    }

在脚本中调用ROMA Connect的API

  1. 参考创建空白AstroZero脚本中操作,创建一个脚本。
  2. 在脚本编辑器中,输入如下代码。

    // Here's your code.
    import * as roma from "roma";
    import * as sys from "sys";
    // 通过ROMA应用名创建client,第二个参数可以不填写, roma.newClient("人员管理");
    let client1 = roma.newClient("人员管理", roma.NameType.AppName)
    
    // 通过ROMA应用的APPID创建client
    let client2 = roma.newClient("com.appcube.user", roma.NameType.AppId)
    
    //通过API名称调用,第一个参数是API名称,入参在第二个参数中传入,$body可以传入body参数
    let resp1 = client1.sendRest("获取人员信息", {
        "X-HW-APPKEY": sys.getParameter("appkey"),
        "X-HW-ID": "com.appcube.user",
        userID: "1110000",
        $body: {}
    });
    console.log(resp1.$out)
    
    //通过API的URL调用,第一个参数是请求方法,第二个参数为接口URL,入参在第三个参数中传入,$body可以传入body参数
    let resp2 = client1.sendRestByURL("GET", "/getUserInfo", {
        "X-HW-APPKEY": sys.getParameter("appkey"),
        "X-HW-ID": "com.appcube.user",
        userID: "1110000",
        $body: {}
    });
    console.log(resp2.$out)

  3. 单击脚本编辑器页面上方的,保存脚本。
  4. 保存成功后,单击编辑器页面上方的,执行脚本。
  5. 脚本中已设置输入参数,请直接单击测试窗口右上角的,执行脚本。

    日志页签显示如下信息,表示成功调用ROMA Connect的API。
    0813 16:33:31.504|debug|vm[2]>>> app cube 1.2.12 8fce52d0 2020-07-17 10:14:41 +0800 debug
    0813 16:33:31.504|debug|vm[2]>>> node: 1
    0813 16:33:31.504|debug|vm[2]>>> script: test10__roma 1.0.1 
    0813 16:33:31.504|debug|vm[2]>>> locale: zh_CN
    0813 16:33:31.504|debug|vm[2]>>> timezone: Local
    0813 16:33:31.723|debug|vm[2]>>> { retCode: '0', retJSON: { result: { employ_name: 'zhangsan', employ_no: '00xxxxxx' } } } (test10__roma.ts:17)
    0813 16:33:31.773|debug|vm[2]>>> { retCode: '0', retJSON: { result: { employ_name: 'zhangsan', employ_no: '00xxxxxx' } } } (test10__roma.ts:26)

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容