本文介紹如何管理并使用預置指標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\":\"熊大\"}]"
符合條件的數據詳情。