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概述 |
| CreateInstanceInspection | 建立執行個體巡檢。 | 本介面用於建立 SysOM 執行個體巡檢。 |
告警推送
|
API |
標題 |
API概述 |
| ListAlertDestinations | 取得告警聯絡人清單。 | 本介面用於取得告警聯絡人清單。 |
| UpdateAlertDestination | 更新告警聯絡人。 | 本介面用於更新告警聯絡人。 |
| GetAlertDestination | 取得告警聯絡人。 | 本介面用於取得指定告警聯絡人資訊。 |
| UpdateAlertEnabled | 更新告警策略狀態。 | 使用者更新推送告警策略的狀態。 |
| GetAlertStrategy | 取得告警策略。 | 根據策略 ID，取得使用者的一條告警。 |
| DeleteAlertStrategy | 刪除告警策略。 | 使用者刪除推送告警的策略。 |
| ListAlertItems | 獲取告警異常項列表 | 獲取所有告警項 |
| ListAlertStrategies | 取得告警策略清單。 | 用於取得使用者所有推送告警的策略。 |
| DeleteAlertDestination | 刪除告警聯絡人。 | 本介面用於刪除告警聯絡人。 |
| CreateAlertDestination | 建立告警聯絡人。 | 本介面用於建立告警推送的聯絡人。 |
| CreateAlertStrategy | 建立告警策略。 | 新增推送告警的策略。 |
| UpdateAlertStrategy | 更新告警策略。 | 更新推送告警策略。 |
熱點分析
|
API |
標題 |
API概述 |
| UpdateFuncSwitchRecord | 更新服務功能模組配置。 | 更新服務功能模組配置。 |
| GetServiceFuncStatus | 取得服務設定狀態。 | 取得功能模組設定。 |
| GetHotSpotUniqList | 獲取熱點類型列表。 | 獲取執行個體下的某個欄位列表。 |
| GetHotspotTracking | 取得熱點追蹤結果。 | 取得熱點追蹤結果。 |
| GetHotspotPidList | 取得pid列表。 | 取得某個執行個體的pid列表。 |
| GetHotspotInstanceList | 獲取執行個體列表。 | 獲取熱點執行個體列表。 |
| GetHotspotCompare | 取得熱點對比追蹤結果。 | 取得熱點對比追蹤結果。 |
| GetHotspotAnalysis | 取得熱點分析結果。 | 取得熱點分析結果。 |
AI可觀測
|
API |
標題 |
API概述 |
| StartAIAnalysis | 啟動AI Infra觀測。 | 啟動AI作業分析。 |
| GetListRecord | 取得AI Infra分析記錄。 | AI Infra取得分析記錄列表。 |
| GetAIQueryResult | 取得 AI Infra 觀測結果。 | 查看 AI Infra 分析結果。 |
元件管理
|
API |
標題 |
API概述 |
| InstallAgentWithType | 安裝元件。 | 在指定的執行個體上安裝 Agent。 |
| UninstallAgentWithType | 解除安裝元件。 | 解除安裝指定版本的元件。 |
| UpgradeAgentWithType | 更新元件。 | 更新安裝的元件的版本到指定版本。 |
| GetResources | 獲取叢集/節點資源即時使用情況。 | 獲取叢集/節點資源即時使用情況。 |
| GetHostCount | 取得叢集節點數量或節點Pod數量。 | 取得叢集節點數量或節點Pod數量。 |
| InitialSysom | 啟用 Alinux 主控台。 | 初始化 SysOM，確保服務角色存在。 |
| ListClusters | 取得目前使用者納管叢集清單。 | 取得目前使用者所有已納管的叢集。 |
| ListPluginsInstances | 取得元件的執行個體清單。 | 取得外掛程式的安裝/更新/解除安裝執行個體清單。 |
| ListPodsOfInstance | 取得叢集/執行個體中的 Pod 列表。 | 取得叢集或執行個體中的 Pod 列表。 |
| UpgradeAgentForCluster | 為 ACK 叢集更新元件。 | 為叢集更新元件。 |
| UpgradeAgent | 更新元件。 | 更新安裝的元件的版本到指定版本。 |
| UninstallAgentForCluster | 為 ACK 叢集解除安裝元件。 | 為叢集解除安裝元件。 |
| UninstallAgent | 解除安裝元件。 | 解除安裝指定版本的元件。 |
| ListInstancesWithEcsInfo | 取得包含ECS資訊的執行個體清單。 | 取得已納管/未納管執行個體資訊，資訊中包含ECS資訊。 |
| ListInstanceStatus | 取得納管執行個體狀態。 | 取得執行個體狀態。 |
| ListInstancesEcsInfoList | 獲取執行個體的 ECS 資訊列表。 | 獲取 ECS 資訊的列表，如標籤列表、公網 IP 列表等。 |
| ListClusterAgentInstallRecords | 取得 ACK 叢集元件安裝紀錄。 | 取得叢集元件安裝紀錄。 |
| ListAgentInstallRecords | 取得元件安裝紀錄清單。 | 列出 Agent 的安裝紀錄。 |
| InstallAgentForCluster | 為 ACK 叢集安裝元件。 | 為叢集安裝元件。 |
| InstallAgent | 安裝元件。 | 在指定的執行個體上安裝 Agent。 |
| GetAgentTask | 取得元件任務的執行狀態。 | 取得 Agent 安裝任務執行狀態。 |
| GetAgent | 獲取元件詳情。 | 獲取某個元件的詳情。 |
| ListAllInstances | 取得所有執行個體及其完整資訊。 | 此介面用於取得已納管/未納管執行個體清單並帶有執行個體資訊。 |
健康度
|
API |
標題 |
API概述 |
| UpdateEventsAttention | 更新異常項目關注度。 | 異常項目關注度更新，透過調整關注度影響異常項目檢測演算法的敏感度。 |
| ListAbnormalyEvents | 獲取異常事件詳情。 | 獲取一定時間段內的叢集/節點/Pod的異常事件資訊。 |
| ListInstanceHealth | 取得叢集中節點/Pod的健康度清單。 | 取得一定時間內叢集節點/Pod健康度清單。 |
| InvokeAnomalyDiagnosis | 異常項目診斷發起。 | 異常項目診斷發起。 |
| GetRangeScore | 取得健康分趨勢。 | 取得健康分趨勢。 |
| GetProblemPercentage | 獲取異常問題佔比。 | 獲取一定時間內叢集中節點/節點中 pod 異常問題佔比。 |
| GetInstantScore | 取得即時叢集/節點健康度分數。 | 取得即時叢集/節點健康度分數。 |
| GetHealthPercentage | 取得節點/Pod健康狀態佔比。 | 取得一段時間內節點/Pod健康狀態佔比。 |
| GetAbnormalEventsCount | 取得異常事件的數量。 | 取得節點/Pod不同等級未處理（未診斷）異常事件的數量。 |
診斷
|
API |
標題 |
API概述 |
| ListDiagnosis | 取得診斷列表。 | 取得診斷歷史紀錄列表。 |
| GetDiagnosisResult | 取得診斷結果。 | 取得診斷結果。 |
| InvokeDiagnosis | 發起診斷。 | 發起診斷。 |
| AuthDiagnosis | 授權診斷。 | 本介面用於授權 SysOM 對本帳號下的 ECS 執行個體進行診斷，只有在呼叫本介面對特定的 ECS 進行授權後，才可以呼叫 InvokeDiagnosis 介面對其發起診斷。 |
OS copilot
|
API |
標題 |
API概述 |
| GetCopilotHistory | 取得 copilot 串流介面的聊天紀錄。 | 取得 copilot 歷史聊天紀錄。 |
| GenerateCopilotStreamResponse | 請求 os copilot 服務串流 sse 介面。 | 串流 copilot 服務介面。 |
| GenerateCopilotResponse | 呼叫 copilot 服務。 | 取得 copilot 服務的傳回結果。 |
其他
|
API |
標題 |
API概述 |
| CheckInstanceSupport | 檢查執行個體是否支援。 | 檢查目標執行個體是否被 SysOM 支援。 |
| StartAIDiffAnalysis | 啟動 AI Infra 差分分析。 | 啟動 AI Infra 差分分析。 |
| CreateVmcoreDiagnosisTask | 建立當機診斷任務。 | 該介面建立一個當機智慧診斷任務，對參數輸入的vmcore或者dmesg日誌檔案進行診斷。 |
| GetVmcoreDiagnosisTask | 查詢診斷任務。 | 該介面根據任務ID查詢對應的任務執行狀態和診斷結果。 |
| ListVmcoreDiagnosisTask | 查詢當機診斷列表。 | 查詢歷史當機診斷列表。 |
| CpuHighAgentStreamResponse | 請求CPU高agent串流sse介面。 | cpu高agent串流介面。 |
| CreateClusterVpcEndpointConnection | 建立叢集 VPC 端點連線。 | 建立叢集 VPC 端點連線。 |
| DescribeMetricList | 查詢指標資料。 | 查詢指標。 |
| GetAifgResult | 取得診斷結果。 | 取得診斷結果。 |
| GetAifgUrl | 取得診斷結果 URL 連結。 | 取得診斷結果 URL 連結。 |
| GetConfigByName | 根據設定名稱取得設定內容。 | 根據設定名稱取得設定資訊。 |
| GetGpuClusterArgsOptions | 取得 GPU 資源拓撲選項參數 API。 | 取得 GPU 叢集參數清單。 |
| GetGpuClusterListAlarmRecord | 獲取GPU資源拓撲異常事件列表。 | 獲取GPU叢集告警列表。 |
| GetGpuClusterTopology | 獲取GPU資源拓撲API。 | 獲取GPU叢集拓撲。 |
| GetInspectionReport | 取得巡檢報告。 | 本介面用於取得SysOM巡檢報告。 |
| GetListGpuCluster | 取得 GPU 叢集列表。 | 取得 GPU 叢集列表。 |
| ListAgents | 獲取元件清單。 | 獲取 Agent 清單。 |
| ListAifgJobs | 取得診斷任務列表。 | 取得診斷任務列表。 |
| ListInstanceInfo | 取得執行個體資訊列表。 | 此介面用於取得某類型執行個體資訊的所有值。 |
| ListInstances | 取得納管執行個體列表。 | 取得執行個體列表。 |
| ListRegions | 取得納管執行個體分布的區域列表 | 列出所有納管機器的區域 |
| StartAifgAnalysis | 發起診斷。 | 觸發 AI 應用診斷。 |