全部產品
Search
文件中心

IoT Platform:自訂服務API

更新時間:Jun 30, 2024

除了使用預置指標API和產品資料API外,您還可以根據業務需要,建立自訂服務API擷取資料指標和自訂儲存表的資料。本文介紹如何建立自訂服務API。

前提條件

已建立資料來源相關的指標和儲存表,具體資訊,請參見指標概述自訂儲存表

操作步驟

  1. 物聯網平台控制台執行個體概覽頁面,單擊目標企業版執行個體ID或備忘名稱。

  2. 在左側導覽列,選擇資料服務 > 資料API

  3. 資料API頁面,單擊自訂服務API頁簽,然後單擊建立API

  4. 建立API設定精靈頁面,完成API基本資料的配置,然後單擊下一步

    參數

    描述

    API名稱

    輸入API名稱。支援中文、英文字母、數字、底線(_)和短劃線(-)。長度不超過30個字元。

    API Path

    輸入API路徑。作為API資源標識符,執行個體下具有唯一性。

    調用API時,請求參數中apiPath的值與之對應。

    以正斜線(/)開頭,支援英文字母、數字、底線(_)、正斜線(/),長度不超過128個字元。例如:pk/temperatureMax

    重要

    API發布後,API Path不支援修改。

    API標籤

    輸入標籤內容後,按斷行符號鍵,產生標籤。

    支援中文、英文字母、數字、底線(_)和短劃線(-)。長度不超過30個字元。

    使用標籤功能,為API自訂標識,以便靈活管理API。

    重要

    一個API最多可添加5個標籤。

    API描述

    輸入API的描述,說明API的功能等資訊。

    傳回型別

    調用API後,返回資料的格式,固定為JSON。

  5. 配置參數並測試頁面,完成以下配置。

    類別

    配置項

    說明

    資料來源

    指標

    選擇具體指標域資料集

    資料集是指標域的具體對象組織,例如產品域下具體產品,裝置域下具體裝置。

    指標詳細資料,請參見什麼是指標

    儲存表

    選擇通過資料解析或SQL分析任務,輸出的自訂儲存表。

    更多資訊,請參見冷資料存放區表

    配置參數

    資料集

    資料來源選擇指標,並選擇具體指標域資料集後,自動顯示所選的資料來源。

    單擊預覽資料,可跳轉至該資料來源的詳情頁面。

    資料範圍

    資料來源選擇指標,展示該配置項。

    選擇API的資料範圍:

    • 衍生指標:基於原始指標、原始定義、衍生定義,經過求和、計算平均數等匯總計算方式得到的資料。

    • 衍生定義:以原始定義為基礎,並應用到子實體上的原始定義指標的衍生。

    衍生指標和定義說明,請參見指標類型

    請求參數

    單擊添加參數,將所選資料來源的指標,添加到API的請求參數。僅支援系統欄位及自訂儲存表的主鍵欄位。

    添加的參數需包括綁定欄位、參數名、參數類型、操作符、必選、樣本值、參數描述。

    重要

    參數類型為數值型時,操作符不支援LIKE

    返回參數

    單擊添加參數,將所選資料來源的指標,添加到API的返回參數。

    添加的參數需包括優先順序、綁定欄位、參數名、參數類型、用於排序、樣本值、參數描述。

    選中頁面右側的選擇全部參數複選框,API的返回參數會包括所有已定義的表欄位。

    說明
    • 用於排序是指對查詢擷取的資料根據該欄位的值進行排序(升序或降序),排序後再返回查詢結果。

    • 在返回參數裡,一個指標僅能被配置成一個參數。

    排序方式

    選擇參數的排列順序。

    • 升序(預設):參數以升序排列。

    • 降序:參數以降序排列。

    進階設定

    開啟返回結果分頁

    選擇是否開啟返回結果分頁。

    • 不開啟:僅可查看100條以內的返回結果。

    • 開啟:可分頁查看所有返回結果。開啟後,自動增加以下公用參數:

      • pageNum:分頁的頁碼。

      • pageSize:每頁顯示結果的條數,最大值為100。

    逾時報錯設定

    調用API的請求超過8000毫秒時,返回逾時報錯。不支援修改該參數。

    完成上述配置後,在測試API地區內,輸入請求參數的測試值後,單擊開始測試

    您可在返回樣本頁簽查看返回的樣本資料,也可單擊請求詳情查看發起請求後的具體資訊。測試API

  6. 單擊發布

    重要
    • 發布API前,需確保該API已通過測試。

    • 僅單擊儲存的API,顯示狀態為未上線。

    • 未完成配置的API,可單擊對應的編輯,完成配置後發布上線。

    • 僅可刪除未上線和已下線的API。

    發布成功頁面,單擊再次建立,可建立多個自訂API;單擊去列表查看,可查看已建立的API。發布成功

後續操作

已建立的自訂服務API可以調用來擷取資料。具體操作,請參見管理與使用

調用樣本,請參見: