使用API Arts&API Explorer调用IoT边缘服务接口创建应用
开始体验前需注册华为云账号并完成实名认证,实验过程中请使用Chrome浏览器完成相关操作。
华为云账号注册步骤请参考:
https://support.huaweicloud.com/usermanual-account/zh-cn_topic_0069252244.html
实名认证操作步骤请参考:
https://support.huaweicloud.com/usermanual-account/account_auth_00001.html
1、IoT接口介绍(API Arts部分):
1)引言:API Explorer提供了IoT边缘服务,IoT边缘(IoT Edge)是边缘计算在物联网行业的应用。IoT Edge作为物联网边缘“小脑”,在靠近物或数据源头的边缘侧,融合网络、计算、存储、应用核心能力的开放平台,就近提供计算和智能服务,满足行业在实时业务、应用智能、安全与隐私保护等方面的基本需求。
https://support.huaweicloud.com/productdesc-iotedge/iotedge_01_0001.html
我们先通过API Arts介绍一下如何通过API创建一个loT边缘应用。
2) 进入API Arts并登录
https://console.huaweicloud.com/apiarts/?region=cn-north-4#/home
3)新建一个名为“loT边缘”的项目:
3.1)点击首页右上角的创建项目按钮
3.2)在新建弹窗内输入“loT边缘应用”,点击确定
3.3)新建成功之后,自动跳转到项目详情页面,点击“新建API接口”卡片,我们通过设计API的形式介绍创建边缘应用的接口。
4)介绍:创建边缘应用接口是一个使用POST方法进行请求的接口,新建一个POST接口主要有四个部分:接口基本信息、请求头、请求体和返回响应。
4.1)接口基本信息
接口的名称为“创建应用”,路径为“/v2/{project_id}/edge-apps”。
4.2)请求参数
在路径中输入“/v2/{project_id}/edge-apps”后,请求参数会自动识别路径中的请求参数。
project_id是调用API接口时需要的一个凭证,可以通过以下方式获得:
https://support.huaweicloud.com/api-iotedge/iotedge_api_0032.html
我们可以向project_id参数增加描述信息:
“项目ID:https://support.huaweicloud.com/api-iotedge/iotedge_api_0032.html ”
4.3)请求体
创建项目的配置项在请求体中发送。
主要有5个string类型的参数:
• edge_app_id:应用ID,必填,最小长度4个字符,最大长度为32
• edge_app_name:应用名称,非必填,最小程度4个字符,最大长度为64
• description:应用描述,非必填,最小长度0,最大长度为255
• function_type:功能类型,非必填,分为数据处理(DATA_PROCESSING)、协议解析(PROTOCOL_PARSING)、IT集成(ON_PREMISE_INTEGRATION)和混合应用(COMPOSITE_APPLICATION),数据默认为DATA_PROCESSING,数据处理模块可以传输消息,协议解析为驱动类型,IT集成为部署南向3rdIA使用,混合应用可同时实现数据处理和协议解析。最小长度为0,最大长度为255
• protocol:驱动协议类型OPCUA|Modbus-TCP,非必填,最小长度0,最大长度为64
将这些内容放进请求体中得到:
4.4)返回响应
新建成功时的返回码为201,参数结构如下所示:
4.5)保存
点击保存按钮后,API Arts会根据设计内容生成文档,在日常开发中可以通过文档进行协作。创建应用的接口的文档如下所示:
5)结言:IoT边缘应用创建接口的主要内容已经介绍完了,可以在API Explorer上开通服务体验到API能力。
二、IoT边缘服务调用(API Explorer部分):
1、调用诗歌生成服务前,需要开通IOT边缘服务:
https://console.huaweicloud.com/iotedge/?region=cn-north-4#/console/authorizationEdge
注:IoT边缘收费说明(有一定的额度,可以支持应用的创建):
https://support.huaweicloud.com/productdesc-iotedge/iotedge_01_0008.html
2、登录API Explorer IOT边缘服务调试界面(需要华为云账号登录):
1)查询应用列表
https://console.huaweicloud.com/apiexplorer/#/openapi/IoTEdge/debug?api=BatchListEdgeApps
2)创建应用,以创建HarmonyOS应用为例:
https://console.huaweicloud.com/apiexplorer/#/openapi/IoTEdge/debug?api=CreateEdgeApp
3)查询应用
https://console.huaweicloud.com/apiexplorer/#/openapi/IoTEdge/debug?api=ShowEdgeApp
4)删除应用:
https://console.huaweicloud.com/apiexplorer/#/openapi/IoTEdge/debug?api=DeleteEdgeApp
5)创建边缘节点:
https://console.huaweicloud.com/apiexplorer/#/openapi/IoTEdge/debug?api=CreateEdgeNode
6)查询边缘节点列表
https://console.huaweicloud.com/apiexplorer/#/openapi/IoTEdge/debug?api=ListEdgeNodes
7)查询边缘节点详情
https://console.huaweicloud.com/apiexplorer/#/openapi/IoTEdge/debug?api=ShowEdgeNode
注:调试参数中输入第6步查询到的ID
8)删除边缘节点
https://console.huaweicloud.com/apiexplorer/#/openapi/IoTEdge/debug?api=DeleteEdgeNode
注:调试参数中输入第6步查询到的ID
三、改造诗歌(CodeArts IDE Online + API插件部分):
打开CodeArts IDE Online,将刚刚响应体复制到IDE中,启动调试,可以将刚刚生成的诗词合成一段mp3音频,双击音频可以打开播放。
- 点赞
- 收藏
- 关注作者
评论(0)