工业互联网平台应用管理接口规范.docx
- 文档编号:25482143
- 上传时间:2023-06-09
- 格式:DOCX
- 页数:16
- 大小:184.13KB
工业互联网平台应用管理接口规范.docx
《工业互联网平台应用管理接口规范.docx》由会员分享,可在线阅读,更多相关《工业互联网平台应用管理接口规范.docx(16页珍藏版)》请在冰豆网上搜索。
工业互联网平台应用管理接口规范
工业互联网产业联盟标准
工业互联网平台应用管理接口规范
ApplicationManagementInterfaceRequirementsforIndustrialInternetPlatform
工业互联网平台应用管理接口要求
1范围
本标准规定了工业互联网平台中应用管理接口的要求,包含接口组成、接口功能说明、接口详细定义及应用基于接口的接入流程。
本标准适用于通过接口在工业互联网平台上快速构建、灵活部署工业应用。
2规范性引用文件
下列文件对于本文件的应用是必不可少的。
凡是注日期的引用文件,仅所注日期的版本适用于本文件。
凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
《工业互联网平台接口模型》
3术语和定义
3.1术语和定义
下列术语和定义适用于本标准。
3.1.1
应用全生命周期管理Applicationlifecyclemanagement
包含应用从创建、运行到销毁的全过程管理。
4应用管理接口
4.1接口组成
应用管理类接口应提供应用运行环境、中间件管理、运维管理功能,主要包
含部署发布类、持续迭代类、中间件接入类、监控管理类等接口类型,组成如图
1所示:
图1应用管理类接口模型
4.2接口功能说明
4.2.1部署发布类
部署发布类接口主要负责应用的上传、启动、停止、销毁、服务绑定、域名绑定功能。
部署发布类至少包含:
应用创建、应用上传、服务绑定、服务解绑定、应用启动、应用实例数设置、应用动态伸缩设置、应用停止、获取域名详情、绑定域名、解绑域名、应用销毁等接口。
4.2.2持迭迭代类
持续迭代类接口主要负责版本库创建、代码版本创建、代码上传与下载功能。
持续迭代类至少包含:
版本库创建、代码上传、代码下载、获取代码分支、
持续迭代设置、创建版本等接口。
4.2.3中间件接入类
中间件接入类接口主要负责标准化的中间件服务接入、服务实例创建与销毁、服务实例配置与监控管理功能,中间件服务至少应包含:
数据库服务、大数据服务、消息与缓存服务等。
中间件接入类至少包含:
服务接入、创建服务实例、服务实例配置、获取环境变量、删除服务实例、获取服务实例状态等接口。
4.2.4监控管理类
监控管理类接口主要负责CPU资源监控、内存资源、应用流量与调用监控功能。
监控管理类至少包含:
查看应用流量、查看应用访问量、查看应用CPU、查看应用内存、监控报警设置等接口。
5接口定义
5.1部署发布类
应用部署发布类接口实现应用发布、测试、部署、销毁的全生命周期管理,实现应用与服务的绑定、应用与域名的绑定。
主要接口如下:
(1)应用创建接口
服务名称(或URL)
应用创建接口
服务说明
在工业互联网平台创建新的应用
接口方法
POST
参数说明
至少包含:
应用名称、应用类型、运行环境类型、应用域
名
返回值
包含:
是否成功,应用基本信息(包括应用唯一标识)
备注
无
(2)应用上传接口
服务名称(或URL)
应用上传接口
服务说明
上传应用文件并关联到工业互联网平台指定应用
接口方法
POST
参数说明
至少包括:
应用唯一标识,上传应用文件
返回值
包含:
是否成功,应用文件信息
备注
无
(3)应用启动接口
服务名称(或URL)
应用启动接口
服务说明
实现应用在平台上的启动操作
接口方法
POST
参数说明
至少包含:
应用唯一标识
返回值
包含:
是否成功
备注
无
(4)应用实例数设置接口
服务名称(或URL)
应用实例数设置接口
服务说明
实现应用实例数设置,实例的增加、减少等。
接口方法
POST
参数说明
至少包含:
应用唯一标识,应用内存
返回值
包含:
是否成功
备注
无
(5)应用动态伸缩设置接口
服务名称(或URL)
应用动态伸缩设置接口
服务说明
实现应用实例动态扩容,包括内存,实例数。
接口方法
PUT
参数说明
至少包含:
应用唯一标识,实例数、扩展类型、扩展值
返回值
包含:
是否成功
备注
无
(6)应用停止接口
服务名称(或URL)
应用停止接口
服务说明
实现应用停止操作。
接口方法
POST
参数说明
至少包含:
应用唯一标识
返回值
包含:
是否成功
备注
无
(7)应用销毁接口
服务名称(或URL)
应用销毁接口
服务说明
销毁指定应用。
接口方法
DELETE
参数说明
至少包含:
应用唯一标识
返回值
包含:
是否成功
备注
无
(8)服务绑定接口
服务名称(或URL)
服务绑定接口
服务说明
实现应用与中间件服务绑定
接口方法
POST
参数说明
至少包含:
应用唯一标识、中间件服务唯一标识
返回值
包含:
是否成功
备注
无
(9)服务解绑定接口:
支持解绑中间件服务:
服务名称(或URL)
服务解绑定接口
服务说明
实现应用与中间件服务解绑
接口方法
DELETE
参数说明
至少包含:
应用唯一标识、中间件服务唯一标识
返回值
包含:
是否成功
备注
无
(10)域名详情接口
服务名称(或URL)
域名详情接口
服务说明
获取租户的域名列表。
接口方法
GET
参数说明
至少包含:
租户唯一标识
返回值
包含:
是否成功,域名列表
备注
无
(11)绑定域名接口
服务名称(或URL)
绑定域名接口
服务说明
实现域名与备案的绑定。
接口方法
POST
参数说明
至少包含:
域名、备案号
返回值
包含:
是否成功
备注
无
(12)解绑域名接口
服务名称(或URL)
解绑域名接口
服务说明
实现应用与域名的解绑。
接口方法
DELETE
参数说明
至少包含:
应用唯一标识,域名唯一标识
返回值
包含:
是否成功
备注
无
5.2持续迭代类
持续迭代类接口支持应用版本库的管理、应用版本管理及应用代码的上传与下载。
主要接口如下:
(1)版本库创建接口
服务名称(或URL)
版本库创建接口
服务说明
支持应用代码的托管申请,应用代码的提交和下载。
接口方法
POST
参数说明
至少包含:
应用唯一标识、版本号
返回值
包含:
是否成功
备注
无
(2)上传代码接口
服务名称(或URL)
上传代码接口
服务说明
上传代码包。
接口方法
POST
参数说明
至少包含:
文件流
返回值
包含:
是否成功
备注
无
(3)下载代码接口
服务名称(或URL)
下载代码接口
服务说明
实现下载版本代码包。
接口方法
GET
参数说明
至少包含:
版本唯一标识
返回值
包含:
是否成功
备注
无
(4)获取代码分支接口
服务名称(或URL)
持续集成设置接口
服务说明
实现支持应用获取代码库GIT分支。
接口方法
GET
参数说明
至少包含:
凭证唯一标识、GIT地址
返回值
包含:
是否成功、版本分支列表
备注
无
(5)持续迭代设置接口
服务名称(或URL)
持续迭代设置接口
服务说明
实现代码的持续迭代功能。
接口方法
POST
参数说明
至少包含:
应用唯一标识、凭证唯一标识、GIT地址、构
建类型
返回值
包含:
是否成功
备注
无
(6)创建版本接口
服务名称(或URL)
创建版本接口
服务说明
实现应用版本的创建。
接口方法
POST
参数说明
至少包含:
应用唯一标识
返回值
包含:
是否成功
备注
无
5.3监控管理类
监控管理类接口支持应用运行状态的获取,包括应用访问的流量、应用运行
的内存、CPU等资源使用量、应用运行的事件报警等。
主要接口如下:
(1)查看应用流量接口
服务名称(或URL)
查看应用流量接口
服务说明
实现应用网络流量的监控。
接口方法
GET
参数说明
至少包含:
应用唯一标识
返回值
包含:
是否成功
备注
无
(2)查看应用访问量接口
服务名称(或URL)
查看应用访问量接口
服务说明
实现应用用户访问量的监控。
接口方法
GET
参数说明
至少包含:
应用唯一标识、统计分类(天、小时)
返回值
包含:
是否成功,按统计分类的数据
备注
无
(3)查看应用CPU接口
服务名称(或URL)
查看应用CPU接口
服务说明
实现应用CPU资源占用监控。
接口方法
GET
参数说明
至少包含:
应用唯一标识、统计分类(天、小时)
返回值
包含:
是否成功,按统计分类的数据
备注
无
(4)查看应用内存接口
服务名称(或URL)
查看应用内存接口
服务说明
实现应用内存资源占用监控。
接口方法
GET
参数说明
至少包含:
应用唯一标识、统计分类(天、小时)
返回值
包含:
是否成功,按统计分类的数据
备注
无
(5)监控报警设置接口
服务名称(或URL)
监控报警设置接口
服务说明
通过设置报警,实现应用的自动启停。
接口方法
POST
参数说明
至少包含:
应用唯一标识
返回值
包含:
是否成功,应用启停状态表
备注
无
5.4中间件接入类
中间件接入类接口支持应用运行所需的中间件服务的申请和释放、支持应用运行所需的中间件服务的绑定和解绑定。
主要接口如下:
(1)服务接入接口
服务名称(或URL)
服务接入接口
服务说明
支持中间件服务接入。
接口方法
POST
参数说明
至少包含:
组织唯一标识、服务名
返回值
包含:
是否成功
备注
无
(2)创建服务接口
服务名称(或URL)
创建服务接口
服务说明
实现服务实例的创建。
接口方法
POST
参数说明
至少包含:
空间唯一标识、服务名
返回值
包含:
是否成功
备注
无
(3)服务配置接口
服务名称(或URL)
服务配置接口
服务说明
实现服务实例的配置、扩容。
接口方法
POST
参数说明
至少包含:
服务唯一标识
返回值
包含:
是否成功
备注
无
(4)获取环境变量接口
服务名称(或URL)
获取环境变量接口
服务说明
实现服务的信息。
接口方法
GET
参数说明
至少包含:
应用唯一标识、服务唯一标识
返回值
包含:
是否成功,服务地址、端口等信息
备注
无
(5)删除服务接口
服务名称(或URL)
删除服务接口
服务说明
实现服务的删除。
接口方法
DELETE
参数说明
至少包含:
服务唯一标识
返回值
包含:
是否成功
备注
无
(6)服务运行状态接口
服务名称(或URL)
服务运行状态接口
服务说明
获取服务实例的实时运行状态信息。
接口方法
GET
参数说明
至少包含:
服务唯一标识
返回值
包含:
是否成功,服务名、服务地址、端口、CPU、内存
等信息。
备注
无
6应用接入流程
本章主要介绍使用应用管理接口进行应用接入的流程,如下图所示:
应用接入涉及的四种角色说明:
●应用开发者:
负责在本地开发应用程序、打包生成程序包等。
●应用运维者:
负责应用的创建、启动和停止,应用部署过程中负责将程序包与中间件进行绑定(如需使用中间件),上传代码及生成APP等操作。
●应用服务管理者:
负责使用中间件服务的接入、服务申请的创建和服务的绑定等操作,并可对已有服务的运行状态进行监控。
●应用监管者:
负责监测应用的网络流量、访问用户量、CPU运行状态、内存的资源占用情况和应用健康情况等,并可对应用的监控报警进行设置,实现应用的自动启停。
应用接入过程的操作步骤说明:
1、开发人员在本地使用开发类接口(具体API参见《工业互联网平台接口模型》)开发应用程序,生成可部署的程序包;
2、运维人员根据开发人员提供的程序包,进行应用创建、域名绑定及中间件服务申请等操作,完成应用创建;
3、服务管理人员完成中间件服务的创建并与应用进行绑定,管理中间件服务的接入,同时监控中间件服务;
4、运维人员完成程序包与中间件绑定,上传应用程序代码,启动生成应用APP,并对代码进行持续迭代部署;
应用接入完成后,监管人员可调用应用监管类接口查看及监测应用的运行情
况。
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 工业 互联网 平台 应用 管理 接口 规范