GB_T 43960-2024 云制造服务平台开放接口要求.docx

ICS35.240.50CCSJ07中华人民共和国国家标准GB/T439602024云制造服务平台开放接口要求Openapplicationprograminterfacerequirementsforcloudmanufacturingserviceplatform2024-04-25发布2024-11-01实施国家市场监督管理总局国家标准化管理委员会目次前言III1范围12规范性引用文件13术语和定义14缩略语15开放接口模型26接口类型37接口编写要求98接口设计要求1()9接口注册与调用要求1010数据包格式Il附录A(资料性)云制造服务平台开放接口示例13本文件按照GB/T1.12020标准化工作导则第1部分：标准化文件的结构和起草规则的规定起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由中国机械工业联合会提出。本文件由全国自动化系统与集成标准化技术委员会（SAGTC159）归口。本文件起草单位：北京航大智造科技发展有限公司、江苏省工业互联网发展研究中心、贵州航大云网科技有限公司、苏州申浪信息科技有限公司、北京机械工业自动化研究所有限公司、清华大学、贵州大学、北京航空航天大学、贵州溪山科技有限公司、中科云谷科技有限公司、中国科学院自动化研究所、重庆大学、江苏中车数字科技有限公司、南京航空航天大学、联通数字科技有限公司、广州机智云物联网科技有限公司、贵州鸿巨热力（集团）有限责任公司、北京工业大学、贵州中车绿色环保有限公司、航天精工股份有限公司、北京科技成果转化服务中心、河北宝力工程装备股份有限公司、湖南华博信息技术有限公司、国家开放大学、浪潮通信技术有限公司、浙江第元信息技术有限公司、四川德恩云智造科技有限公司、云智（天津）科技有限公司、北京信达远科技有限公司。本文件主要起草人：杨灵运、张华、于文涛、王海丹、曹玉龙、谷牧、赵千川、杨静、冯泽军、任磊、尹作重、张昌福、杨文峰、周志忠、唐敦兵、孙洁§、姜海森、石伟、王发华、陈世超、李孝斌、黄灼、邢雁、吕宜生、曲涛、景宁、许培炎、王琢璞、金F凡、冯濒元、周恢、朱海华、张泽群、薛舒允、潘明波、杨杰、石娇、严海蓉、刘希亮、宿春慧、王旭亮、王紫程、胡丙齐、龚博翔、石永、甄伟、罗向阳、赵建林、田志、袁卓异、陈海锋、谢龙德、陆小斌、王洪臻。云制造服务平台开放接口要求1范围本文件规定了云制造服务平台的开放性应用程序编程接口模型、接口类型与设计编写要求，为云制造服务平台的开发者提供指导。本文件适用于指导云制造服务平台的制造资源/能力接入、微服务/APP应用开发有关接口的开发、调用与测试。2规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本(包括所有的修改单)适用于本文件。GB/T298262013云制造术语GB/T39471-2020云制造服务平台制造资源接入集成规范GB/T39403-2020云制造服务平台安全防护管理要求3术语和定义GB/T29826-2013界定的以及下列术语和定义适用于本文件。3.1开放接口openapplicationprograminterface云制造服务平台对外提供的开放性应用程序编程接口。3.2工业应用服务接口applicationprograminterfaceforindustrialapplication在云制造服务平台上，提供的支持工业应用开发和管理等方面的开放性应用程序编程接口。3.3制造资源/能力½j口applicaticnprograminterfacefornmifacturingresource/CaPabilityi11prt在云制造服务平台上，为云制造资源/能力接入到平台，提供的支持数据传输、资源管理、标识管理等方面的开放性应用程序编程接口。4缩略语下列缩略语适用于本文件。API:应用程序编程接口(APPIiCalionProgrammingInterface)APP:应用程序(APPHCatiOn)ERP:企业资源计划(EnterPriSeResourcePlanning)HTTP:超文本传输协议(HyPerTeXtTransferProtocol)HTTPS:超文本传输安全协议(HyPerteXtTransferProtocolSecure)ID:身份标识号(IdentifiCatiOn)MES:生产制造过程执行系统(ManUfaCtUringExecutionSystem)OWASP:开放式Web应用程序安全项目(OPenWebApplicationSecurityProject)P1.M:产品生命周期管理(ProdUCl1.ifecycleManagement)POST:HTTP协议的POST方法(PoSI)PUT:HTTP协议的PUT方法(PUt)S1.A:服务等级协议(SerViCe-1.eVelAgreement)SCADA:数据采集与监视控制系统(SUPerViSoryControlAndDataAcquisition)5开放接口模型5.1通则云制造服务平台开放接口模型架构见图1,包括工业应用服务接口和制造资源/能力接入接口两大类开放接口。制造资源/能力接入方面应符合GB/T394712020第6章第8章的规定。接口安全方面应符合OWASP、GB/T394032020的相关规定。两大类接口可使用HTTP、HTTPS等传输协议，宜遵守OPenAPlSpecificationS1.A等规范。5.2应用服务接口工业应用服务接口分为工业应用开发接口和工业应用管理接口，其中工业应用开发接口包括数据类接口、模型类接口和微服务类接口，应明确工业应用开发调用的数据、模型和微服务的接口；工业应用管理接口应包括应用管理类接口和安全类接口，应提供应用部署、监控管理、身份认证、访问控制、权限管理等方面的接口。5.3制造资源/能力接入接口制造资源/能力接入接口分为制造资源/能力接入服务接口和制造资源/能力接入管理接口，其中制造资源/能力接入服务接口应包括设备数据类接口、设备控制类接口、系统数据类接口和接入安全类接口，应明确工业设备、企业信息系统与平台数据交互、设备控制命令下发和保障接入安全的接口；制造资源/能力接入管理接口应包括设备管理类接口、边缘管理类接口和标识类接口，提供工业设备、边缘网关等云制造资源管理和标识等方面的接口。6接口类型6.1云制造服务平台开放接口主要有以下几种类型：a）数据类；b）模型类；c）微服务类；（1）安全类；e）标识类；f）管理类；g）控制类。云制造服务平台开放接口示例参见附录A。6.2 工业应用服务接口6.2.1 雌口6.21.1 数据获礴数据获取接口应支持数据资源状态信息查询，典型接口定义见表1。表1数据获取接口定义接口名称数据获取接口接口说明根据企业和数据资源ID,获取数据资源的状态信息接口方法POST参数说明至少包含:数据资源ID(String(IataRID)%企业ID(StringentlD)>用户ID(StringuserID)、身份认证参数(Stringaccess-token)返回值返回所需要的数据资源信息，例如数据量、数据更新时间、数据权限等6.21.2 数据分析接口表2数据分析接口定义接口名称数据分析接口接口说明根据数据分析任务和用户ID获取数据分析结果接口方法POST参数说明至少包含：企业ID(StringentID)、用户ID(StringUSerID)、身份认证参数(StringaCCeSS_token)、数据分析任务ID(StringdatID)返回值返回数据分析结果信息6.2.2模型类接口6.2.2.1 模型注册接口模型注册接口应能支持不同类型模型在平台上实现注册的功能，典型接口定义见表3。«3模型注册接口定义接口名称模型注册接口接口说明获取新增模型注册信息接口方法POST参数说明至少包含:用户ID(StringUSerID)、身份认证参数(Stringaecess_token)、模型名称(stringmo-deName)、模型描述(SlringInOdeDeS)、模型分类(StringmodeClass)返回值返回包含是否注册成功6.2.2.2 模型状态查询接口模型状态查询接口应能支持不同类型模型在平台上的运行状态查询等功能，典型接口定义见表4。*4模型状态查询接口定义接口名称模型状态查询接口接口说明获取模型运行状态数据接口方法GET参数说明至少包含：用户ID(StringUSerID)、身份认证参数(StringaCCeSSJoker1)、模型ID(StringmOdeID)返回值返回所需模型运行状态数据6.2.3 微服务类接口6.2.3.1 微服务注册接口表5微服务注册接口定义接口名称微服务注册接口接口说明获取新增微服务定义信息接口方法POST参数说明至少包含：用户ID(SlringuserID)身份认证参数(Slringaccesstoken)微服务名称(SIringSeVName)、微服务描述(StringSeVDes)、数据中心地址(StringdataUrl)返回值返回所需微服务信息数据6.2.3.2 微服务查询接口微服务查询接口应能实现平台微服务的运行状态查询，典型接口定义见表6。表6微服务状态查询接口定义接口名称微服务状态查询接口接口说明获取微服务运行状态数据接口方法GET参数说明至少包含：用户ID(StringuserID),身份认证参数(StringaCCCSS_tokcn)、微服务ID(Stringmi-CroSerID)、任务ID(StringtaskID),启动微服务的用户账号(StringuserName)返回值返回所需微服务运行状态数据6.2.4 应用管理类接口6.2.4.1 应用部署发布接口应用部署发布接口应支持创建和发布应用，典型接口定义见表7。«7应用部发布接口定义接口名称应用部署发布接口接口说明创建和发布相关应用接口方法POST参数说明至少包含：用户ID(StringUSer1D)、身份认证参数(StringaCCeSS_token)、应用ID(StringappID)¼应用名称(StringappNamc)、应用版本(StringappVision)返回值返回包含应用ID和是否发布成功状态值6.2.4.2 应用健康状态监测接口表8应用健康状态监测接口定义接口名称应用健康状态监测接口接口说明获取应用的健康状态等数据信息接口方法GET参数说明至少包含:用户ID(SlringuserID)>身份认证参数(Stringaccesstoken)、应用ID(SIringapplD)返回值返回应用是否正常运行的状态信息6.25 蹒鞋雌口应用安全类接口应支持应用管理用户身份认证、获取访问权限等功能，典型接口定义见表9。表9应用安全认证接口定义接口名称应用安全认证接口接口说明根据用