次の表に、 ONTAP REST API でサポートされる HTTP メソッドを示します。

各REST API呼び出しで使用されるエンドポイントパスには、さまざまな識別子を含めることができます。各IDは特定のリソースインスタンスに対応します。たとえば、クラスタIDやSVM IDなどです。

HTTP 要求には複数のヘッダーを含める必要があります。

要求の本文の内容は、それぞれの呼び出しに応じて異なります。HTTP 要求の本文は、次のいずれかで構成されます。

GETメソッドを使用してAPI呼び出しを実行する場合、クエリパラメータを使用して、返されるオブジェクトを任意の属性に基づいて制限またはフィルタリングできます。

1つ以上のパラメータのセットをURL文字列の後ろに追加できます。 ? を押します。複数のパラメータを指定した場合、クエリパラメータは & を押します。パラメーター内の各キーと値は、 = を押します。

たとえば、等号を使用して完全に一致する値を指定できます。

<field>=<value>

より複雑なクエリの場合、追加の演算子は等号の後に配置されます。たとえば、ある値以上の特定のフィールドに基づいてオブジェクトのセットを選択する場合、クエリは次のようになります。

<field>=>=<value>

上記の例に加えて、値の範囲のオブジェクトを返すための追加の演算子も使用できます。次の表に、ONTAP REST APIでサポートされているフィルタ演算子の概要を示します。

また 'null' キーワードまたはその negation!null' をクエリの一部として使用して ' 特定のフィールドが設定されているかどうかに基づいてオブジェクトのコレクションを返すこともできます

このサイトのREST APIワークフローの例を次に示します。

デフォルトでは、 GET を使用する API 呼び出しを発行すると、オブジェクトを一意に識別する属性のみが HAL 自己リンクとともに返されます。この最小のフィールドセットは、各オブジェクトのキーとして機能し、オブジェクトタイプによって異なります。次の方法で 'fields クエリー・パラメータを使用して ' 追加のオブジェクト・プロパティを選択できます

リソースコレクション内のレコードは、オブジェクトによって定義されたデフォルトの順序で返されます。フィールド名とソート方向を指定して 'ORDER BY クエリー・パラメータを使用すると ' 順序を次のように変更できます

order_by=< フィールド名 >asc|desc

たとえば、タイプフィールドを降順でソートし、 ID を昇順でソートできます。

order_by=type desc, id asc

次の点に注意してください。

GET を使用する API 呼び出しを発行して同じタイプのオブジェクトのコレクションにアクセスする場合、 ONTAP では 2 つの制約に基づいて可能なかぎり多くのオブジェクトを返します。これらの各制約は、要求に対する追加のクエリパラメータを使用して制御できます。特定の GET 要求に対する最初の制約に達した時点で要求が終了されるため、返されるレコードの数が制限されます。

一部の API 呼び出しおよびクエリパラメータでは、入力値として数値が使用されます。バイト単位で整数を指定する代わりに、必要に応じて次の表に示すサフィックスを使用できます。