日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

基本的な動作特性

寄稿者 dmp-netapp このページの PDF をダウンロード

REST で共通のテクノロジとベストプラクティスは確立されますが、各 API の詳細は設計内容に応じて異なる場合があります。

要求と応答の API トランザクション

すべての REST API 呼び出しは、 ONTAP システムへの HTTP 要求として実行され、クライアントへの関連する応答が生成されます。この要求と応答のペアで API トランザクションが構成されます。API を使用する前に、要求の制御に使用できる入力変数と応答出力の内容を理解しておく必要があります。

CRUD 操作のサポート

ONTAP REST API で使用できる各リソースへのアクセスは CRUD モデルに基づきます。

  • 作成

  • 読み取り

  • 更新

  • 削除

一部のリソースでは、一部の処理のみがサポートされます。各リソースの詳細については、 ONTAP クラスタで ONTAP API ドキュメントページを参照してください。

オブジェクト ID

各リソースインスタンスまたはオブジェクトには、作成時に一意の識別子が割り当てられます。ほとんどの場合、識別子は 128 ビットの UUID です。これらの識別子は、特定の ONTAP クラスタ内でグローバルに一意です。新しいオブジェクトインスタンスを作成する API 呼び出しを実行すると、関連付けられた ID の値を含む URL が HTTP 応答の場所ヘッダーにある呼び出し元に返されます。リソースインスタンスを以降の呼び出しで参照する際には、この識別子を抽出して使用できます。

注記 オブジェクト識別子の内容と内部構造は、いつでも変更される可能性があります。識別子を使用するのは、該当する API 呼び出しで関連付けられているオブジェクトを参照するときに必要に応じてのみです。

オブジェクトのインスタンスとコレクション

リソースパスと HTTP メソッドに応じて、 API 呼び出しを特定のオブジェクトインスタンスまたはオブジェクトのコレクションに適用できます。

同期操作と非同期操作

ONTAP では、クライアントから受信した HTTP 要求を 2 つの方法で実行します。

同期処理

GET 、 HEAD 、 OPTIONS の各メソッドを使用する要求は、いずれも常に同期的に実行されます。また、 POST 、 PATCH 、 DELETE を使用する要求は、完了までに 2 秒かからないと予想される場合は同期的に実行するように設計されています。

非同期処理

POST 、 PATCH 、 DELETE の各メソッドを使用する要求は、完了までに 2 秒以上かかると予想される場合は非同期で実行するように設計されています。

注記 「 return _timeout 」クエリパラメータは、非同期 API 呼び出しで使用でき、非同期呼び出しを同期的に完了するように変換できます。詳細については ' ジョブオブジェクトを使用した非同期処理の動作を参照してください

セキュリティ

REST API のセキュリティは、主に ONTAP で利用可能な既存のセキュリティ機能に基づいています。API で使用されるセキュリティは次のとおりです。

  • トランスポートレイヤのセキュリティ

    ONTAP LIF とクライアントの間でネットワークを介して送信されるトラフィックは、通常、 ONTAP の設定に基づいて TLS を使用してすべて暗号化されます。

  • クライアント認証

    ONTAP System Manager および Network Manageability SDK と同じ認証オプションを ONTAP REST API でも使用できます。

  • HTTP 認証

    HTTP レベルでは、 API トランザクションにベーシック認証が使用されます。base64 文字列のユーザ名とパスワードを含む HTTP ヘッダーが各要求に追加されます。

  • ONTAP 許可

    ONTAP では、ロールベースの認証モデルが実装されています。ONTAP REST API または API ドキュメントページにアクセスするときは、適切な権限を持つアカウントを使用する必要があります。