了解 AIDE REST API
建议更改
PDF
当 AI Data Engine (AIDE) 与 AFX 等 ONTAP 存储系统集成时，现有的 ONTAP REST API 通过额外的端点进行增强，以支持新的以 AI 为重点的功能。如果您计划使用 REST API 来管理 AIDE，则应首先了解其特性和基本操作。
扩展 REST API 的特征
AIDE 扩展 AFX 存储系统上的 ONTAP REST API，提供了额外的功能。这为客户提供了一个单一的、熟悉的管理入口点，同时允许 ONTAP 协调在 Data Compute Nodes (DCNs) 上执行的必要工作。在高层次上，增强型 REST API 的相关特性包括：
-
ONTAP 仍然是 REST API 的主要访问路径。客户端继续使用熟悉的 ONTAP REST API 框架、身份验证方法和 RBAC 模型。
-
AIDE 添加新的 REST 资源，主要在 `/api/data-engine`和 `/api/dcn`子树下，以管理工作区、数据源和数据集合，以及 AI 管道中的内部 AIDE 组件。
-
ONTAP 作为业务流程层，通过以下方式处理客户端请求：
-
请求由 ONTAP 处理，ONTAP 根据需要与在数据计算节点上运行的服务进行通信和协调。
-
单独的下游 REST 请求由 ONTAP 创建并发送到基于 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 还支持代理样式路径，将 HTTP 请求路由到 DCN 环境，如下所示：
-
路径以 `/console`开头的请求将代理到 DCN，并由 AIDE 控制台使用。它们被设计为可访问，而无需 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 参考"。