儀表板資料 API
權限
API金鑰的權限會根據建立的使用者而定
管理API金鑰
右上角帳戶設定頁面可以管理你的API金鑰，點擊查看API金鑰
點擊新增來新增一把金鑰
可以點擊放大鏡看到你的金鑰
也可以直接做刪除動作
API文檔
全球伺服器文檔位置
https://www.weincloud.net/open-api
或者你可以點擊API文檔，可以去查閱有開放的API
這邊會列出所有開放API，右上角的Authorize則是讓你放置API金鑰的地方
Value請填寫您的API金鑰
如果想要自行操作
只需要在HTTP Request Header帶上
X-API-KEY: {你的API金鑰}
就可以存取你的API
API簡介
目前提供下列幾種API，來獲取相關資料(詳細的API使用方式可以參考API文檔)
獲取標籤屬性
GET /dashboard/api/v2/open_api/hmi/{hw_key}/tags
獲取指定HMI的所有標籤資訊，包含標籤名稱、資料類型、單位等屬性。
獲取標籤歷史資料
POST /dashboard/api/v2/open_api/history
獲取指定標籤的歷史數據，可以指定時間範圍和取樣方式，適合用於繪製趨勢圖或數據分析。
- 可一次獲取多個標籤的歷史資料，並且可以指定每個標籤的取樣方式(平均、總和、最大值、最小值等)
- 有資料限制，詳細限制可以參考資料限制章節
獲取標籤最新資料
POST /dashboard/api/v2/open_api/latest
獲取指定標籤的最新數值，適合用於即時監控或儀表板顯示。
- 可一次獲取多個標籤的最新資料
- 有資料限制，詳細限制可以參考資料限制章節
獲取警報分類
GET /dashboard/api/v2/open_api/alarms/categories
獲取系統中所有警報分類的列表，用於警報管理和分類查詢。
獲取警報規則
POST /dashboard/api/v2/open_api/hmi/{hw_key}/alarms/rules
獲取指定HMI的警報規則設定，包含觸發條件、警報等級等資訊。
獲取警報歷史記錄
POST /dashboard/api/v2/open_api/hmi/{hw_key}/alarms/history
獲取指定HMI的警報歷史記錄，可以指定時間範圍和篩選條件，用於警報追蹤和分析。
資料限制
為了確保系統穩定性，目前針對獲取標籤歷史資料有做限制，限制條件如下
單次獲取最多只能獲取4320筆數據
- 在趨勢圖中的即時模式下，我們會以
5秒當作單位來獲取數據，這樣最多只能獲取到6小時內的數據
60(秒)*60(分鐘)*6(小時)/5(秒) = 4320
- 如果有開啟合計模式，我們會以
集合大小當作單位來獲取資料 如果集合大小是1分鐘，那麼最多只能獲取到3天內的數據
60(秒)*60(分鐘)*24(小時)*3(天)/60(秒) = 4320
遇到單次獲取限制時可以採取的手段
- 調整時間範圍到限制內
- 開啟
合計模式，並調整集合大小到更大的值，這樣每次獲取的數據量就會減少 - 分段獲取數據，將時間範圍分成多個段落，每次獲取一個段落的數據，最後將這些數據合併起來
流量限制
目前單一HMI最多只允許15分鐘內可以獲取100MBytes左右的資料，超過這個限制會導致獲取失敗