本文介紹如何管理並使用預置指標API、產品資料API以及自訂服務API。
前提條件
管理API
在物聯網平台控制台的執行個體概覽頁面,單擊目標企業版執行個體ID或備忘名稱。
在左側導覽列,選擇資料服務 > 資料API。
在資料API頁面的API列表,單擊預置指標API、產品資料API或自訂服務API頁簽,找到要查看的API,然後單擊對應API操作列的查看。
在API詳情頁面的右上方,選擇版本號碼,查看對應版本的API詳情,包括基礎資訊、API監控和參數。
單擊API營運,您可查看API的使用方式。
單擊API測試,您可測試API,查看請求詳情、返回樣本和調用樣本。
使用API
根據API的詳情資訊,您可在自己的伺服器整合並調用對應API,擷取相關資料,以充分利用資料資產。
單個阿里雲帳號調用資料服務API的每秒請求數(QPS)最大限制為100。
您可以調用ListAnalyticsData,根據業務需要,擷取指定API的資料。
如果您使用阿里雲提供的SDK,可根據您的開發語言,參考以下調用樣本:
如果您不使用阿里雲提供的SDK,開發時則需注意以下公用參數。
名稱
類型
是否必傳
樣本值
描述
apiPath
String
是
pk/temperatureMax
API路徑。
iotInstanceId
String
是
iot-cn-npk1u******
執行個體ID。更多資訊,請參見物聯網平台執行個體相關問題。
pageNum
Integer
開啟分頁時必傳
10
分頁的頁碼。
pageSize
Integer
開啟分頁時必傳
100
每頁顯示結果的條數,最大值為100。
在API詳情頁面,您可以查看API的返回參數。以下是API的公用返回參數。
名稱
類型
樣本值
描述
Count
Long
3
符合查詢條件的記錄總條數。
HasNext
Boolean
false
合格資料是否有下一頁。
true:是。
false:否。
PageNum
Integer
1
分頁的頁碼。
PageSize
Integer
100
每頁顯示結果的最大條數。
ResultJson
String
[{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"王五\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"李四\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"熊大\"}]"
合格資料詳情。