API標準及多語言預置SDK
本產品（SysOM/2023-12-30）的OpenAPI採用ROA簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
巡檢
|
API |
標題 |
API概述 |
| GetInspectionReport | 取得巡檢報告 | 本介面用於取得 SysOM 巡檢報告 |
| CreateInstanceInspection | 建立實例巡檢 | 本介面用於建立 SysOM 實例巡檢 |
告警推送
|
API |
標題 |
API概述 |
| ListAlertDestinations | 獲取告警聯絡人清單 | 本介面用於獲取告警聯絡人清單。 |
| GetAlertDestination | 取得告警聯絡人 | 本介面用於取得指定告警聯絡人資訊。 |
| GetAlertStrategy | 取得告警策略 | 根據策略 ID，取得使用者的一則告警 |
| DeleteAlertStrategy | 刪除告警策略 | 使用者刪除推送告警的策略 |
| ListAlertItems | 取得警示異常項目清單 | 取得所有警示項目 |
| ListAlertStrategies | List Alert Policies | Used to obtain all alert policies for push notifications of a user |
| DeleteAlertDestination | 刪除告警聯絡人 | 本介面用於刪除告警聯絡人 |
| CreateAlertDestination | 建立告警聯絡人 | 本介面用於建立告警推送的聯絡人 |
| CreateAlertStrategy | Create alert policy | Create an alert policy for push notifications |
| UpdateAlertStrategy | Update alert policy | Update push alert policy |
熱點分析
|
API |
標題 |
API概述 |
| GetServiceFuncStatus | 取得服務組態狀態 | 取得功能模組設定 |
| GetHotSpotUniqList | 取得熱點類型清單 | 取得實例下某個欄位的清單。 |
| GetHotspotTracking | 取得熱點追蹤結果 | 取得熱點追蹤結果 |
| GetHotspotPidList | 取得 PID 列表 | 取得某個實例的 PID 列表 |
| GetHotspotInstanceList | 取得實例清單 | 取得熱點實例清單 |
| GetHotspotCompare | 取得熱點對比追蹤結果 | 取得熱點對比追蹤結果 |
| GetHotspotAnalysis | 取得熱點分析結果 | 取得熱點分析結果 |
AI可觀測
|
API |
標題 |
API概述 |
| GetListRecord | 取得 AI Infra 分析記錄 | AI Infra 取得分析記錄清單 |
| GetAIQueryResult | 取得 AI Infra 觀測結果 | 查看 AI Infra 分析結果 |
元件管理
|
API |
標題 |
API概述 |
| GetResources | 取得叢集/節點資源即時使用情況 | 取得叢集/節點資源即時使用情況 |
| GetHostCount | 取得叢集節點數量或節點 Pod 數量 | 取得叢集節點數量或節點 Pod 數量 |
| InitialSysom | 開通 Alinux 主控台 | 初始化 SysOM，確保服務角色存在。 |
| ListClusters | 取得目前使用者所納管的叢集清單 | 取得目前使用者所有已納管的叢集 |
| ListInstances | 取得受管實例清單 | 取得實例清單 |
| UpgradeAgentForCluster | Update widget for ACK cluster | Update widget for cluster |
| UpgradeAgent | Update Widget | Update the version of the installed widget to the specified version. |
| UninstallAgentForCluster | Uninstall a widget from an ACK cluster | Uninstall a widget from a cluster |
| UninstallAgent | Uninstall Widget | Uninstall a specified version of the widget |
| ListInstanceStatus | 取得納管實例狀態 | 取得實例狀態 |
| ListInstancesEcsInfoList | 取得實例的 ECS 資訊清單 | 取得 ECS 資訊的清單，例如標籤清單、公網 IP 清單等 |
| ListClusterAgentInstallRecords | 取得 ACK 叢集元件安裝記錄 | 取得叢集元件安裝記錄 |
| ListAgentInstallRecords | 取得元件安裝記錄清單 | 列出 Agent 的安裝記錄 |
| InstallAgentForCluster | Install widgets on an ACK cluster | Install widgets on a cluster |
| InstallAgent | Install widget | Install an agent on the specified instance |
| ListAgents | 取得元件清單 | 取得 Agent 清單 |
| GetAgentTask | 取得元件任務的執行狀態 | 取得 Agent 安裝任務執行狀態 |
| GetAgent | 取得元件詳細資訊 | 取得某個元件的詳細資訊 |
| ListAllInstances | 取得所有實例及其完整資訊 | 此介面用於取得已納管/未納管的實例清單，並包含實例資訊。 |
健康度
|
API |
標題 |
API概述 |
| ListAbnormalyEvents | 取得異常事件詳細資訊 | 取得指定時間範圍內叢集／節點／Pod 的異常事件資訊 |
| ListInstanceHealth | 取得叢集中節點/Pod 的健康度清單 | 取得一段時間內叢集節點/Pod 的健康度清單 |
| InvokeAnomalyDiagnosis | 異常項目診斷發起 | 異常項目診斷發起 |
| GetRangeScore | 取得健康分數趨勢 | 取得健康分數趨勢 |
| GetProblemPercentage | 取得異常問題佔比 | 取得一段時間內叢集中節點／節點中 Pod 異常問題的佔比 |
| GetInstantScore | 取得即時叢集/節點健康度分數 | 取得即時叢集/節點健康度分數 |
| GetHealthPercentage | 取得節點/Pod 健康狀態佔比 | 取得一段時間內節點/Pod 健康狀態的佔比 |
| GetAbnormalEventsCount | 取得異常事件的數量 | 取得節點/Pod 不同等級未處理（未診斷）異常事件的數量 |
診斷
|
API |
標題 |
API概述 |
| ListDiagnosis | 取得診斷列表 | 取得診斷歷史記錄清單。 |
| GetDiagnosisResult | 取得診斷結果 | 取得診斷結果。 |
| InvokeDiagnosis | Initiate Diagnosis | Initiate a diagnosis. |
| AuthDiagnosis | 授權診斷 | 本介面用於授權 SysOM 對本帳號下的 ECS 執行個體進行診斷，只有在呼叫本介面對特定的 ECS 進行授權後，才能呼叫 InvokeDiagnosis 介面對其發起診斷。 |
OS copilot
|
API |
標題 |
API概述 |
| GetCopilotHistory | 取得 copilot 串流介面的聊天記錄 | 取得 copilot 歷史聊天記錄 |
| GenerateCopilotStreamResponse | 請求 OS copilot 服務的串流式 SSE 介面 | 串流式 copilot 服務介面 |
| GenerateCopilotResponse | 請求 copilot 服務 | 取得 copilot 服務的回傳結果 |
其他
|
API |
標題 |
API概述 |
| CheckInstanceSupport | 檢查實例是否支援 | 檢查目標實例是否被 SysOM 支援 |
| DescribeMetricList | 查詢指標資料 | 查詢指標 |
| CreateVmcoreDiagnosisTask | 建立當機診斷任務 | 此介面用於建立一個當機智慧診斷任務，對參數中提供的 vmcore 或 dmesg 日誌檔案進行診斷。 |
| GetVmcoreDiagnosisTask | 查詢診斷任務 | 此介面根據任務 ID 查詢對應的任務執行狀態與診斷結果。 |
| CpuHighAgentStreamResponse | 請求 CPU 高負載 Agent 串流 SSE 介面 | CPU 高負載 Agent 串流介面 |