华为云用户手册

  • 请求URI 请求URI由如下部分组成: {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点中获取。例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径,也即API访问路径。从具体API的URI模块获取,例如““获取用户Token””API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。 表2 HTTP请求方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens
  • 错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 处理措施 400 common.authenticate.fail 用户没有操作权限错误 切换用户或申请权限 400 common.param.checkError 参数格式错误编码 检查并修改入参格式 400 common.request.method.error 请求方式错误 选择其他请求方式 400 common.subService.handlerError 依赖服务异常错误 联系相关服务责任人 400 common.unknown.error 程序内部未知错误 联系相关服务责任人 父主题: 附录
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内,12M以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token,即调用获取用户Token接口时,请求body中“auth.scope”的取值需要选择“project”,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": "********", //IAM用户密码 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } } } 获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 GET https://iam.cn-north-4.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以: 通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333。 参考华为云IAM认证服务了解如何获取IAM用户token。
  • 监控安全风险 产品数字化协同平台云服务提供基于云运维管理的应用运维管理(Application Operations Management,简称AOM)资源和操作监控能力,实时监控应用及云资源,采集各项指标、日志及事件等数据分析应用健康状态,提供告警及数据可视化功能,帮助您及时发现故障,全面掌握应用、资源及业务的实时运行状况。 使用了企业主机安全(Host Security Service,简称HSS)对主机、容器进行系统完整性的保护、应用程序控制、行为监控和基于主机的入侵防御等,帮助构建服务器安全体系,降低当前服务器面临的主要安全风险。具体配置请参见HSS使用指导。 同时,通过配置Web应用防火墙(Web Application Firewall,简称WAF)保护Web服务安全稳定,对HTTP/HTTPS请求进行检测,识别并阻断SQL注入、跨站脚本攻击、网页木马上传、命令/代码注入、文件包含、敏感文件访问、第三方应用漏洞攻击、CC攻击、恶意爬虫扫描、跨站请求伪造等攻击,具体配置策略请参见WAF使用指导。 父主题: 安全
  • 身份认证与访问控制 身份认证 用户访问产品数字化协同平台云服务的身份认证采取OrgID认证机制,用户需要经过认证才可以访问产品数字化协同平台云服务的业务,用户通过用户名/密码的方式进行认证来获取OrgID用户的Token。Token是系统颁发给用户的访问令牌,承载用户的身份信息。调用产品数字化协同平台云服务的接口时,可以Token进行鉴权,云服务通过OrgID来验证和解析Token。OrgID的认证机制请参见OrgID身份认证。 访问控制 产品数字化协同平台云服务支持通过OrgID进行细粒度授权策略、应用权限进行访问控制。产品数字化协同平台云服务权限策略将服务本身的权限采用RBAC授权策略做了角色或者细粒度划分,角色和策略明确定义了服务允许或者拒绝的用户操作。 父主题: 安全
  • IPDCenter 基础服务 表1 统一工作台 功能名称 功能描述 发布区域 自定义工作台 支持创建自定义工作台,修改自定义工作台的名称。 自定义工作台由多个卡片组成,添加后可在面板中拖动卡片调整位置。 支持编辑个产品数字化工作流、快捷应用卡片、通用功能卡片、产品主数据资产卡片倒计时和文本等卡片。 华北-北京四 查看工作台 支持查看工作台详情。 华北-北京四 删除工作台 支持删除自定义工作台。 华北-北京四 编辑工作台 支持编辑工作台。 华北-北京四 表2 流程管理器 功能名称 功能描述 发布区域 流程模板定义 支持流程自定义,无需代码,通过可视化的流程设计界面,轻松创建、编辑、维护业务流程。 华北-北京四 表3 管理中心 功能名称 功能描述 发布区域 用户管理 包含认证源管理、组织管理及用户管理。 认证源管理:支持配置多种第三方认证源,包括组织社交认证源和组织认证源。组织创建者或组织管理员可以根据组织需要添加、修改和删除认证源。 华北-北京四 授权管理 在授权管理中,可以查看授权成员列表、为成员授权,进行授权续期、授权移交或取消授权等操作。 华北-北京四 集成管理 包含应用集成、卡片管理及秘钥管理。应用集成,便捷地将应用集成至CraftArts IPDCenter;卡片管理,支持上传自定义卡片;秘钥管理,轻松创建和管理密钥,保护密钥的安全。 华北-北京四 日志管理 支持查询历史操作记录。 华北-北京四 父主题: 产品功能
  • 服务韧性 产品数字化协同平台云服务提供网络层防DDos能力,DDoS高防(Advanced Anti-DDoS,简称AAD)是企业重要业务连续性的有力保障。 当您的服务遭受大流量DDoS攻击时,DDoS高防可以保护用户业务持续可用。DDoS高防通过高防IP代理源站IP对外提供服务,将恶意攻击流量引流到高防IP清洗,确保重要业务不被攻击中断。 同时,产品数字化协同平台云服务通过对接应用性能管理服务(Application Performance Management,简称APM)来统计服务可用度、API接口可用度和错误率,通过对接API网关(API Gateway,简称APIG)来统计流控成功率,以实现可靠性能指标的采集和度量。 父主题: 安全
  • 权限管理 产品数字化协同平台云服务有着自己的一套预设角色权限系统。服务开通后,超级管理员可对用户进行授权。 产品数字化协同平台云服务中预设了两类角色,各角色操作权限如下: 超级管理员:开通服务时会配置一个超级管理员,可根据实际业务需要进行修改。超级管理员享有配置组织和为用户设置权限的权限。超级管理员若需要在产品数字化协同平台云服务进行业务作业,需为自己设置添加用户权限。 用户:服务开通后,管理员将用户添加进组织,用户默认授予普通用户权限。普通用户享有产品数字化协同平台云服务的读写权限。
  • 数据保护技术 CraftArts IPDCenter(产品数字化协同平台云服务)通过多种数据保护手段和特性,保障在存储和传输的数据安全可靠。 表1 数据保护手段和特性 数据保护手段 简要说明 详细介绍 传输加密(HTTPS) 支持HTTP和HTTPS两种传输协议,为保证数据传输的安全性,推荐您使用更加安全的HTTPS协议。 传输敏感数据(包含密码)时使用TLS1.2版本的HTTPS协议,支持完整性和机密性保护。 服务端存储加密 服务端对于敏感数据采取加密存储机制,使用SCC加密机制。 RDS高安全性。 数据备份 使用公有云RDS/OBS提供的数据备份恢复机制。 RDS/OBS高可靠性。 敏感操作保护 用户进行敏感操作时,会对操作用户进行风险提示,或者二次认证通过后进行操作。 敏感操作包括服务的启动、停止、部署与升级等。 父主题: 安全
  • 产品主数据协同服务 表1 Part管理 功能名称 功能描述 发布区域 创建Part 支持创建单个Part,输入单个部件编码、名称、描述、视图和生命周期模板等信息,属性约束校验通过后,会创建出单个Part。属性包含基础属性、分类属性、IBA属性和二维表属性等。 华北-北京四 更新Part 支持更新单个Part,输入单个部件编码及版本,或者对应的OID及部件的名称、描述、视图等信息,属性约束校验通过后,成功更新部件对应属性及关联关系,部件版本会发生变化。 华北-北京四 搜索Part 可按照关键词,例如Name、Number、创建时间、更新时间或创建人等属性,进行部件组合查询,支持查询条件、结果集自定义取并集或交集。 华北-北京四 删除Part 支持删除未发布数据对象的小版本。 华北-北京四 修订Part 支持部件修订功能,修订完成之后,部件升级大版本。 华北-北京四 检出Part 支持检入、检出、保存功能,检出部件之后生成部件副本,版本不升级。 华北-北京四 另存为Part 支持继承源Part的属性、BOM结构、关联文档创建新的Part,可在此基础上进行维护并记录另存关系。 华北-北京四 查看Part详情 支持查看Part的全部信息,包括Part全部属性、BOM结构、历史版本、文档关联关系、替代关系等。 华北-北京四 文档关联关系 支持为部件创建、更新或删除与文档的描述关系、参考关系,部件版本发生变化。 华北-北京四 MPN关联关系 支持为部件创建、更新或删除与MPN的关联关系,部件版本发生变化。 华北-北京四 Part比对 支持两个以上的Part进行比对,详细展示两个或者多个Part之间的差异点。 华北-北京四 替代关系 支持为部件创建、更新或删除替代关系,替代关系的描述属性支持自定义。 华北-北京四 表2 BOM管理 功能名称 功能描述 发布区域 创建BOM 支持基于特定部件版本,衍生创建出其它视图的部件,并支持定义属性、关联关系(BOM、文档、MPN、替代)是否继承。 华北-北京四 查询BOM 支持按照指定编码、指定版本或指定视图查询全量BOM数据。 华北-北京四 比较BOM 支持子项、用量或位号的比较,支持其它BOM级属性的比较。 华北-北京四 定义BOM多视图 支持管理员创建、修改BOM视图,如生产视图、试制视图或earlyView视图。 华北-北京四 BOM有效性管理 支持生效日期的管理,为BOM维护生效日期。 华北-北京四 自定义规则 支持用户自定义BOM的创建、更新和校验规则。 华北-北京四 表3 MPN管理 功能名称 功能描述 发布区域 创建厂家型号 支持具备权限的用户创建厂家型号。 华北-北京四 厂家型号分类管理 支持不同分类的厂家型号关联不同属性模板,与Part分类模板类似;支持业务进行厂家型号分类模板修改。 华北-北京四 文档关联关系 支持厂家型号关联器件、资料、DataSheet等文档。 华北-北京四 厂家型号生命周期管理 厂家型号可以进行生命周期管理,如Approved、EOP、Obsolete等。 华北-北京四 查看厂家型号详情 支持查看厂家型号的全部信息,包括厂家型号属性、历史版本、关联部件、历史关联部件等。 华北-北京四 查询MPN 支持MPN查询,可根据MPN关键属性查询满足条件的MPN列表。 华北-北京四 管理供应商 支持供应商的创建、更新和删除。 华北-北京四 表4 文档管理 功能名称 功能描述 发布区域 创建文档 支持单个/批量文档创建,输入文档信息、文档细类、主要文件、次要文件等信息。 华北-北京四 更新文档 支持检入/检出、删除版本、作废文档、重命名、修改其他文档属性等更新操作。 华北-北京四 另存为文档 支持继承源文档的属性、关联关系创建新的文档,可在此基础上进行维护并记录另存关系。 华北-北京四 复制创建新文档 与“另存为”功能类似,但是不会记录复制关系。 华北-北京四 查看文档详情 支持查看文档的全部信息,包括文档全部属性、历史版本、关联关系等。 华北-北京四 建立关联关系 支持与部件建立描述关系、参考关系;支持文档之间建立参考、结构关系。 华北-北京四 文档搜索 支持文档搜索功能。 华北-北京四 表5 变更管理 功能名称 功能描述 发布区域 创建EC流程 支持创建工程变更EC流程。EC(Engineering Change,工程变更) 在解决产品开发中出现的各类问题,使产品符合功能规格需求,或对产品品质进行改进、降低产品成本等情况下,对产品的修改,可以通过EC流程进行。 华北-北京四 表6 分类/属性管理 功能名称 功能描述 发布区域 创建属性 支持属性自定义,可记录属性的中文名称、英文名称、中文描述、英文描述、数据类型、属性类型等。 华北-北京四 创建分类 支持分类层级设计、分类基础信息和分类模板定义,其中: 分类基础信息,定义包括分类码(必填)、分类中文名称(必填)、分类英文名称、分类中文描述、分类英文描述、分类父节点(必填)等。 分类模板定义,支持添加已创建的属性或从已有的分类复制,支持对添加的属性定义允许值、默认值、是否必填、是否合成描述、是否多值等信息。 华北-北京四 更新分类 支持分类归属层级调整、分类基础信息维护、分类模板维护和分类失效。 华北-北京四 查询分类&属性 支持查看分类基本信息、分类模板、分类层级等信息; 支持查看属性信息以及属性被应用的分类; 支持查询结果导出。 华北-北京四 父主题: 产品功能
  • 组件介绍 系统预置多种工具及组件,详情如下表。 表1 组件介绍 图标 名称 功能 抓手工具 拖动画布。 套索工具 选择多个图形,也可以使用快捷键Shift选取。 创建/删除空间工具 创建/删除空间。 开始事件 作为流程的开始。 中间事件 作为流程组件的中间事件,是一个暂停事件,将流程事务提交,并启动一个新事务执行后续的流程。 最常用的是作为消息捕获或定时任务。 结束事件 代表整个流程的结束。 排他网关 作为流程组件的路由网关,用于区分分支路由,出口走其中一条分支。 并行网关 作为流程组件的路由网关,并行网关允许将流程拆分为多个分支,也可以将多个分支汇集到一起。 包容网关 包容网关是排他网关和并行网关的综合体。包容网关与并行网关类似都是配对使用。 与并行网关的区别是,并行网关出口分支都执行,包容网关是出口分支可以配置条件,执行或不执行。 空白任务 空白任务节点作用与手动任务节点相同。流程引擎处理该节点时将简单通过,自动继续流程。 用户任务 作为流程组件的用户处理任务,用户可以进行通过、驳回、转审等操作。 服务任务 作为流程组件的服务任务节点,调用API服务。 业务规则任务 作为流程组件的业务规则任务,执行一段表达式或java程序。 发送任务 作为流程组件的发送消息组件。 接收任务 作为流程组件的监听事件,等待一个特定的消息(用户配置的消息)到达才往下执行。 手动任务 用于建模自定义任务内容的任务节点,流程引擎处理该节点时将简单通过,自动继续流程,常用于流程调试。 内嵌子流程 内嵌子流程,它是一个可以包含其他活动、分支、事件等的活动。它表现为将一个流程(子流程)定义在另一个流程(父流程)的内部,子流程作为父流程的一部分。 外接子流程 作为流程组件的内嵌流程,嵌入其他bpmn流程。 导航分组 作为流程组件的分组节点,用户导航树自动生成时作为父节点展示。
  • 快捷键介绍 在编排组件的过程中,还可以通过以下快捷键进行快捷操作。 表2 快捷键命令 操作 快捷键 操作 快捷键 搜索元素 Ctrl + F 复制 Ctrl + C 全选 Ctrl + A 粘贴 Ctrl + V 撤销 Ctrl + Z 删除 Backspace / Delete / Del 恢复 Ctrl + Y 上下滚动 鼠标滚轮 手型工具 H 移动 ←↑→↓ 套索工具 L 左右滚动 Shift + 鼠标滚轮 空间工具 S 缩放 Ctrl + (鼠标滚轮 / +-) 连接工具 C 恢复缩放 Ctrl + 0 编辑名称 E 选取 Shift + (鼠标左键 / 鼠标拖动)
  • 流程设计 流程申请单创建完成后,返回至申请单列表页面,单击操作列的“编辑”,进入流程编辑页面。 添加组件。 拖拽左侧列表中的组件至工作布。 单击画布中的组件,会显示快捷操作按钮,通过快捷按钮,也可以快速的添加任务、网关、事件、注释或连接线等。 如图1所示,添加四个组件,开始事件、结束事件和“用户任务”,并使用箭头进行连接。更多组件说明请参考组件介绍。 图1 创建流程节点 为组件添加属性及监听器。 选择“用户任务”组件,在右侧“常规”页签中设置“名称”“责任人”“责任群组”等信息。 选择“连接箭头”组件,在右侧“常规”页签中设置“中文名称”“英文名称”,“通过条件”选择“表达式”。 常规属性设置完成后,选择监听器页签,根据实际情况,在“监听器列表”中,为组件添加相应的监听动作。 如“超时自动转审”“超时自动审批”等。 图2 属性设置 设置完成后,单击右上角的“保存”。 选择“文件”可将当前界面保存为BPMN文件或SVG图。
  • 安装Node及Npm Node.js是一个JavaScript的运行环境,它能帮我们在服务器端运行JavaScript代码。我们需要Node.js来运行一些命令行工具。 首先,我们需要下载Node.js的安装包。你可以在Node.js的官方网站(https://nodejs.org/)下载安装包。 安装完成后,打开命令行工具,输入以下命令来检查Node.js是否成功安装: node -v 如果安装成功,应该可以看到Node.js的版本号。 npm是Node.js的包管理器,用于安装第三方包。同样地,在命令行中输入以下命令来检查npm是否成功安装: npm -v 如果安装成功,应该可以看到npm的版本号。
  • 卡片管理功能 整体卡片管理功能权限受控,应当由具备管理员权限的账号进行统一管理维护,普通账号无权限进行操作。 访问CraftArts IPDCenter门户网站,登录管理员账号,点开左上角功能扩展按钮,进入管理中心。 图1 进入管理中心 绑定应用和密钥。 图2 添加应用 图3 新增密钥 密钥作为卡片认证信息唯一标识,在卡片开发过程中使用当前密钥进行统一认证,生成token进行前后端数据请求。详情参见统一认证配置指南。 将1.6章节中生成的卡片JS进行上传管理 图4 上传卡片 Vue-cli生成的卡片输出为完整js,需要将其重命名为index.js,放置在zip压缩包内。否则会出现验证不通过的异常。 卡片上传完成之后进行使用,点击使用卡片之后,进入门户编辑页面引入使用。 图5 点击使用卡片 图6 进入门户编辑 图7 点击增加功能卡片展开卡片列表,拖动创建好的卡片到门户页。 成功引入卡片展示,效果如图。 图8 卡片渲染成功样例
  • Nmp工具类 对于一些简单的公共函数来说,直接添加function工具类会很方便,但是对于一些比较复杂的公共函数或者第三方的一些公共函数来说,直接编写函数并不是一个理想的方式,所以,我们还提供了npm工具类,以供引入npm包。 进入UI编辑器,单击插件栏的进入国际化页面。 单击,选择npm,配置如下信息。 图2 Nmp工具类 表1 参数说明 参数 释义 名称 utils名称。 包名 npm包名。 导出名称 导入时的命名,如果是非解构,则可以自由命名,如果是解构,则npm包的导出必须要有该名称。 是否解构 解构则使用如import {export1} from 'module'的方式导入。 入口路径 有些npm包的方法并不在默认导出中,如import {foo,bar} from"module-name/path/to/specific/un-exported/file",这时候,就需要填写入口路径。 版本号 npm包的版本号,需要符合npm包版本规范,如不填则默认为最新的。 cdn链接 浏览器直接可用的生产包链接,请确保可用,否则可能会造成页面预览失败。 如果页面使用了npm utils,则需要在手动录入npm cdn链接,否则可能会造成页面预览失败。 配置完成后,单击“保存”。
  • 操作场景 在常规代码开发中,我们通常会将一些高频率用到的一些代码片段抽离出来业务代码,使其成为一个公共函数,减少重复的代码,从而达到代码复用的目的。 同样,在低代码开发中,我们不可避免的需要编写一些高代码进行组合开发,这里同样存在存储一些公共函数以供各处调用需求。 工具类方法utils就是诞生在这样的背景之下,我们可以将一些可复用的公共函数编写到工具类方法中,也可以将一些npm包引用到utils中,供后续调用。
  • 编辑器首页 图1 UI编辑器页面 工具栏:汇集了系统常用操作,包含清除画布、刷新画布、保存画布、预览、发布、撤销、回退、全屏、国际化切换、注销登录。 插件:系统、页面级内容管理,包含物料管理、大纲树、国际化、页面JS、状态管理、资源管理、页面Schema几个模块。 物料:页面编排时用到的组件。 导航树:展示电子流节点信息并作为页面管理入口,包含页面的复制、粘贴,绑定页面生命周期。 画布:页面绘制,包含页面元素的新增、复制、删除、顺序调整。 设置面板:页面属性配置、高级配置。
  • 业务组件 系统内置9个业务组件。进入UI编辑器,单击插件栏的展开物料列表,单击组件页签,根据实际需求选择对应的业务组件。 图1 业务组件 表1 业务组件介绍 序号 组件名称 功能描述 1 添加部件 配置文档/部件筛选。 2 设置参与者 配置不同角色的用户。 3 流程指引 展示流程操作指引。 4 信息树 配置产品信息树并进行搜索和选择。 5 流程团队 展示团队角色及成员信息。 6 评审记录 展示当前节点处理任务及历史评审记录。 7 评审三件套 设置评审路由(通过、驳回、转他人处理)及意见。 8 转审记录 通过表格展示转审记录。 9 附件 文件上传与下载管理。 父主题: 新增组件
  • 获取方式 获取CraftArts IPDCenter系统管理员账号密码,通常为购买者注册的华为云账号。 登陆CraftArts IPDCenter系统首页,https://域名/unifiedportal/,可以在购买页面找到此地址。 进入管理中心。 图1 管理中心 在应用集成页面添加一个自己产品的应用。 图2 应用集成 在密钥管理页面创建密钥,创建成功后将会弹出密钥编码,私钥信息。 图3 秘钥管理
  • 创建模型 流程编辑完成后,选择“数据编辑”页签,进入数据编辑页面。 单击“添加模型”,进入新增模型页面。 图1 添加模型 输入模型的中英文名称及描述,并选择一个父模型。 WfFormdata:表单模型,对应页面上一个表单或表格。 WfBusinessObject:基本业务对象,具有12个系统属性(Name、Description、ID、Creator、CreateTime、Modifier、LastUpdateTime、RdmVersion、RdmExtensionType、KIAGUID、SecurityLevel、Tenant)。 单击“确定”。
  • JWT的组成 图1 Json web token 一个JWT实际上就是一个字符串,它由三部分组成,头部、载荷与签名。形式为: A.B.C 样本数据如下: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJhdWQiOlsiZGVmYXVsdCIsImdhdGV3YXkiXSwiYXBwSWQiOiJkZWZhdWx0IiwiaXNzIjoiZGVmYXVsdCIsImV4cCI6MTU0NDY5MDY0NywiaWF0IjoxNTQ0Njg4ODQ3fQ.J-ngHZy8009k-OAQ7-6Jt2kUzsml6N60d-atVIP3UydsQH_GqFv4rSY_uliqZ2_8ecgcKm0pWAAFtN88t7ehVQ 头部( Header ) JWT需要一个头部,头部用于描述关于该JWT的最基本的信息,例如其类型以及签名所用的算法等。 头部信息是经过BASE64 编码的,包括以下几个属性: typ: token类型,固定,即JWT; alg: 签名算法类型,如RSA; kid: 密钥ID,由CraftArts IPDCenter颁发。 载荷(Payload) 载荷信息是经过BASE64编码解码后的JSON对象,包括以下几个属性: iss:该JWT的签发者,当前使用域名填充; sub:该JWT所面向的用户,当前使用系统应用Id; aud:接收该JWT的一方,当前使用被调用系统应用Id; exp(expires):什么时候过期,这里是一个Unix时间戳,默认5分钟; iat(issued at):在什么时候签发的(UNIX时间); nbf(Not Before):如果当前时间在nbf里的时间之前,则token不被接受;是否使用是可选的。 签名(Signature) 将上面的两个Base64编码后的字符串都用英文句号“.”连接在一起(头部在前),就形成了: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJhdWQiOlsiZGVmYXVsdCIsImdhdGV3YXkiXSwiYXBwSWQiOiJkZWZhdWx0IiwiaXNzIjoiZGVmYXVsdCIsImV4cCI6MTU0NDY5MDY0NywiaWF0IjoxNTQ0Njg4ODQ3fQ 最后,我们将上面拼接完的字符串用HS512算法进行加密。在加密的时候,我们还需要提供一个密钥(secret)。如果我们用mystar作为密钥的话,那么就可以得到我们加密后的内容: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJhdWQiOlsiZGVmYXVsdCIsImdhdGV3YXkiXSwiYXBwSWQiOiJkZWZhdWx0IiwiaXNzIjoiZGVmYXVsdCIsImV4cCI6MTU0NDY5MDY0NywiaWF0IjoxNTQ0Njg4ODQ3fQ.J-ngHZy8009k-OAQ7-6Jt2kUzsml6N60d-atVIP3UydsQH_GqFv4rSY_uliqZ2_8ecgcKm0pWAAFtN88t7ehVQ
  • IPD组件 系统内置19个IPD组件。进入UI编辑器,单击插件栏的展开物料列表,单击组件页签,根据实际需求选择对应的IPD组件。 图1 IPD组件 表1 组件介绍 序号 组件名称 功能描述 1 BOX 提供div组件,内置插槽,允许拖入其他组件。 2 选人组件 用于选择或输入人员。 3 选择器 当选项过多时,使用下拉菜单展示并选择内容。 4 按钮 常用的操作按键。 5 折叠面板 通过折叠面板收纳内容区域。 6 单选框 在一组备选项中进行单选。 7 多选框 在一组备选项中进行多选。 8 时间选择器 用于选择或输入时间。 9 日期选择器 用于选择或输入日期。 10 输入框 通过鼠标或键盘输入字符。 11 弹框 用于消息提示、确认消息和提交内容。 12 树形控件 用清晰的层级结构展示信息,可展开或折叠。 13 文本展示 展示文本,支持纯文本和超链接。 14 状态标识 通过有色圆点标识状态,包含成功、失败、告警。 15 帮助文档 添加帮助文档或提示信息。 16 表单 由输入框、选择器、单选框、多选框等控件组成,用以收集、校验、提交数据。 17 表格 用于展示多条结构类似的数据,可对数据进行排序、筛选、对比或其他自定义操作。。 18 行容器 通过行容器和列容器,实现组件的栅格布局。 19 列容器 父主题: 新增组件
  • 操作步骤 进入流程编辑页面。 选择左侧的,进入导航树配置页面,或选择组件,在右侧的页签中选择“导航树配置”。 选中“事件”或“任务”设置节点状态。 图1 导航树配置 节点是否重置:从其他节点进入当前节点时,是否重置数据。 节点点击状态:默认,未开始不可点击;可点击,永远可点击;不可点击,永不点击;表达式,根据条件满足可点击。 节点初始化时是否点亮:若选择是,则节点亮起状态时为可选。 驳回是否重置:可选是或否,若选择是,驳回时已完成的审批节点将重置,需再次审批。 展示子任务:可选是或否,若选择是,在节点导航中可见子任务流程。 展示内容:可选“展示新伦次子任务”或“展示所有子任务”。 节点是否跳过:选择是后将跳过此节点。 节点是否可见:设置节点可见状态,可选择是、否或自定义表达式。 节点是否展开:设置节点展开状态,可选择是、否或自定义表达式。 设置完成后,单击右上角的“保存”。
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于创建&更新北向NA信息接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "application/json" : { "name" : "北向系统1", "description" : "这是一个北向NA", "endpoint" : "https://068b72f3b75444dda67cc6e2286a4c20.apic.cn-south-1.huaweicloudapis.com", "auth_type" : "AKSK", "auth_aksk_info" : { "secret" : "123456" }, "access_type" : "ROMA", "access_roma_info" : { "app_key" : "ebf59208-4c6b-4b06-9b69-494e9df475a3", "app_secret" : "fa3c8cd144b29771b5873ae6a7efa25b393c86665d2e9ffa34d1309c5cd704ea" } } } 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "errorCode": "IoTEdge.03004005", "errorMsg": "The NA name is already used." } 其中,errorCode表示错误码,errorMsg表示错误描述信息。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 edge_apps Array of QueryApplicationBriefResponseDTO objects 每页记录数 数组长度:0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 QueryApplicationBriefResponseDTO 参数 参数类型 描述 edge_app_id String 应用id 最小长度:1 最大长度:64 description String 应用描述 最小长度:0 最大长度:256 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256 last_published_version String 最新发布版本 最小长度:0 最大长度:64 app_type String 应用类型SYSTEM_REQUIRED|SYSTEM_OPTIONAL|USER 最小长度:0 最大长度:64 function_type String 应用类型DATA_PROCESSING|PROTOCOL_PARSING 最小长度:0 最大长度:64 deploy_type String 部署类型docker|process 最小长度:0 最大长度:64 protocol String 驱动协议类型OPCUA|Modbus-TCP 最小长度:0 最大长度:64 edge_app_name String 应用名称 最小长度:0 最大长度:64
  • 响应示例 状态码: 200 OK { "count" : 0, "page_info" : { "offset" : 0, "limit" : 0 }, "edge_apps" : [ { "edge_app_id" : "string", "description" : "string", "create_time" : "string", "update_time" : "string", "last_published_version" : "string", "app_type" : "string", "function_type" : "string", "protocol" : "string", "edge_app_name" : "string", "deploy_type" : "string" } ] }
  • URI GET /v2/{project_id}/edge-apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 edge_app_id 否 String 应用ID搜索关键字 最小长度:1 最大长度:32 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0 最小值:0 最大值:1000000 缺省值:0 limit 否 Integer 每页记录数,默认值为10,取值区间为1-1000 最小值:0 最大值:1000000 缺省值:10 app_type 否 String 应用id搜索关键字 最小长度:0 最大长度:64 枚举值: SYSTEM_REQUIRED SYSTEM_OPTIONAL USER function_type 否 String 功能类型 最小长度:0 最大长度:64 枚举值: DATA_PROCESSING PROTOCOL_PARSING ON_PREMISE_INTEGRATION GATEWAY_MANAGER COMPOSITE_APPLICATION DATA_COLLECTION function_types 否 Array 功能类型列表 数组长度:0 - 1000 protocol 否 String 驱动协议类型搜索关键字 最小长度:1 最大长度:64
共100000条