YD T 3844-2021 工业互联网平台 应用管理接口要求.pdf

《YD T 3844-2021 工业互联网平台 应用管理接口要求.pdf》由会员分享，可在线阅读，更多相关《YD T 3844-2021 工业互联网平台 应用管理接口要求.pdf（20页珍藏版）》请在麦多课文档分享上搜索。

1、ICS 33.030 M 21 YD 中 华 人 民 共 和 国 通 信 行 业 标 准 YD/T XXXXXXXXX 工业互联网平台 应用管理接口要求 Application management requirements for interface of industrial Internet - XX - XX 发布 XXXX - XX - XX 实施 中 华 人 民 共 和 国 工 业 和 信 息 化 部 发 布 YD/T XXXXXXXXX I 目 次 前 言 .II 1 范围 .1 2 定义和缩略语 .1 2.1 定义 .1 2.2 缩略语 .1 3 工业互联网平台接口模型 .1

2、4 应用管理接口 .2 4.1 接口组成 .2 4.2 功能说明 .3 5 接口定义 .4 5.1 部署发布类 .4 5.2 持续迭代类 .8 5.3 监控管理类 .9 5.4 中间件接入类 .11 6 接口要求 .13 7 安全要求 .13 8 应用接入流程 .13 附 录 A（资料性附录）应用创建接口示例说明 .16 参考文献 .17 YD/T XXXXXXXXX II 前 言 本标准是工业互联网平台系列标准之一，本系列标准预计的结构如下： 工业互联网平台 功能架构 工业互联网平台 应用管理接口要求 工业互联网平台 数据管理服务要求 工业互联网平台 工业知识图谱构建通用技术要求 工业互联网

3、平台 制造企业数据质量治理通用技术要求 工业互联网平台 微服务架构 工业互联网平台 应用系统部署和数据迁移要求 工业互联网平台 应用互通技术要求 工业互联网平台 支持移动服务技术要求 工业互联网平台 平台测试方法 工业互联网平台 服务度量计价 工业互联网平台 运行保障管理要求 本标准按照 GB/T1.1-2009 给出的规则起草。 请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。 本标准由中国通信标准化协会提出并归口。 本标准起草单位：中国信息通信研究院、航天云网科技发展有限责任公司、阿里云计算有限公司 、 海尔集团公司 、 三一集团有限公司 、 树根互联技术有限

4、公司 、 中兴通讯股份有限公司 、 中国电信集团有 限公司、浙江中控技术股份有限公司、中国移动通信集团有限公司、陕西法士特齿轮有限责任公司。 本标准主要起草人 ： 黄颖、沈彬、李海花、柴旭东、邹萍、姜海森、于文涛、刘松、郑王力、李俊 平、陈录城、张维杰、孙能林、贺东东、王锦霞、文博武、张茂森、邵伟翔、林兆骥、张博山、高峰 、 张东、杨震、李洁、叶锦宇、俞文光、陈维、刘琨、杜孟新、严鉴铂、赵艳文、雷博、寇植达。 YD/T XXXXXXXXX 1 工业互联网平台 应用管理接口要求 1 范围 本标准规定了工业互联网平台接口模型及应用管理接口的要求 ， 包含接口组成 、 接口功 能说明、接口定义、接口

5、要求、安全要求及应用基于接口的接入流程。 本标准适用于应用开发人员及运维人员 ， 可通过接口在工业互联网平台上快速构建 、 部 署、管理工业应用。 2 定义 和缩略语 下列术语、定义和缩略语适用于本文件。 2.1 定义 应用全生命周期管理 Application lifecycle management 包含应用从创建、运行到销毁的全过程管理。 2.2 缩略语 API Application Programming Interface 应用程序编程接口 3 工业互联网平台接口模型 工业互联网平台接口是指基于平台进行应用开发、应用运行及设备 /产品 /系统接入的 API。 工业互联网平台接口模型

6、如图 1 所示： YD/T XXXXXXXXX 2 图 1 工业互联网平台接口模型 工业互联网平台接口应包含模型类、数据类、服务类、应用管理类、安全类、标识类 、 事件类、运行类、控制类，其中应用管理接口是工业互联网平台接口模型的一部分。 4 应用管理接口 4.1 接口组成 应用管理接口是对 YD/T XXXX工业互联网平台 功能架构 中的运行环境功能进行提 取，形成接口， 如图 2 所示： 图 2 应用管理接口与通用功能架构关系 平 台 层 工 业 系 统 工 业 设 备 工 业 产 品 运 行 类 控 制 类 设 备 /产 品 标 识 数 据 采 集 点 标 识 网 关 标 识 设 备 /

7、产 品 状 态 类 设 备 /产 品 运 行 类 设 备 /产 品 能 耗 类 消 息 事 件 类 报 警 事 件 类 状 态 控 制 类 事 件 控 制 类 工 业 APP 工 业应 用 接 入接 口 层 流 程 定 义 类 流 程 运 行 类 流 程 监 控 类 仿 真 定 义 类 仿 真 运 行 类 仿 真 监 控 类 统 一 消 息 类 数 据 存 储 类 数 据 分 析 类 部 署 发 布 类 监 控 管 理 类 中 间 件 接 入 类 持 续 迭 代 类 服 务 注 册 类 人 工 智 能 类 服 务 监 控 类 流 程 模 型 仿 真 模 型 统 一 缓 存 类 统 一 搜 索

8、类 服 务 编 排 类 服 务 治 理 类 数 据 获 取 类 身 份 认 证 类 密 钥 管 理 类 访 问 控 制 类 权 限 管 理 类 数 据 加 解 密 类 安 全 类 设 备 /产 品 认 证 类 数 据 处 理 类 . . 模 型 类 数 据 类 服 务 类 应 用 管 理 类 安 全 类 标 识 类 事 件 类设 备 /产 品 / 服 务接 入 接 口层 工业 通信 网络 工业 安全 防护 应 用 层（ 工 业 APP） 智 能 化 生 产 网 络 化 协 同 个 性 化 定 制 服 务 化 延 伸 平 台 层（ 工 业 PaaS） 工业 运行 支撑 环境 运 行环 境 开 发

9、环 境 服 务管 理 服 务注 册 . 开 发 工 具（ 建 模 工 具 、 开 发 模 型 、 组 态 工 具 等 ） 工 业 微 服 务 组 件 库（ 工 业 知 识 组 件 、 算 法 组 件 、 原 理 模 型 组 件 等 ） 工 业 大 数 据 系 统（ 工 业 数 据 管 理 、 工 业 数 据 服 务 等 ） 通 用 PaaS平 台 资 源 部 署 和 管 理（ Cloud Foundry、 Docker、 Kubernetes、 微 服 务 框 架 等 ） 基 础 设 施 层（ IaaS） 接 入 层 云 基 础 设 施 （ 资 源 管 理 、 服 务 管 理 等 ） 接 入

10、管 理 数 据 采 集 YD/T XXXXXXXXX 3 应用管理类接口应提供应用运行环境 、 中间件管理 、 运维管理功能 ， 主要包含部署发布 类、持续迭代类、中间件接入类、监控管理类等接口类型， 组成如图 3 所示： 图 3 应用管理类接口模型 4.2 功能说明 4.2.1 部署发布类 部署发布类（ D）接口主要负责应用的上传、启动、停止、销毁、服务绑定、域名绑定 功能。 部署发布类（ D） 至少包含 ： 应用创建、 应用上传、服务绑定、服务解绑定、应用启动 、 应用实例数设置 、 应用动态伸缩设置 、 应用停止 、 获取域名详情 、 绑定域名 、 解绑域名 、 应 用销毁等接口。 4.

11、2.2 持迭迭代类 持续迭代类（ C）接口主要负责版本库创建、代码版本创建、代码上传与下载功能。 持续迭代类（ C）至少包含：版本库创建、代码上传、代码下载、获取代码分支、持续 迭代设置、创建版本等接口。 4.2.3 中间件接入类 中间件接入类（ M1）接口主要负责标准化的中间件服务接入、服务实例创建与销毁、 服务实例配置与监控管理功能， 中间件服务至少应包含 ： 数据库服务、大数据服务、消息与 缓存服务等。 中间件接入类（ M1）至少包含：服务接入、创建服务实例、服务实例配置、获取环境 变量、删除服务实例、获取服务实例状态等接口。 4.2.4 监控管理类 工 业 APP 应 用 管 理 接

12、口 部 署 发 布 类 （ D） 部 署 发 布 销 毁 域 名 服 务 运 行 管 理 持 续 迭 代 类 （ C） 持 续 迭 代 代 码 版 本 库 运 行 环 境 监 控 管 理 类 （ M2） 流 量 访 问 量 CPU 内 存 健 康 检 查 报 警 设 置 中 间 件 接 入 类 （ M1） 中 间 件 接 入 中 间 件 管 理 中 间 件 管 理 运 维 管 理 中 间 件 监 控 YD/T XXXXXXXXX 4 监控管理 类 （ M2） 接口主要负责 CPU 资源监控 、 内存资源 、 应用流量与调用监控功能 。 监控管理类（ M2）至少包含：查看应用流量、查看应用访问量

13、、 查看应用 CPU、查看 应用内存、监控报警设置等接口。 5 接口定义 5.1 部署发布类 应用部署发布类（ D）接口实现应用发布、测试、部署、销毁的全生命周期管理，实现 应用与服务的绑定、应用与域名的绑定。主要接口如下。 5.1.1 应用创建接口 服务名称（ 或 URL） 应用创建接口 服务说明 在工业互联网平台创建新的应用 接口方法 POST 参数说明 至少包含 ： 应用名称 、 应用类型 、 运行环境类型 、 应用域名 、 图标 、 应用描述 返回值 包含：是否成功，应用基本信息（包括应用唯一标识，数据库表 主键） 备注 无 5.1.2 应用上传接口 服务名称（ 或 URL） 应用上传

14、接口 服务说明 上传应用文件并关联到工业互联网平台指定应用 接口方法 POST 参数说明 至少包括：应用唯一标识（来源： 应用创建接口 ），上传应用文 件 返回值 包含： 是否成功，应用文件信息 备注 无 5.1.3 应用启动接口 服务名称（ 或 URL） 应用启动接口 服务说明 实现应用在平台上的启动操作 YD/T XXXXXXXXX 5 接口方法 POST 参数说明 至少包含：应用唯一标识 （来源： 应用创建接口 ） 返回值 包含：是否成功 备注 无 5.1.4 应用实例数设置接口 服务名称（ 或 URL） 应用实例数设置接口 服务说明 实现应用实例数设置，实例的增加、减少等。 接口方法

15、POST 参数说明 至少包含：应用唯一标识 （来源： 应用创建接口 ） ，应用内存 返回值 包含：是否成功 备注 无 5.1.5 应用动态伸缩设置接口 服务名称（ 或 URL） 应用动态伸缩设置接口 服务说明 实现应用实例动态扩容，包括内存，实例数。 接口方法 PUT 参数说明 至少包含：应用唯一标识 （来源： 应用创建接口 ） ，实例数、扩 展类型、扩展值 返回值 包含：是否成功 备注 无 5.1.6 应用停止接口 服务名称（ 或 URL） 应用停止接口 服务说明 实现应用停止操作。 接口方法 POST 参数说明 至少包含：应用唯一标识 （来源： 应用创建接口 ） 返回值 包含：是否成功 备

16、注 无 5.1.7 应用销毁接口 服务名称（ 或 URL） 应用销毁接口 YD/T XXXXXXXXX 6 服务说明 销毁指定应用 。 接口方法 DELETE 参数说明 至少包含：应用唯一标识 （来源： 应用创建接口 ） 返回值 包含：是否成功 备注 无 5.1.8 应用配置导入接口 服务名称（ 或 URL） 应用配置导入接口 服务说明 导入应用的配置项 。 接口方法 POST 参数说明 至少包含 ： 应用唯一标识 （ 来源 ： 应用创建接口 ） 、配置项（ JSON 或 XML 格式） 返回值 包含：是否成功 备注 无 5.1.9 应用配置导出接口 服务名称（ 或 URL） 应用配置导出接口

17、 服务说明 导出应用的配置项 。 接口方法 GET 参数说明 至少包含：应用唯一标识 （来源： 应用创建接口 ） 返回值 包含：是否成功、配置项信息 备注 无 5.1.10 服务绑定接口 服务名称（ 或 URL） 服务绑定接口 服务说明 实现应用与中间件服务绑定 接口方法 POST 参数说明 至少包含：应用唯一标识 （来源： 应用创建接口 ） 、服务唯一标 识（来源：创建服务接口） 返回值 包含：是否成功 备注 无 YD/T XXXXXXXXX 7 5.1.11 服务解绑定接口 服务名称（ 或 URL） 服务解绑定接口 服务说明 实现应用与中间件服务解绑 接口方法 DELETE 参数说明 至少

18、包含：应用唯一标识 （来源： 应用创建接口 ） 、中间件服务 唯一标识 返回值 包含：是否成功 备注 无 5.1.12 域名详情接口 服务名称（ 或 URL） 域名详情接口 服务说明 获取租户的域名列表。 接口方法 GET 参数说明 至少包含：租户唯一标识 返回值 包含：是否成功，域名列表 备注 无 5.1.13 绑定域名接口 服务名称（ 或 URL） 绑定域名接口 服务说明 实现域名与备案的绑定。 接口方法 POST 参数说明 至少包含：域名、备案号 返回值 包含：是否成功 备注 无 5.1.14 解绑域名接口 服务名称（ 或 URL） 解绑域名接口 服务说明 实现应用与域名的解绑。 接口方

19、法 DELETE 参数说明 至少包含：应用唯一标识 （来源： 应用创建接口 ） ，域名唯一标 识 （来源： 域名详情接口 ） YD/T XXXXXXXXX 8 返回值 包含：是否成功 备注 无 5.2 持续迭代类 持续迭代类 （ C） 接口支持应用版本库的管理 、 应用版本管理及应用代码的上传与下载 。 主要接口如下： 5.2.1 版本库创建接口 服务名称（ 或 URL） 版本库创建接口 服务说明 支持应用代码的托管申请，应用代码的提交和下载。 接口方法 POST 参数说明 至少包含：应用唯一标识 （来源： 应用创建接口 ） 、版本号 返回值 包含：是否成功、版本唯一标识 备注 无 5.2.2

20、 上传代码接口 服务名称（ 或 URL） 上传代码接口 服务说明 上传代码包。 接口方法 POST 参数说明 至少包含：文件流 返回值 包含：是否成功 备注 无 5.2.3 下载代码接口 服务名称（ 或 URL） 下载代码接口 服务说明 实现下载版本代码包。 接口方法 GET 参数说明 至少包含：版本唯一标识 （来源： 版本库创建接口 ） 返回值 包含：是否成功 备注 无 5.2.4 获取代码分支接口 YD/T XXXXXXXXX 9 服务名称（ 或 URL） 持续集成设置接口 服务说明 实现支持应用获取代码库 GIT 分支。 接口方法 GET 参数说明 至少包含：凭证标识（来源： GIT）、

21、 GIT 地址 返回值 包含：是否成功、版本分支列表 备注 无 5.2.5 持续迭代设置接口 服务名称（ 或 URL） 持续迭代设置接口 服务说明 实现代码的持续迭代功能。 接口方法 POST 参数说明 至少包含：应用唯一标识（来源：应用创建接口）、凭证唯标识 （来源： GIT）、 GIT 地址、构建类型 返回值 包含：是否成功 备注 无 5.2.6 创建版本接口 服务名称（ 或 URL） 创建版本接口 服务说明 实现应用版本的创建。 接口方法 POST 参数说明 至少包含：应用唯一标识（来源：应用创建接口） 返回值 包含：是否成功 备注 无 5.3 监控管理类 监控管理类（ M2）接口支持应

22、用运行状态的获取，包括应用访问的流量、应用运行的 内存、 CPU 等资源使用量、应用运行的事件报警等。主要接口如下： 5.3.1 查看应用流量接口 服务名称（ 或 URL） 查看应用流量接口 YD/T XXXXXXXXX 10 服务说明 实现应用网络流量的监控。 接口方法 GET 参数说明 至少包含：应用唯一标识（来源：应用创建接口） 返回值 包含：是否成功 备注 无 5.3.2 查看应用访问量接口 服务名称（ 或 URL） 查看应用访问量接口 服务说明 实现应用用户访问量的监控。 接口方法 GET 参数说明 至少包含 ： 应用唯一标识（ 来源 ： 应用创建接口 ） 、统计分类（天 、 小时）

23、 返回值 包含：是否成功，按统计分类的数据 备注 无 5.3.3 查看应用 CPU 接口 服务名称（ 或 URL） 查看应用 CPU 接口 服务说明 实现应用 CPU 资源占用监控。 接口方法 GET 参数说明 至少包含 ： 应用唯一标识（ 来源 ： 应用创建接口 ） 、统计分类（天 、 小时） 返回值 包含：是否成功，按统计分类的数据 备注 无 5.3.4 查看应用内存接口 服务名称（ 或 URL） 查看应用内存接口 服务说明 实现应用内存资源占用监控。 接口方法 GET 参数说明 至少包含 ： 应用唯一标识（ 来源 ： 应用创建接口 ） 、统计分类（天 、 小时） 返回值 包含：是否成功，

24、按统计分类的数据 YD/T XXXXXXXXX 11 备注 无 5.3.5 监控报警设置接口 服务名称（ 或 URL） 监控报警设置接口 服务说明 通过设置报警，实现应用的自动启停。 接口方法 POST 参数说明 至少包含：应用唯一标识（来源：应用创建接口） 返回值 包含：是否成功，应用启停状态表 备注 无 5.4 中间件接入类 中间件接入类（ M1）接口支持应用运行所需的中间件服务的申请和释放、支持应用运 行所需的中间件服务的绑定和解绑定。主要接口如下： 5.4.1 服务接入接口 服务名称（ 或 URL） 服务接入接口 服务说明 支持中间件服务接入。 接口方法 POST 参数说明 至少包含：

25、组织唯一标识（来源：应用创建接口）、服务名 返回值 包含：是否成功 备注 无 5.4.2 创建服务接口 服务名称（ 或 URL） 创建服务接口 服务说明 实现服务实例的创建。 接口方法 POST 参数说明 至少包含：租户唯一标识、服务名 返回值 包含：是否成功、服务唯一标识 备注 无 5.4.3 服务配置接口 服务名称（ 或 URL） 服务配置接口 YD/T XXXXXXXXX 12 服务说明 实现服务实例的配置、扩容。 接口方法 POST 参数说明 至少包含：服务唯一标识（来源：创建服务接口） 返回值 包含：是否成功 备注 无 5.4.4 获取环境变量接口 服务名称（ 或 URL） 获取环境

26、变量接口 服务说明 实现服务的信息。 接口方法 GETPOST 参数说明 至少包含：应用唯一标识（来源：应用创建接口）、服务唯一标 识（来源：创建服务接口） 返回值 包含：是否成功，服务地址、端口等信息 备注 无 5.4.5 删除服务接口 服务名称（ 或 URL） 删除服务接口 服务说明 实现服务的删除。 接口方法 DELETE 参数说明 至少包含：服务唯一标识（来源：创建服务接口） 返回值 包含：是否成功 备注 无 5.4.6 服务运行状态接口 服务名称（ 或 URL） 服务运行状态接口 服务说明 获取服务实例的实时运行状态信息。 接口方法 GET 参数说明 至少包含：服务唯一标识（来源：创

27、建服务接口） 返回值 包含：是否成功，服务名、服务地址、端口、 CPU、内存等信息 。 备注 无 YD/T XXXXXXXXX 13 6 接口要求 工业互联网平台应用管理接口要求一般包括： a) URL 地址： URL 中必须包括版本及通信协议 b) 输入参数： 以 JSON 或 XML 字符串的方式传输 c) 请求方式 ： 支持 create、 Retrieve、 Update、 Delete 四种操作。 采用 HTTP/HTTPS 协 议时对应绑定到 POST、 GET、 PUT 和 DELETE 方法 d) 返回值： 定义返回值类型 JSON 或 XML 格式 e) 授权证书：用户接入接

28、口的授权码 f) 通信协议：接口应 支持 HTTP/HTTPS 协议。 7 安全要求 接口安全性设计应满足以下要求： a) 接口参数应加密 b) 接口应具备时效性验证 c) 接口参数中应包含密钥 d) 接口协议建议使用 HTTPS 8 应用接入流程 本章主要介绍使用应用管理接口进行应用接入的流程， 如图 4 所示。 YD/T XXXXXXXXX 14 图 4 应用接入及接口调用流程 应用接入涉及的四种角色说明： 应用开发者：负责在本地开发应用程序、打包生成程序包等。 应用运维者 ： 通过调用应用创建接口、应用上传接口、应用启动接口等完成应用的 创建 、 启动和停止 ， 应用部署过程中通过调用服

29、务绑定接口将程序包与中间件进行 绑定 (如需使用中间件 )， 上传代码及生成 APP 等操作。 应用服务管理者 ： 通过调用创建服务接口 、 服务接入接口等完成中间件服务的接入 、 服务申请的创建和服务的绑定等操作，并可对已有服务的运行状态进行监控。 应用监管者 ： 通过调用应用流量接口、应用访问量接口、 CPU 接口、内存接口等完 成应用的网络流量 、 访问用户量 、 CPU 运行状态 、 内存的资源占用情况和应用健康 应 用 接 入 及 接 口 调 用 流 程 应用运维 者 应用开发 者 应用服务 管理者 应用监管 者 开 始 结 束生 成 程 序 包 创 建 应 用 本 地 开 发 应

30、用 是 否 使 用 中 间 件 本 地 打 包 调 用 D类 ： 应 用 创 建 接 口 否 上 传 代 码 程 序 包 与 中 间 件 绑 定 调 用 M1类 ： 服 务 绑 定 接 口 调 用 D类 ： 应 用 上 传 接 口 启 动 应 用 生 成 AP调 用 D类 ： 应 用 启 动 接 口 中 间 件 接 入 中 间 件 申 请 应 用 与 中 间 件 绑 定 中 间 件 监 控 结 束 无 调 用 M1类 ： 创 建 服 务 接 口 是 否 有 中 间 件 调 用 M1类 ：服 务 接 入 接 口 有 持 续 迭 代 停 止 应 用 调 用 D类 ： 应 用 上 传 接 口 调 用

31、 C类 ： 版 本 库 创 建 接 口 结 束 调 用 M2类 ：查 看 应 用 流 量 接 口查 看 应 用 访 问 量 接 口 查 看 应 用 CPU接 口查 看 应 用 内 存 接 口监 控 报 警 设 置 接 口 结 束流 量 访 问 量 CPU健 康 检 查 内 存报 警 设 置 1 2 3 4 5 YD/T XXXXXXXXX 15 情况等，并可对应用的监控报警进行设置，实现应用的自动启停。 应用接入过程的操作步骤说明： a) 开发人员在本地使用开发工具开发应用程序，生成可部署的程序包； b) 运维人员根据开发人员提供的程序包 ， 进行应用创建 、 域名绑定及中间件服务申请等操 作

32、，完成应用创建； c) 服务管理人员完成中间件服务的创建并与应用进行绑定 ， 管理中间件服务的接入 ， 同时 监控中间件服务； d) 运维人员完成程序包与中间件绑定，上传应用程序代码，启动生成应用 APP，并对代码 进行持续迭代部署； e) 应用接入完成后，监管人员可调用应用监管类接口查看及监测应用的运行情况。 YD/T XXXXXXXXX 16 附 录 A （资料性附录） 应用创建接口示例说明 接口示例见表 A.1。 表 A.1 应用创建接口示例说明 应用创建接口 在工业互联网平台创建新的应用 接口描述 参数： 应用名称、应用类型、运行环境类型、应用域名、图标、应用描述 URL /creat

33、eApp 请求方式 POST 请求类型 application/json 返回类型 application/json;charset=UTF-8 参数名 数据类型 是否必填 说明 appName string Y 应用名称 appType string Y 应用类型 envType string Y 应用语言环境（ java、 php、 go 等） demain string Y 访问应用的域名 appIcon file N 应用图标 appDesc string N 应用描述 状态码 描述 说明 200 OK 401 Unauthorized 403 Forbidden 404 Not Found 返回值 appId 应用唯一标识 YD/T XXXXXXXXX 17 参考文献 1 工业互联网产业联盟标准 工业互联网平台 接口模型 _