GB/T 43960-2024 云制造服务平台开放接口要求

　　ICS 35.240.50 CCS J 07

　　中 华 人 民 共 和 国 国 家 标 准

　　GB/T 43960—2024

　　云制造服务平台开放接口要求

　　Open application program interfacerequirementsfor

　　cloud manufacturingserviceplatform

　　2024-04-25发布 2024-11-01实施

　　国家市场监督管理总局国家标准化管理委员会

　　

　　发

　　

　　布

　　GB/T 43960—2024

　　目 次

　　前言 Ⅲ

　　1 范围 1

　　2 规范性引用文件 1

　　3 术语和定义 1

　　4 缩略语 1

　　5 开放接口模型 2

　　6 接口类型 3

　　7 接口编写要求 9

　　8 接口设计要求 10

　　9 接口注册与调用要求 10

　　10 数据包格式 11

　　附录 A (资料性) 云制造服务平台开放接口示例 13

　　Ⅰ

　　GB/T 43960—2024

　　Ⅲ

　　前

　　本文件按照 GB/T 1. 1—2020《标准化工作导则

　　

　　言

　　第 1 部分 :标准化文件的结构和起草规则》的规

　　定起草 。

　　请注意本文件的某些内容可能涉及专利 。本文件的发布机构不承担识别专利的责任 。

　　本文件由中国机械工业联合会提出 。

　　本文件由全国 自动化系统与集成标准化技术委员会(SAC/TC159)归 口 。

　　本文件起草单位 :北京航天智造科技发展有限公司 、江苏省工业互联网发展研究中心 、贵州航天云网科技有限公司 、苏州申浪信息科技有限公司 、北京机械工业自动化研究所有限公司 、清华大学 、贵州大学 、北京航空航天大学 、贵州溪山科技有限公司 、中科云谷科技有限公司 、中国科学院自动化研究所 、重庆大学 、江苏中车数字科技有限公司 、南京航空航天大学 、联通数字科技有限公司 、广州机智云物联网科技有限公司 、贵州鸿巨热力(集团)有限责任公司 、北京工业大学 、贵州中车绿色环保有限公司 、航天精工股份有限公司 、北京科技成果转化服务中心 、河北宝力工程装备股份有限公司 、湖南华博信息技术有限公司 、国家开放大学 、浪潮通信技术有限公司 、浙江第元信息技术有限公司 、四川德恩云智造科技有限公司 、云智(天津)科技有限公司 、北京信达远科技有限公司 。

　　本文件主要起草人 :杨灵运、张华、于文涛、王海丹、曹玉龙、谷牧、赵千川、杨静、冯泽军、任磊、尹作重、张昌福、杨文峰、周志忠、唐敦兵、孙洁香、姜海森、石伟、王发华、陈世超、李孝斌、黄灼、邢雁、吕宜生、曲涛、景宁、许培炎、王琢璞、金一帆、冯濒元、周恢、朱海华、张泽群、薛舒允、潘明波、杨杰、石娇、严海蓉、刘希亮、宿春慧 、王旭亮 、王紫程 、胡丙 齐 、龚 博 翔 、石 永 、甄 伟 、罗 向 阳 、赵 建 林 、田 志 、袁 卓 异 、陈 海 锋 、谢 龙 德 、陆小斌 、王洪臻 。

　　GB/T 43960—2024

　　云制造服务平台开放接口要求

　　1 范围

　　本文件规定了云制造服务平台的开放性应用程序编程接口模型 、接口类型与设计编写要求 ,为云制造服务平台的开发者提供指导 。

　　本文件适用于指导云 制 造 服 务 平 台 的 制 造 资 源/能 力 接 入 、微 服 务/APP应 用 开 发 有 关 接 口 的 开发 、调用与测试 。

　　2 规范性引用文件

　　下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款 。其中 , 注 日期的引用文件 ,仅该日期对应的版本适用于本文件 ;不注日期的引用文件 ,其最新版本(包括所有的修改单) 适用于本文件 。

　　GB/T

　　29826—2013

　　云制造 术语

　　GB/T

　　39471—2020

　　云制造服务平台制造资源接入集成规范

　　GB/T

　　39403—2020

　　云制造服务平台安全防护管理要求

　　3 术语和定义

　　GB/T 29826—2013界定的以及下列术语和定义适用于本文件 。

　　3. 1

　　开放接口 open application program interface

　　云制造服务平台对外提供的开放性应用程序编程接 口 。

　　3.2

　　工业应用服务接口 application program interface for industrialapplication

　　在云制造服务平台上 ,提供的支持工业应用开发和管理等方面的开放性应用程序编程接 口 。 3.3

　　制造资源/能力接入接口 application program interfaceformanufacturingresource/capabilityimport

　　在云制造服务平台上 ,为云制造资源/能力接入到平台 ,提供的支持数据传输 、资源管理 、标识管理等方面的开放性应用程序编程接 口 。

　　4 缩略语

　　下列缩略语适用于本文件 。

　　API:应用程序编程接口(Application Programming Interface)

　　APP:应用程序(Application)

　　ERP:企业资源计划(Enterprise Resource Planning)

　　HTTP:超文本传输协议(HyperTextTransferProtocol)

　　1

　　GB/T 43960—2024

　　HTTPS:超文本传输安全协议(HypertextTransferProtocolSecure)

　　ID:身份标识号(Identification)

　　MES:生产制造过程执行系统(Manufacturing Execution System)

　　OWASP:开放式 Web 应用程序安全项 目 ( Open Web Application Security Project)

　　PLM :产品生命周期管理(ProductLifecycle Management)

　　POST: HTTP协议的 POST方法(Post)

　　PUT: HTTP协议的 PUT方法(Put)

　　SLA:服务等级协议(Service-LevelAgreement)

　　SCADA:数据采集与监视控制系统(Supervisory ControlAnd Data Acquisition)

　　5 开放接口模型

　　5. 1 通则

　　云制造服务平台开放接口模型架构见图 1,包括工业应用服务接口和制造资源/能力接入接口两大类开放接 口 。制造资源/能力接入方面应符合 GB/T 39471—2020第 6 章 ~ 第 8 章的规定 。接口安全方面应符合 OWASP、GB/T 39403—2020的相关规定 。

　　两大类接口可使用 HTTP、HTTPS等传输协议,宜遵守 OpenAPISpecification、SLA等规范。

　　图 1 开放接口模型

　　5.2 工业应用服务接口

　　工业应用服务接口分为工业应用开发接口和工业应用管理接 口 ,其中工业应用开发接口包括数据类接口 、模型类接口和微服务类接 口 ,应明确工业应用开发调用的数据 、模型和微服务的接 口 ;工业应用管理接口应包括应用管理类接口和安全类接 口 ,应提供应用部署 、监控管理 、身份认证 、访问控制 、权限管理等方面的接 口 。

　　2

　　GB/T 43960—2024

　　5.3 制造资源/能力接入接口

　　制造资源/能力接入接口分为制造资源/能力接入服务接口和制造资源/能力接入管理接 口 ,其中制造资源/能力接入服务接口应包括设备数据类接口 、设备控制类接口 、系统数据类接口和接入安全类接口 ,应明确工业设备 、企业信息系统与平台数据交互 、设备控制命令下发和保障接入安全的接 口 ;制造资源/能力接入管理接口应包括设备管理类接口 、边缘管理类接口和标识类接 口 ,提供工业设备 、边缘网关等云制造资源管理和标识等方面的接 口 。

　　6 接口类型

　　6. 1 概述

　　云制造服务平台开放接口主要有以下几种类型 :

　　a) 数据类 ;

　　b) 模型类 ;

　　c) 微服务类 ;

　　d) 安全类 ;

　　e) 标识类 ;

　　f) 管理类 ;

　　g) 控制类 。

　　云制造服务平台开放接口示例参见附录 A。

　　6.2 工业应用服务接口

　　6.2. 1 数据类接口

　　6.2. 1. 1 数据获取接口

　　数据获取接口应支持数据资源状态信息查询 ,典型接口定义见表 1。

　　表 1 数据获取接口定义

　　接口名称

　　数据获取接 口

　　接口说明

　　根据企业和数据资源 ID,获取数据资源的状态信息

　　接口方法

　　POST

　　参数说明

　　至少包含 :数据资源 ID(string dataRID) 、企业 ID(stringentID) 、用户 ID(string userID) 、身 份认证参数(string access_token)

　　返回值

　　返回所需要的数据资源信息 ,例如数据量 、数据更新时间 、数据权限等

　　6.2. 1.2 数据分析接口

　　数据分析接口应支持调用数据分析任务并得到数据分析结果等功能 ,典型接口定义见表 2。

　　3

　　GB/T 43960—2024

　　表 2 数据分析接口定义

　　接口名称

　　数据分析接 口

　　接口说明

　　根据数据分析任务和用户 ID获取数据分析结果

　　接口方法

　　POST

　　参数说明

　　至少包含 :企业 ID(stringentID) 、用户 ID(string userID) 、身份认证参数(string access_token) 、数据分析任务 ID(string datID)

　　返回值

　　返回数据分析结果信息

　　6.2.2 模型类接口

　　6.2.2. 1 模型注册接口

　　模型注册接口应能支持不同类型模型在平台上实现注册的功能 ,典型接口定义见表 3。

　　表 3 模型注册接口定义

　　接口名称

　　模型注册接 口

　　接口说明

　　获取新增模型注册信息

　　接口方法

　　POST

　　参数说明

　　至少包含 :用户 ID(string userID) 、身份认 证 参 数(string access_ token) 、模 型 名 称(string mo- deName) 、模型描述(string modeDes) 、模型分类(string modeClass)

　　返回值

　　返回包含是否注册成功

　　6.2.2.2 模型状态查询接口

　　模型状态查询接口应能支持不同类型模型在平台上的运行状态查询等功能 ,典型接口定义见表 4。

　　表 4 模型状态查询接口定义

　　接口名称

　　模型状态查询接 口

　　接口说明

　　获取模型运行状态数据

　　接口方法

　　GET

　　参数说明

　　至少包含 :用户 ID(string userID) 、身份认证参数(string access_ token) 、模 型 ID(string mode- ID)

　　返回值

　　返回所需模型运行状态数据

　　6.2.3 微服务类接口

　　6.2.3. 1 微服务注册接口

　　微服务注册接口应能实现平台微服务的信息发布 ,典型接口定义见表 5。

　　4

　　GB/T 43960—2024

　　表 5 微服务注册接口定义

　　接口名称

　　微服务注册接 口

　　接口说明

　　获取新增微服务定义信息

　　接口方法

　　POST

　　参数说明

　　至少包含 :用 户 ID(string userID) 、身 份 认 证 参 数(string access_ token) 、微 服 务 名 称 (string sevName) 、微服务描述(string sevDes) 、数据中心地址(string dataUrl)

　　返回值

　　返回所需微服务信息数据

　　6.2.3.2 微服务查询接口

　　微服务查询接口应能实现平台微服务的运行状态查询 ,典型接口定义见表 6。

　　表 6 微服务状态查询接口定义

　　接口名称

　　微服务状态查询接 口

　　接口说明

　　获取微服务运行状态数据

　　接口方法

　　GET

　　参数说明

　　至少包含 :用户 ID(string userID) 、身份认 证 参 数(string access_ token) 、微 服 务 ID(string mi- croserID) 、任务 ID(string taskID) 、启动微服务的用户账号(string userName)

　　返回值

　　返回所需微服务运行状态数据

　　6.2.4 应用管理类接口

　　6.2.4. 1 应用部署发布接口

　　应用部署发布接口应支持创建和发布应用 ,典型接口定义见表 7。

　　表 7 应用部署发布接口定义

　　接口名称

　　应用部署发布接 口

　　接口说明

　　创建和发布相关应用

　　接口方法

　　POST

　　参数说明

　　至少包 含 : 用 户 ID(string userID) 、身 份 认 证 参 数 ( string access_ token) 、应 用 ID(string appID) 、应用名称(string appName) 、应用版本(string appVision)

　　返回值

　　返回包含应用 ID和是否发布成功状态值

　　6.2.4.2 应用健康状态监测接口

　　应用健康状态监测接口应支持获取应用运行的状态信息 ,典型接口定义见表 8。

　　5

　　GB/T 43960—2024

　　表 8 应用健康状态监测接口定义

　　接口名称

　　应用健康状态监测接 口

　　接口说明

　　获取应用的健康状态等数据信息

　　接口方法

　　GET

　　参数说明

　　至少包含 :用户 ID(string userID) 、身份认证参数(string access_token) 、应用 ID(string appID)

　　返回值

　　返回应用是否正常运行的状态信息

　　6.2.5 应用安全类接口

　　应用安全类接口应支持应用管理用户身份认证 、获取访问权限等功能 ,典型接口定义见表 9。

　　表 9 应用安全认证接口定义

　　接口名称

　　应用安全认证接 口

　　接口说明

　　根据用户的身份认证获取应用的访问权限

　　接口方法

　　GET

　　参数说明

　　至少包含 :用户 ID(string userID) 、身份认证参数(string access_token) 、应用 ID(string appID)

　　返回值

　　返回应用的授权状态值

　　6.3 制造资源/能力接入接口

　　6.3. 1 设备数据类接口

　　6.3. 1. 1 设备状态接口

　　设备状态接口应能实现查询设备状态功能 ,包含运行 、待机 、故障 、离线四种状态 ,典型接口定义见

　　表 10。

　　表 10 设备状态接口定义

　　接口名称

　　设备状态接 口

　　接口说明

　　查询设备当前状态

　　接口方法

　　GET

　　参数说明

　　至少包含 :用户 ID(string userID) 、身份认证参数(string access_token) 、设备 ID(string devID)

　　返回值

　　返回包含是否成功

　　6.3. 1.2 设备数据接口

　　设备数据接应能实现设备运行数据采集功能 ,获取数据点列表 ,典型接口定义见表 11。

　　6

　　GB/T 43960—2024

　　表 11 设备数据接口定义

　　接口名称

　　设备数据接 口

　　接口说明

　　设备运行数据采集

　　接口方法

　　POST

　　参数说明

　　至少包含 : 用 户 ID(string userID) 、身 份 认 证 参 数(string access_ token) 、网 关 ID(string gate- wID) 、设备 ID(string devID) 、数据键值对(string devVar)

　　返回值

　　返回包含是否成功

　　6.3.2 设备控制类接口

　　设备控制接口应能实现设备控制命令下发等功能 ,典型接口定义见表 12。

　　表 12 设备控制接口定义

　　接口名称

　　设备控制接 口

　　接口说明

　　设备控制命令下发等

　　接口方法

　　POST

　　参数说明

　　至少包 含 : 用 户 ID(string userID) 、身 份 认 证 参 数 ( string access_ token) 、设 备 ID(string devID) 、指令内容(string message)

　　返回值

　　返回包含是否发送成功和执行结果

　　6.3.3 系统数据类接口

　　系统数据类接口应能够支持企业信息系统接入 ,实现云制造服务平台与接入的信息系统之间数据传输 。 系统数据类接口应包含 ERP、PLM、MES等信息系统与平台进行交互的接 口 ,典型接口定义见

　　表 13。

　　表 13 生产物料表单保存接口定义

　　接口名称

　　生产物料表单保存接 口

　　接口说明

　　平台保存信息系统中生产物料表单信息

　　接口方法

　　POST

　　参数说明

　　至少包含 :用户 ID(string userID) 、身份认证参数(string access_token) 、表单名称(stringMate- rialName)

　　返回值

　　返回包含是否成功

　　6.3.4 接入安全类接口

　　接入安全类接口用 于 对 接 入 资 源 的 身 份 进 行 鉴 权 , 包 括 设 备 安 全 认 证 接 口 等 , 典 型 接 口 定 义 见表 14。

　　7

　　GB/T 43960—2024

　　表 14 设备安全认证接口定义

　　接口名称

　　设备安全认证接 口

　　接口说明

　　对设备身份进行鉴权

　　接口方法

　　POST

　　参数说明

　　至少包 含 : 用 户 ID(string userID) 、身 份 认 证 参 数 ( string access_ token) 、设 备 ID(string devID) 、设备证书(string devSign)

　　返回值

　　返回包含是否认证成功

　　6.3.5 设备管理类接口

　　设备管理类接口应能够实现设备的创建 、查询 、分组 、编辑 、删除 、导入 、导出和设备模板管理等功能 ,典型接口定义见表 15。

　　表 15 设备查询接口定义

　　接口名称

　　设备查询接 口

　　接口说明

　　获取设备信息

　　接口方法

　　GET

　　参数说明

　　至少包含 :用户 ID(string userID) 、身份认证参数(string access_token) 、设备 ID(string devID)

　　返回值

　　返回包含是否成功

　　6.3.6 边缘管理类接口

　　边缘管理类接口应能够实现边缘网关管理 、云边协同节点管理 、边缘应用管理等功能 ,典型接口定义见表 16。

　　表 16 边缘网关创建接口定义

　　接口名称

　　边缘网关创建接 口

　　接口说明

　　创建边缘网关 ,存储网关信息

　　接口方法

　　POST

　　参数说明

　　至少包含 :用户 ID(string userID) 、身份认证参数(string access_ token) 、网关名称(string gate- wName) 、通信协议编码(string commCode) 、通 信 协 议 地 址(string commUrl) 、网 关 类 型 编 码(string iotType)

　　返回值

　　返回包含是否成功

　　6.3.7 标识类接口

　　6.3.7. 1 设备标识保存接口

　　设备标识保存接口应能够实现获取设备唯一标识编码的功能 ,典型接口定义见表 17。

　　8

　　GB/T 43960—2024

　　表 17 设备标识保存接口定义

　　接口名称

　　设备标识保存接 口

　　接口说明

　　获取设备唯一标识

　　接口方法

　　POST

　　参数说明

　　至少包 含 : 用 户 ID(string userID) 、身 份 认 证 参 数 ( string access_ token) 、设 备 ID(string devID) 、标识分 类 ID(string classifyID) 、标 识 模 板 版 本(string templateVersion) 、标 识 模 板 属性(string templateAttribute)

　　返回值

　　返回包含是否成功

　　6.3.7.2 网关标识保存接口

　　网关标识保存接口应能够实现获取网关唯一标识编码的功能 ,典型接口定义见表 18。

　　表 18 网关标识保存接口定义

　　接口名称

　　网关标识保存接 口

　　接口说明

　　获取网关唯一标识

　　接口方法

　　POST

　　参数说明

　　至少包含 : 用 户 ID(string userID) 、身 份 认 证 参 数(string access_ token) 、网 关 ID(string gate- wID) 、标识分类 ID(string classifyID) 、标 识 模 板 版 本(string templateVersion) 、标 识 模 板 属 性 (string templateAttribute)

　　返回值

　　返回包含是否成功

　　7 接口编写要求

　　7. 1 实用性

　　接口符合以下实用性要求 :

　　a) 数据格式 :应使用支持跨平台 、通用性的文件格式 ,例如 JSON、ProtoBuf等 ,也可采用 XML、 TXT作为程序开发辅助 ;

　　b) 数据量 :按需分配 。

　　7.2 易用性

　　接口符合以下易用性要求 :

　　a) 接口 、参数命名准确 :接口及参数应包含必要内容 ,易于理解 ;

　　b) 接口数据 、状态 :对于传输成功/失败的情况 ,接口应提供明确的数据状态信息及返回值 ;

　　c) 接口可扩展性 :接口应具备可扩展性 ,可支持功能调整或者扩展 。

　　7.3 安全性

　　接口符合以下安全性要求 :

　　9

　　GB/T 43960—2024

　　a) 接口安全 :应使用约定的算法 ,对传递的参数值进行验证匹配 ;

　　b) 加密规范 :在传递用户名密码时 ,应采用规范的加密算法 ,进行数据通信请求 ,推荐使用国产加密算法 ;

　　c) 接口版本控制 :应对接口进行版本控制 ,平台及软硬件升级时更新接口版本 ,宜定期处理新 、旧版本接口的状态 。

　　8 接口设计要求

　　8. 1 一般要求

　　接口设计应尽量减少参数传递 ,按请求情况进行传递 。

　　接口设计应尽量避免接口重复性,提高接口复用性,减少 HTTP请求,提高程序稳定性。

　　8.2 数据类型规范

　　设计接口时 ,应标注参数数据类型 , 以及是否可为空或者默认字段 ,设计参数数据类型应与对应返回数据类型一致 ,参数字段不匹配容易造成应用程序出现数据类型解析异常 。

　　8.3 编码规范

　　接口开发过程中 ,应标注接口编码方式 ,宜采用 UTF-8编码 。

　　8.4 请求方式

　　编写接口时应标注请求方式 ,一般有 GET、POST、PUT 和 DELETE等方式 。

　　在数量较小情况下使用 GET方式 ,数据量超过 1 024字节时应采用 POST方式 ,避免出现请求失败或者请求异常的问题 。

　　8.5 返回接口调用状态

　　所有接口都应使用统一的调用成功/失败标识信息和错误编码信息 , 以及必要的提示字段信息 。

　　8.6 安全机制

　　设计接口应使用验证签名机制 ,可支持接口安全验证 。

　　8.7 参数说明

　　接口应标注参数名称 、是否必选 、数据类型及范围 , 以及说明 “是/否 ”传递默认的参数 。

　　9 接口注册与调用要求

　　推荐使用 HTTPS协议,使用 POST和 PUT方式提交数据。

　　接口定义遵循 RFC1945(HTTP1.0)、RFC2616(HTTP1.1)、RFC0959(FTP)、RFC1866(HTML)或 RFC4627(JSON) 。

　　接口调用应进行身 份 核 实 和 权 限 校 验 , 同 时 应 记 录 接 口 调 用 信 息 , 可 正 确 解 析 接 口 调 用 的 反 馈结果 。

　　10

　　GB/T 43960—2024

　　10 数据包格式

　　10. 1 参数

　　10. 1. 1 公共参数

　　接口公共参数如表 19所示 。可采用应用授权认证接口方式 。

　　表 19 公共参数

　　参数名

　　类型

　　是否必需

　　描述

　　api_key

　　string

　　是

　　用户注册时分配到访问服务所用的密钥

　　Timestamp

　　string

　　是

　　请求的时间戳 。 日期格式按照 ISO 8601标准表示 ,应使用 UTC时间

　　format

　　string

　　否

　　返回值格式 ,支持 XML或 JSON,默认为 JSON

　　encoding

　　string

　　否

　　接口调用请求包的编码类型 ,支 持 UTF-8和 GBK, 默认为 UTF-8

　　body_sig

　　string

　　是

　　参数签名 ,应实现 body_ sig外 所 有 参 数 串 的 签 名 , 包括业务级的参数

　　10. 1.2 业务参数的通用约定

　　接口业务参数的通用约定如表 20所示 。

　　表 20 业务参数

　　参数名

　　类型

　　描述

　　page_no

　　int

　　用于支持分页的 API,表示第几页 ,默认为 1

　　page_size

　　int

　　用于支持分 页 的 API, 表 示 每 页 返 回 多 少 条 数 据 , 默 认 以 及 上 限为 25

　　device_type

　　int

　　终端类型

　　10.2 错误响应输出格式

　　错误响应输出内容应符合以下规范 :

　　返回内容应由 error_code,error_msg 2个属性组成 ,分别用于描述错误码和错误信息 。

　　10.3 错误码定义

　　接口调用过程中可返回的错误码定义如表 21所示 。

　　11

　　GB/T 43960—2024

　　表 21 错误码定义

　　ErrorCode

　　ErrorMsg

　　Description

　　200

　　Success

　　成功

　　100100

　　Error

　　接口调用失败

　　100101

　　Obtain ACCESS_TOKEN failed

　　ACCESS_TOKEN 获取失败

　　100102

　　Necessary parameter missing

　　缺少必要参数

　　100103

　　Invalid conditionalinformation

　　无满足条件信息

　　100201

　　Invalid access key

　　访问密钥不匹配

　　100202

　　InvalidACCESS_TOKEN

　　ACCESS_TOKEN 已过期或不存在

　　100203

　　Permission deny

　　无调用权限

　　100301

　　Userinformation parameterincorrect

　　用户信息参数有误

　　100302

　　APP information parameterincorrect

　　APP信息参数有误

　　100404

　　NotFound

　　无法找到请求资源

　　100501

　　APIunavailable

　　API不可用

　　100502

　　Inputparameterincorrect

　　输入参数有误或不存在

　　100505

　　Path parameterincorrect

　　路径参数有误

　　100507

　　Inputparameter missing

　　缺少输入参数

　　12

　　GB/T 43960—2024

　　附 录 A

　　(资料性)

　　云制造服务平台开放接口示例

　　A. 1 工业应用服务接口示例

　　A. 1. 1 数据获取接口示例

　　A. 1. 1. 1 数据获取接口调用传参示例

　　数据获取接口调用传参的格式示例如下 :

　　{

　　"entId": "438362206774265856",

　　"userId": "438362794917922816",

　　"access_token": "fO44R6tOWxh3wrTIkWP0",

　　"data": {

　　"dataRId": "496"

　　}

　　}

　　A. 1. 1.2 数据获取接口调用返回示例

　　调用成功返回示例如下 :

　　{

　　"status":200,

　　"datasize": " 965M ",

　　"updatetime": " 1491448161000",

　　"datarighets": " all"

　　}

　　}

　　调用失败返回示例如下 :

　　{

　　"status":100502,

　　"msg": "Inputparameter incorrect"

　　}

　　A. 1.2 模型注册接口示例

　　A. 1.2. 1 模型注册接口调用传参示例

　　模型注册调用传参的格式示例如下 :

　　13

　　GB/T 43960—2024

　　{

　　"userId": "438362794917922816",

　　"access_token": "fO44R6tOWxh3wrTIkWP0",

　　"data": {

　　"modeName": "工业机器人减速器故障诊断模型 ",

　　"modeDes": "该模型可对机器人减速器进行故障检测 ,主要采用了决策树模型 ,返回预测结果 ", "modeClass": "故障诊断 "

　　}

　　}

　　A. 1.2.2 模型注册接口调用返回示例

　　调用成功返回示例如下 :

　　{

　　"status":200,

　　"msg": " Success"

　　}

　　调用失败返回示例如下 :

　　{

　　"status":100102,

　　"msg": "Necessary parameter missing"

　　}

　　A. 1.3 微服务注册接口示例

　　A. 1.3. 1 微服务注册接口调用传参示例

　　微服务注册接口调用传参的格式示例如下 :

　　{

　　"userId": "438362794917922816",

　　"access_token": "fO44R6tOWxh3wrTIkWP0",

　　"data": {

　　"sevName": "设备接入静态数据查询服务 ",

　　"sevDes": "提供大量的基于设备接入静态数据的查询分析接 口 ,例如 :设备 日增加数量统计 、企业设备数量统计查询 、设备省份分布查询接口服务等 ",

　　"dataUrl":"http://172.16.18.71/"

　　}

　　}

　　A. 1.3.2 微服务注册接口调用返回示例

　　调用成功返回示例如下 :

　　{

　　"status":200,

　　"msg": " Success"

　　}

　　14

　　GB/T 43960—2024

　　调用失败返回示例如下 :

　　{

　　"status":100507,

　　"msg": "Inputparameter missing"

　　}

　　A. 1.4 应用部署发布接口示例

　　A. 1.4. 1 应用部署发布接口调用传参示例

　　应用部署发布接口调用传参的格式示例如下 :

　　{

　　"userId": "438362794917922816",

　　"access_token": "fO44R6tOWxh3wrTIkWP0",

　　"data": {

　　"appID": "3145256",

　　"appName": "TPM ",

　　"appVision": "V1. 3"

　　}

　　}

　　A. 1.4.2 应用部署发布接口调用返回示例

　　调用成功返回示例如下 :

　　{

　　"status":200,

　　"msg": " Success"

　　}

　　调用失败返回示例如下 :

　　{

　　"status":100302,

　　"msg": "APP information parameter incorrect"

　　}

　　A. 1.5 应用安全认证接口示例

　　A. 1.5. 1 应用安全认证接口调用传参示例

　　应用安全认证接口调用传参的格式示例如下 :

　　{

　　"userId": "438362794917922816",

　　"access_token": "fO44R6tOWxh3wrTIkWP0",

　　"data": {

　　"appID": "3145256"

　　}

　　}

　　15

　　GB/T 43960—2024

　　A. 1.5.2 应用安全认证接口调用返回示例

　　调用成功返回示例如下 :

　　{

　　"status":200,

　　"msg": " ALL"

　　}

　　调用失败返回示例如下 :

　　{

　　"status":100301,

　　"msg": "User information parameter incorrect" }

　　A.2 制造资源/能力接入接口示例A.2. 1 设备状态接口示例

　　A.2. 1. 1 设备状态接口调用传参示例

　　设备状态接口调用传参的格式示例如下 :

　　{

　　"userId": "438362794917922816",

　　"access_token": "fO44R6tOWxh3wrTIkWP0", "data": {

　　"devId": "82295865259",

　　}

　　}

　　A.2. 1.2 设备状态接口调用返回示例

　　调用成功返回示例如下 :

　　{

　　"status":200,

　　"msg": " Success",

　　"devStatus": "开机 ",

　　}

　　调用失败返回示例如下 :

　　{

　　"status":100100,

　　"msg": "Error"

　　}

　　A.2.2 设备控制接口示例

　　A.2.2. 1 设备控制接口调用传参示例

　　设备控制接口调用传参的格式示例如下 :

　　16

　　GB/T 43960—2024

　　{

　　"userId": "438362794917922816",

　　"access_token": "fO44R6tOWxh3wrTIkWP0",

　　"data": {

　　"devId": "82295865259",

　　"message: "1"

　　}

　　}

　　A.2.2.2 设备控制接口调用返回示例

　　调用成功返回示例如下 :

　　{

　　"status":200,

　　" " " "

　　msg : success ,

　　"result": " 1"

　　}

　　调用失败返回示例如下 :

　　{

　　"status":100202,

　　"msg": "InvalidACCESS_TOKEN"

　　}

　　A.2.3 生产物料表单保存接口示例

　　A.2.3. 1 生产物料表单保存接口调用传参示例

　　生产物料表单保存接口调用传参的格式示例如下 :

　　{

　　"userId": "438362794917922816",

　　"access_token": "fO44R6tOWxh3wrTIkWP0",

　　"data": {

　　"MaterialName": "identity_zone"

　　}

　　}

　　A.2.3.2 生产物料表单保存接口调用返回示例

　　调用成功返回示例如下 :

　　{

　　"status":200,

　　" " " "

　　msg : success

　　}

　　调用失败返回示例如下 :

　　17

　　GB/T 43960—2024

　　{

　　"status":100100,

　　"msg": "Error"

　　}

　　A.2.4 设备安全认证接口示例

　　A.2.4. 1 设备安全认证接口调用传参示例

　　设备安全认证接口调用传参的格式示例如下 : {

　　"userId": "438362794917922816",

　　"access_token": "fO44R6tOWxh3wrTIkWP0", "data": {

　　"devId": "6565818958",

　　"devSign": "02357. PDF"

　　}

　　}

　　A.2.4.2 设备安全认证接口调用返回示例

　　调用成功返回示例如下 :

　　{

　　"status":200,

　　" " " "

　　msg : success

　　}

　　调用失败返回示例如下 :

　　{

　　"status":100100,

　　"msg": "Error"

　　}

　　A.2.5 设备查询接口示例

　　A.2.5. 1 设备查询接口调用传参示例

　　设备/产品查询接口调用传参的格式示例如下 : {

　　"userId": "438362794917922816",

　　"access_token": "fO44R6tOWxh3wrTIkWP0", "data": {

　　"devId": "285863325"

　　}

　　}

　　A.2.5.2 设备查询接口调用返回示例

　　调用成功返回示例如下 :

　　18

　　GB/T 43960—2024

　　{

　　"status":200,

　　" " " "

　　msg : success

　　"devName": "华数机器人 ",

　　"devGroup": " 1#产线 ",

　　"devAdd": "中国北京市石景山区航天云网大厦 "

　　}

　　调用失败返回示例如下 :

　　{

　　"status":100100,

　　"msg": "Error"

　　}

　　A.2.6 边缘网关创建接口示例

　　A.2.6. 1 边缘网关创建接口调用传参示例

　　边缘网关创建接口调用传参的格式示例如下 :

　　{

　　"userId": "438362794917922816",

　　"access_token": "fO44R6tOWxh3wrTIkWP0",

　　"data": {

　　"gatewName": "数据采集网关 ",

　　"commCode": "70",

　　"commUrl": "MQTT",

　　"iotType": "701"

　　}

　　}

　　A.2.6.2 边缘网关创建接口调用返回示例

　　调用成功返回示例如下 :

　　{

　　"status":200,

　　" " " "

　　msg : success

　　}

　　调用失败返回示例如下 :

　　{

　　"status":100100,

　　"msg": "Error"

　　}

　　A.2.7 设备标识保存接口示例

　　A.2.7. 1 设备标识保存接口调用传参示例

　　设备标识保存接口调用传参的格式示例如下 :

　　19

　　GB/T 43960—2024

　　{

　　"userId": "438362794917922816",

　　"access_token": "fO44R6tOWxh3wrTIkWP0", "data": {

　　"devId": "82826642265",

　　"templateVersion": "工业设备 ",

　　"templateAttribute": [

　　{

　　"data": {

　　"format": "string",

　　"value": "工业机器人 "

　　} ,

　　"index": "2000",

　　"type": "deviceName"

　　}

　　]

　　}

　　}

　　A.2.7.2 设备标识保存接口调用返回示例

　　调用成功返回示例如下 :

　　{

　　"status":200,

　　" " " "

　　msg : success

　　}

　　调用失败返回示例如下 :

　　{

　　"status":100100,

　　"msg": "Error"

　　}

　　20