オブジェクトの参照とアクセス

ONTAP REST APIを通じて公開されたリソース インスタンスまたはオブジェクトは、さまざまな方法で参照およびアクセスできます。

オブジェクトのアクセス パス

オブジェクトにアクセスする際のパスのタイプは大きく分けて2つあります。

UUIDを使用したオブジェクトへのアクセス

すべてのオブジェクトには、作成時に一意の識別子が割り当てられます。ほとんどの場合、UUIDは128ビットです。割り当てられたUUIDの値は変更できず、ONTAP内部でリソースへのアクセスと管理に使用されます。そのため、通常は、UUIDがオブジェクトにアクセスするための最も高速で安定した方法となります。

多くのリソース タイプでは、URLのパス キーの一部としてUUIDの値を指定することで特定のオブジェクトにアクセスできます。たとえば、特定のノード インスタンスにアクセスするには、/cluster/nodes/{uuid}の形式で指定します。

オブジェクト プロパティを使用したオブジェクトへのアクセス

UUIDに加え、オブジェクト プロパティを使用してオブジェクトにアクセスすることもできます。ほとんどの場合、nameプロパティを使用すると便利です。たとえば、特定の名前のノード インスタンスにアクセスするには、URL文字列でクエリ パラメータを使用して/cluster/nodes?name=node_oneの形式で指定します。クエリ パラメータに加え、プライマリ オブジェクトのプロパティを使用して外部オブジェクトにアクセスすることもできます。

UUIDの代わりに名前やその他のプロパティを使用してオブジェクトにアクセスできますが、次のような欠点があります。

特に、次のいずれかに該当する場合は、パフォーマンスが低下する可能性があります。

クラスタ コンテキストとSVMコンテキスト

いくつかのRESTエンドポイントは、クラスタとSVMの両方をサポートします。それらのエンドポイントのいずれかを使用する場合は、scope=[svm|cluster]の値を使用してAPI呼び出しのコンテキストを指定できます。両方のコンテキストをサポートするエンドポイントの例としては、IPインターフェイスやセキュリティ ロールがあります。

注: スコープの値のデフォルト値は、それぞれのAPI呼び出しで指定されたプロパティに基づきます。

オブジェクトのコレクションでのPATCHおよびDELETEの使用

リソース インスタンスでPATCHまたはDELETEをサポートするRESTエンドポイントは、オブジェクトのコレクションでも同じメソッドをサポートします。唯一の要件として、URL文字列でクエリ パラメータを使用して少なくとも1つのフィールドを指定する必要があります。コレクションに対してPATCHまたはDELETEを発行すると、内部的には次のように処理されます。

処理のタイムアウトはreturn_timeoutで設定できます。デフォルトは15秒です。タイムアウトまでに完了しなかった場合は、応答に次のオブジェクトへのリンクが含まれます。処理を続行するには、次のリンクを使用して同じHTTPメソッドを再発行する必要があります。