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 Node（DCN）上で実行される必要な作業を調整できるようになります。大まかに言うと、強化されたREST APIの関連する特性には次のものが含まれます：
-
ONTAPは、REST APIの主要なアクセスパスのままです。クライアントは引き続き使い慣れたONTAP REST APIフレームワーク、認証方法、およびRBACモデルを使用します。
-
AIDE は、主に `/api/data-engine`および `/api/dcn`サブツリーの下に新しい REST リソースを追加し、ワークスペース、データソース、データコレクション、および AI パイプライン内の内部 AIDE コンポーネントを管理します。
-
ONTAPは、以下の方法でクライアント要求を処理するためのオーケストレーションレイヤーとして機能します：
-
リクエストはONTAPによって処理され、ONTAPは必要に応じてデータコンピューティングノードで実行されているサービスと通信および連携を行います。
-
個別のダウンストリームREST要求がONTAPによって作成され、DCNベースのサービスに送信されます。正規化されたONTAPスタイルの応答が元のクライアントに返されます。
-
-
AIDE フローの認証は階層化されています：
-
ONTAPは、RBACに基づいて第一レベルの認可を強制します。
-
DCNベースのサービスは、ワークスペースやデータコレクションに対するACLチェックなど、オプションで第2レベルの認可を適用できます。
-
このハイブリッド設計により、AIDE機能セットがONTAP REST APIの自然な拡張機能として動作し、計算負荷の高い機能およびAI特有の機能のためにDCN環境を活用できるようになります。
アクセスとアーキテクチャ
クライアントがAIDE REST APIにどのようにアクセスするか、および基盤となるアーキテクチャがどのように要求をサポートしているかを理解することが重要です。
- クライアントからONTAPクラスタへ
-
RESTクライアントは、通常はクラスタ管理IPアドレスを介して、AIDE管理操作のためにONTAPにリクエストを送信します。たとえば、要求されるアクションには、ワークスペースやデータコレクションの作成と管理が含まれます。ONTAPはリクエストを認証および承認し、必要に応じてDCNクラスタに追加のRESTコールを発行します。
- 個別のRAGエンドポイント
-
Retrieval-Augmented Generation（RAG）スタイルのAPI呼び出しは、DCNに直接発行する必要があります。この場合、DCNはリクエストからユーザーIDトークンを抽出し、ONTAPにコールバックして承認決定を求めます。ONTAPはトークンを検証してRBACチェックを実行し、承認結果を返します。DCNはこれらの結果をキャッシュすることで、認証呼び出しが繰り返される際のパフォーマンスを向上させることができます。また、リクエストを実行する前に、追加のリソースレベルのACLチェックも実行します。
- ONTAPによって公開されるプロキシエンドポイント
-
ONTAPは、HTTPリクエストをDCN環境にルーティングするためのプロキシスタイルのパスもサポートしています。
-
`/console`で始まるパスを持つリクエストはDCNにプロキシされ、AIDEコンソールで使用されます。これらは、プロキシ層として機能するONTAP認証なしでアクセスできるように設計されています。
-
`/dcn`で始まるパスを持つリクエストもDCNにプロキシされますが、ONTAPによる認証が必要です。これらは一般的に、監視統合に使用されます。
-
ONTAP と DCN 間のサービス通信をサポートするリクエストもプロキシ経由で処理できます。クライアントから ONTAP REST エンドポイントへの呼び出しにより、 ONTAP は 1 つ以上の内部 REST 呼び出しを DCN エンドポイントに変換する可能性があります。非同期操作のためのジョブポーリングやページロジックの適用など、多くの詳細な処理は、最終的なレスポンスを返す前に行われます。
-
要約すると、AIDE REST API機能は、クライアントの観点からはONTAPスタイルのREST APIとして利用され、基盤となる処理がONTAPおよびDCNホスト型サービスと専用のRAGエントリーポイントにまたがることを可能にします。
リファレンスドキュメント
すべてのAFXストレージシステムには、ローカルのSwagger（OpenAPI）リファレンスドキュメントが付属しています。ドキュメントでは、エンドポイント、HTTPメソッド、パラメータ、およびリクエスト/レスポンスのスキーマについて、必要に応じて例を交えて説明しています。これは、開発者や管理者がAIDE REST API機能の詳細を理解するための貴重なリソースです。Swaggerドキュメントへのアクセス方法の詳細については、 "AFXストレージシステムのREST APIリファレンス"を参照してください。