手把手帶你通過API創建一個loT邊緣應用
摘要:使用API Arts&API Explorer調用IoT邊緣服務接口創建應用,了解邊緣計算在物聯網行業的應用。
本文分享自華為云社區《使用API Arts&API Explorer調用IoT邊緣服務接口創建應用》,作者:華為IoT云服務。
開始體驗前需注冊華為云賬號并完成實名認證,實驗過程中請使用Chrome瀏覽器完成相關操作。
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音頻,雙擊音頻可以打開播放。

浙公網安備 33010602011771號