了解 AIDE REST API
建議變更
PDF
當 AI Data Engine（AIDE）與 ONTAP 儲存系統（例如 AFX）整合時，現有的 ONTAP REST API 會透過新增端點進行增強，以支援新的 AI 功能。如果您打算使用 REST API 管理 AIDE，則應先了解其特性和基本操作。
擴充 REST API 的特性
AIDE 為 AFX 儲存系統上的 ONTAP REST API 擴充了更多功能。這為客戶提供了一個統一且熟悉的管理入口點，同時允許 ONTAP 協調在 Data Compute Node（DCN）上執行的必要工作。增強型 REST API 的主要特性包括：
-
ONTAP 仍然是 REST API 的主要存取路徑。用戶端繼續使用熟悉的 ONTAP REST API 框架、驗證方法和 RBAC 模型。
-
AIDE 新增了新的 REST 資源，主要位於 `/api/data-engine`和 `/api/dcn`子樹下，用於管理工作區、資料來源和資料集合以及 AI 管道中的內部 AIDE 元件。
-
ONTAP 作為編排層，透過以下方式處理用戶端請求：
-
請求由 ONTAP 處理，ONTAP 會根據需要與資料運算節點上執行的服務進行通訊和協調。
-
ONTAP 會建立個別的下游 REST 要求、並傳送至以 DCN 為基礎的服務，同時將標準化的 ONTAP 樣式回應傳回原始用戶端。
-
-
AIDE 流程採用分層授權機制：
-
ONTAP 會根據 RBAC 強制執行第一層授權。
-
基於 DCN 的服務可以選擇強制執行第二級授權，包括對工作區和資料集合進行 ACL 檢查。
-
這種混合設計使 AIDE 功能集能夠作為 ONTAP REST API 的自然擴展而運行，同時利用 DCN 環境實現運算密集型和 AI 特定的功能。
存取與架構
了解客戶端如何存取 AIDE REST API 以及底層架構如何支援這些請求非常重要。
- 用戶端至 ONTAP 叢集
-
REST 用戶端通常透過叢集管理 IP 位址向 ONTAP 發送請求，以執行 AIDE 管理作業。例如，請求的操作可以包括建立和管理工作區和資料集合。ONTAP 會驗證請求並授權，並根據需要向 DCN 叢集發出額外的 REST 呼叫。
- 單獨的 RAG 端點
-
必須直接向 DCN 發出檢索增強生成（RAG）風格的 API 呼叫。在這種情況下，DCN 會從請求中提取使用者身分令牌，並回呼 ONTAP 以進行授權決策。ONTAP 驗證令牌並執行基於角色的存取控制（RBAC）檢查，然後傳回授權結果。DCN 可以快取這些結果以提高重複授權呼叫的效能；它們還會在執行請求之前執行任何額外的資源級存取控制清單（ACL）檢查。
- ONTAP 公開的代理端點
-
ONTAP 也支援 Proxy 樣式路徑，用於將 HTTP 要求路由到 DCN 環境，如下所示：
-
路徑以 `/console`開頭的請求會被代理到 DCN，並由 AIDE 主控台使用。這些請求的設計目的是無需 ONTAP 驗證即可存取，ONTAP 作為代理層。
-
路徑以 `/dcn`開頭的請求也會被代理到 DCN，但需要 ONTAP 進行身份驗證。它們通常用於監控整合。
-
支援 ONTAP 與 DCN 服務通訊的請求也可以進行代理。當客戶端呼叫 ONTAP REST 端點時，ONTAP 可以將其轉換為一個或多個指向 DCN 端點的內部 REST 呼叫。許多細節，例如非同步操作的作業輪詢和頁面邏輯的應用，都會在返回最終回應之前處理完畢。
-
總而言之，從客戶端的角度來看，AIDE REST API 功能以 ONTAP 風格的 REST API 形式使用，同時允許底層處理跨越 ONTAP 以及 DCN 託管的服務，並具有專用的 RAG 入口點。
參考文件
每個 AFX 儲存系統都包含本機 Swagger（OpenAPI）參考文件。該文件描述了端點、HTTP 方法、參數和請求/回應模式，並在適當的地方提供了範例。對於開發人員和管理員來說，這是深入了解 AIDE REST API 功能的寶貴資源。有關存取 Swagger 文件的更多資訊，請參閱 "AFX 儲存系統的 REST API 參考"。