ゲートウェイAPIを使用すると、Active IQ Unified Managerのクレデンシャルを使用してONTAP REST APIを実行し、ストレージオブジェクトを管理することができます。これらのAPIは、Unified Manager Web UIからAPIゲートウェイ機能を有効にすると使用できるようになります。

Unified Manager REST APIでUnified Managerのデータソース（ONTAPクラスタ）に対して実行できるのは、一部の処理のみです。それ以外の処理はONTAP APIを使用して実行できます。ゲートウェイAPIを使用すると、Unified Managerをパススルーインターフェイスとして、各データセンタークラスタに個別にログインせずに直接管理対象のONTAPクラスタに対してすべてのAPI要求を実行することができます。Unified Managerは単一の管理ポイントとして機能し、そのUnified Managerインスタンスが管理するONTAPクラスタ全体に対してAPIを実行することができます。APIゲートウェイ機能を使用すると、それぞれのONTAPクラスタに個別にログインすることなく、単一のコントロールプレーンであるUnified Managerから複数のONTAPクラスタを一元的に管理できます。Unified Managerにログインしたままで、ONTAP REST API処理を実行してONTAPクラスタを管理できます。

すべてのユーザーがGET処理を使用してクエリを実行できます。アプリケーション管理者はすべてのONTAP REST処理を実行できます。

ゲートウェイは、ヘッダーと本文の形式をONTAP APIと同じにすることで、API要求をトンネリングするプロキシとして機能します。個々のクラスタのクレデンシャルを渡すことなく、Unified Managerのクレデンシャルを使用して特定の処理を実行し、ONTAPクラスタにアクセスして管理することができます。クラスタ認証とクラスタ管理は引き続き管理されますが、API要求は特定のクラスタにリダイレクトされて直接実行されます。APIから返される応答は、対応するONTAP REST APIをONTAPから直接実行した場合と同じです。

HTTP動詞パス（URL）説明

GET

/gateways

このGETメソッドは、Unified Managerで管理されているクラスタのうち、ONTAP REST呼び出しをサポートするすべてのクラスタのリストを取得します。クラスタのUniversal Unique Identifier（UUID）に基づいてクラスタの詳細を確認し、他のメソッドを実行することができます。

ゲートウェイAPIは、ONTAP 9.7以降でサポートされていて、HTTPSを使用してUnified Managerに追加されたクラスタのみを取得します。

GET

POST

DELETE

PATCH

OPTIONS（Swaggerでは利用不可）

HEAD（Swaggerでは利用不可）

/gateways/{uuid}/{path}

{uuid}の値は、REST処理を実行するクラスタのUUIDに置き換える必要があります。また、ONTAP 9.5以降でサポートされていて、HTTPSを使用してUnified Managerに追加されたクラスタのUUIDを指定してください。 {path} は、ONTAP REST URLに置き換えてください。/api/はURLから削除する必要があります。

これは単一ポイントのプロキシAPIで、POST、DELETE、PATCHの処理に加え、すべてのONTAP REST APIのGETをサポートしています。ONTAPでサポートされているかぎり、どのAPIにも制限はありません。トンネリングまたはプロキシ機能を無効にすることはできません。

OPTIONSメソッドは、あるONTAP REST APIでサポートされているすべての処理を返します。たとえば、あるONTAP APIでGET処理のみがサポートされている場合、このゲートウェイAPIを使用してOPTIONSメソッドを実行すると応答としてGETが返されます。このメソッドはSwaggerではサポートされていませんが、他のAPIツールでは実行できます。

OPTIONSメソッドは、あるリソースが使用可能かどうかを判定します。この処理を使用して、リソースに関するメタデータをHTTP応答ヘッダーに表示できます。このメソッドはSwaggerではサポートされていませんが、他のAPIツールでは実行できます。

APIゲートウェイのトンネリングの概要

ゲートウェイAPIを使用すると、Unified ManagerからONTAPオブジェクトを管理できます。Unified Managerはクラスタと認証の詳細を管理し、ONTAP RESTエンドポイントに要求をリダイレクトします。ゲートウェイAPIは、ヘッダーおよび応答本文のURLとHypermedia as the Engine of Application State（HATEOAS）リンクをAPIゲートウェイのベースURLで変換します。ゲートウェイAPIはプロキシのベースURLとして機能し、これにONTAP REST URLを追加して必要なONTAP RESTエンドポイントを実行します。

ONTAP APIがAPIゲートウェイ経由で実行されるためには、APIを実行するONTAPクラスタのバージョンでAPIがサポートされている必要があります。ONTAPクラスタでサポートされていないAPIを実行した場合、結果は何も返されません。

この例では、ゲートウェイAPI（プロキシのベースURL）は/gateways/{uuid}/です。

渡されるONTAP APIは/storage/volumesです。このONTAP API REST URLをpathパラメーターの値として追加する必要があります。

パスを追加する際、URLの先頭の「/」は削除してください。APIが/storage/volumesであれば、storage/volumesを追加します。

追加したURL：/gateways/{uuid}/storage/volumes

GET処理を実行すると、次のURLが生成されます：GEThttps://<hostname\>/api/gateways/<cluster_UUID\>/storage/volumes

ONTAP REST URLの/apiタグは、追加したURLからは削除され、ゲートウェイAPIでは保持されています。

cURLコマンドの例

curl -X GET "https://<hostname>/api/gateways/1cd8a442-86d1-11e0-ae1c-9876567890123/storage/volumes" -H "accept: application/hal+json" -H "Authorization: Basic <Base64EncodedCredentials>"

このAPIは、指定したクラスタ内のストレージボリュームのリストを返します。応答形式は、同じAPIをONTAPから実行した場合と同じです。返されるステータスコードは、ONTAP RESTのステータスコードです。

APIスコープの設定

すべてのAPIは、コンテキストがクラスタのスコープ内に設定されています。Storage VMを対象とするAPIのスコープもクラスタです。つまり、管理対象クラスタ内の特定のStorage VMでAPI処理が実行されます。/gateways/{uuid}/{path} APIを実行する際は、処理を実行するクラスタのUUID（Unified ManagerのデータソースのUUID）を入力してください。そのクラスタ内の特定のStorage VMにコンテキストを設定する場合は、Storage VMのキーをX-Dot-SVM-UUIDパラメーターとして入力するか、Storage VMの名前をX-Dot-SVM-Nameパラメーターとして入力します。指定したパラメーターが文字列ヘッダーにフィルターとして追加され、クラスタ内のそのStorage VMのスコープ内で処理が実行されます。

cURLコマンドの例

curl -X GET "https://<hostname>/api/gateways/e4f33f90-f75f-11e8-9ed9-00a098e3215f/storage/volume" -H "accept: application/hal+json" -H "X-Dot-SVM-UUID: d9c33ec0-5b61-11e9-8760-00a098e3215f"
-H "Authorization: Basic <Base64EncodedCredentials>"

Active IQ Unified Manager 9.13

プロキシ アクセスによるONTAP APIへのアクセス

APIゲートウェイのトンネリングの概要

APIスコープの設定

プロキシアクセスによるONTAP APIへのアクセス