システムで簡単なコマンドを実行して、ONTAP tools for VMware vSphere REST APIの使用を開始し、使用可能かどうかを確認できます。

コマンドラインインターフェイスで、次のコマンドを実行してプラグイン情報を取得します。

curl -X GET -u username:password -k "https://<ip_address>/api/hosts?fields=IncludePluginInfo"

例

curl -X GET -u admin:password -k "'https://10.225.87.97/api/hosts?fields=IncludePluginInfo"

ONTAP REST API には、いくつかの方法でアクセスできます。

REST API には、次のインターフェイスを通じて接続できます。

使用するLIFは、HTTPS管理プロトコルをサポートするように設定する必要があります。また、ネットワークのファイアウォール設定でHTTPSトラフィックを許可する必要があります。

API 呼び出しの処理方法は、 HTTP 要求で設定されたパラメータと変数を使用して制御できます。

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

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

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

GET を使用する API 呼び出しを発行する際、返されるオブジェクトを任意の属性に基づいて制限またはフィルタできます。たとえば、一致する正確な値を指定できます。

<field>=<query value>

完全一致に加えて、他の演算子を使用して、一連のオブジェクトを一定範囲の値で返すことができます。ONTAP Tools for VMware vSphere REST APIでは、次の表に示すフィルタ演算子がサポートされます。

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

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

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

order_by=<field name> asc|desc

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

order_by=type desc, id asc

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

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