网络
虚拟私有云 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
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

非纯脚本服务定义

更新时间:2025-02-11 GMT+08:00
分享

操作场景

聚合服务编排提供可视化图形化的API编排能力。基于此能力,开发人员无需再从零开始编写复杂的代码,只需通过简单的拖拉拽和配置,就可轻松完成API的编排,极大的提高了API的开发效率和灵活性。

图1 创建非纯脚本服务流程图

前提条件

已获取开发人员及以上权限用户的账号和密码。

步骤1:定义基本信息

  1. 登录LinkX-F系统首页。
  2. 选择数据服务 > 聚合服务编排,进入“聚合服务编排”页面。
  3. 单击“创建”,弹出“创建聚合服务”界面。

    默认进入“服务定义”页的“基本信息”阶段。

  4. 根据界面提示,配置如下基本信息,如表1所示:

    图2 定义服务基本信息
    表1 服务定义基本信息

    参数

    说明

    基本信息

    API英文名称

    根据API提供的功能,自定义API的英文名称。

    必填,不能重复,可包含字母、数字和英文半角“_”不能包含特殊字符,字首只能是大写字母,长度不能超过128个字符。

    API中文名称

    根据API提供的功能,自定义API的中文名称。

    必填,不能重复,可包含中文、英文、数字和英文半角“-”“_”,长度不能超过 128 个字符。

    API英文描述

    输入API的英文描述,说明API的功能等信息。

    必填,可包含英文、数字、特殊字符和空格,长度不能超过 1024 个字符。

    API中文描述

    输入API的中文描述,说明API的功能等信息。

    必填,可包含中文、英文、数字、特殊字符和空格,长度不能超过 1024 个字符。

    API责任人

    必填,选择服务的责任人。

    维护人

    非必填,选择服务的维护人。

    关联领域

    必填,选择聚合服务的关联领域,下拉可选值来源于基础数据管理 > 领域的数据。

    数据源

    选择聚合服务实例数据所读取的实例数据库。

    必填,仅可选在基础数据管理 > 数据源中,数据源定义“是否用于聚合服务”值为“是”的图数据库和关系型数据库。

    此处选择图数据库类型。

    是否纯脚本服务

    根据已选数据源类型自动选择值,此处默认为“否”,暂不支持修改。

    脚本类型

    根据已选数据源类型自动选择脚本类型,此处默认“JavaScript”,暂不支持修改。

    初始数据实体

    图结构中的灵魂节点,一般是业务功能实现的核心节点,与多个节点存在关联关系。例如:Offering、Release。

    必填,搜索关键字后下拉选择,可选值仅显示实例数据已入图的数据实体。

    说明:

    仅非纯脚本服务才显示此参数。

    支持服务运行结果保存为数据集

    将API运行结果保存为数据集,后续可直接查表获取服务运行结果,无需再去调用API。

    必填,支持选择“是”“否”。如果选“是”,API发布成功后,您还需完成数据集配置

    服务权限信息

    服务密级

    API的密级。

    必填,默认值为“内部公开”,暂不支持修改。

    API调用方式

    API调用方式

    必填,下拉选择值。

    • 前台同步调用:需考核接口响应时间。
    • 非前台同步调用:不考核接口响应时间。

  5. 填写完后单击“保存并下一步”

    进入步骤2:添加与目标实体相关联的数据实体及关系阶段。

步骤2:添加与目标实体相关联的数据实体及关系

完成服务基本信息的填写后,非纯脚本服务通过编辑图结构,添加相关联的数据实体及关系,实现图形化编排数据模型的交互路径,系统会根据编排的图结构生成高效的查询脚本。

注意:

在编辑图结构阶段添加关联的数据实体及关系前,请确认目标服务已进入编辑状态。

以下步骤仅指导您如何在图结构中添加与目标实体相关联的数据实体及关系。如需了解更多编辑图结构的操作,详细请参考表2

  1. 选择服务定义 > 编辑图结构阶段,进入图结构编辑页面。
  2. 选中实体节点按鼠标右键,在调出的快捷菜单中单击“添加数据实体与关系”,弹出添加关联数据实体与关系窗口。

    该弹窗列举显示了所有与选中实体相关联的数据实体和关系。

  3. 在添加数据实体&关系页签,勾选关联的数据实体和关系。

    如需添加循环关系,请切换至“自循环关系”“多数据实体循环关系”页签,根据模型的关联属性设置过滤条件。

    自循环关系是指一个对象或系统与自身之间存在的循环依赖关系。

    说明:

    在图结构中添加关联的数据实体和关系时,最多不允许添加超过2个运行态数据实体(如)。

    图3 选择关联数据实体&关系。

  4. 单击“确定”保存。图谱中显示已添加实体节点及关系线。
  5. 单击“下一步”

    进入步骤3:新增入参阶段。

步骤3:新增入参

设置入参是指调用API时,设置需要传入的参数。系统提供默认入参参数,您还可根据需要通过自选入参和自定义入参方式新增入参参数。

表2 默认入参参数说明

参数

说明

pageSize

必填,每页条目数,即每页显示的数据条目数。

pageNumber

必填,分页页码,即返回指定页码的数据条目数。

returnTotalCountFlag

是否返回数据条目总数。

以下步骤仅指导您如何通过自选入参方式新增入参参数。如需了解更多设置入参的操作,详细请参考表3

注意:

设置入参前,请确认目标服务已进入编辑状态。

  1. 选择服务定义 > 设置入参阶段,进入设置入参页面。

    图4 设置入参

  2. 在左侧“设置入参”处选中数据实体,右侧展示该目标实体的属性列表,在列表中勾选入参属性。
  3. “入参汇总”处查看默认入参参数和已设置的入参参数,设置完入参后,单击“保存”
  4. 完成入参设置后,单击“下一步”

    进入步骤4:新增过滤条件阶段。

步骤4:新增过滤条件

设置过滤条件是为在调用API时,缩小查询结果范围,只检索符合过滤条件的数据。当API接收到请求时,可以根据已设置的过滤条件,如日期、关键字、ID或其他用户定义的标准等参数过滤数据。对于返回大型数据集的API ,设置有效过滤可以显著提高性能,并减少需要通过网络传输的数据量。

注意:

设置过滤条件前,请确认目标服务已进入编辑状态。

以下步骤仅指导您如何新增过滤条件。如需了解更多设置过滤条件的操作,详细请参考表4

  1. 选择服务定义 > 设置 > 过滤条件阶段,进入设置过滤条件页面。
  2. 在图结构中选中实体或展开右侧“数据实体列表”后选中实体,新增过滤条件。

    图5 设置过滤条件
    1. 单击“添加规则”,添加过滤条件。
    2. 添加过滤条件的属性。
    3. 添加过滤条件的匹配方式。
    4. 输入过滤条件。必填,不能以“\”开头结尾;“参数名称+逻辑符+参数值”不能重复,长度不超过128个字符。

      如需设置多个数据实体的过滤条件均为某个入参,单击,在“入参设置”弹窗中选择该属性要用作过滤条件的入参。

    5. 配置各过滤条件之间的关系:可选“与”“或”

  3. 设置完成过滤条件后,单击“保存”
  4. 单击“下一步”

    进入步骤5:新增出参阶段。

步骤5:新增出参

出参是指调用API后返回给调用方的数据, 设置出参是指设置需要传出的参数。您可根据需要通过自选出参和自定义出参方式新增出参参数。

注意:

设置出参前,请确认目标服务已进入编辑状态。

以下步骤仅指导您如何通过自选出参方式新增出参参数。如需了解更多设置出参的操作,详细请参考表5

  1. 选择服务定义 > 设置 > 出参阶段,进入设置出参页面。
  2. 在左侧“设置出参”处选中数据实体,右侧展示该目标实体的属性列表,在列表中勾选出参属性。

    说明:

    出参勾选非入图属性会生成一段脚本使用数据实体ID获取数据,ID如果自定义名称将失效。

    如果有选择运行态数据实体(如),且目标实体存在已发布的设备API映射(仅限批量接口),并勾选了设备API映射,后续进入服务开发阶段系统会自动生成图数据库查询和设备API调用脚本。

    说明:

    设置出参时,单个运行态数据实体只允许选择一个设备API映射。

    图6 选择运行态数据实体的设备API映射

  3. “出参汇总”处查看已设置的出参,并配置出参信息。

    表3 配置出参信息

    类型

    说明

    自定义出参名称

    自选出参方式新增的出参名称默认显示格式为{实体英文名称}_{属性名称},支持修改。

    是否自定义密级

    非纯脚本服务的“是否自定义密级”均为“否”,且不支持修改。

    数据实体/关系实体

    属性归属的实体英文名称。

    属性名称

    属性英文名称。

    出参密级

    属性对应的密级。

    描述

    自选出参方式新增的出参默认显示属性对应的中文描述,支持修改。

    数据类型

    属性对应的类型。

    聚合配置

    对出参进行聚合配置,实现对数据表中的数据进行分组。

    说明:

    未进行聚合配置的参数将默认为分组参数。

    根据出参属性的数据类型不同,聚合配置项的可选类型有所不同。各类型代表含义如下:

    • 平均值:表示数据分组后,计算并显示该属性列中所有值的平均值。
    • 最大值:表示数据分组后,查找并显示该属性列的所有值中的最大值。
    • 最小值:表示数据分组后,查找并显示该属性列的所有值中的最小值。
    • 标准差:表示数据分组后,计算并显示该属性列的所有值的标准差。
    • 总和:表示数据分组后,计算并显示该属性列的所有值的总和。
    • 计数:表示数据分组后,统计并显示该属性列的所有值的条目数。
    • 合并列表:表示数据分组后,列举显示该属性列的所有值(允许相同值出现)。

    排序优先级

    排序优先级总共1-10级,数字越小优先级越高,即1优先级最高,10最低,且不能重复

    说明:

    支持联合排序,最多可配置10个出参组合排序。

    排序类型

    可选升序或降序。

    • 升序:将数据按照对应属性列升序排序。
    • 降序:将数据按照对应属性列降序排序。

  4. 设置完出参后,单击“保存”

    继续参考步骤6:生成API

步骤6:生成API

生成API是指完成服务定义后,保存服务定义信息并生成目标服务。

  1. 选择服务定义 > 设置 > 出参阶段,进入设置出参页面。
  2. 生成API时需区分不同的操作场景,具体如下。

    • 如果是新增场景,请单击“生成API”
    • 如果是修改场景,请单击“部署”

后续操作

完成以上步骤后,您可进入服务开发阶段,快速调测服务。

提示

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

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容