API応答の解釈

各API要求でクライアントへの応答が生成されます。要求が成功したかどうかを確認したり、必要に応じて追加データを取得したりするには、応答を調べる必要があります。

HTTPステータス コード

ONTAP REST APIで使用されるHTTPステータス コードを次に示します。

コード 内容 説明
200 OK 新しいオブジェクトを作成しない呼び出しが成功したことを示します。
201 Created オブジェクトが作成されました。応答のlocationヘッダーにオブジェクトの一意の識別子が含まれます。
202 Accepted バックグラウンド ジョブで要求の実行が開始されましたが、まだ完了していません。
400 Bad request 要求の入力が認識されないか不適切です。
401 Unauthorized ユーザ認証に失敗しました。
403 Forbidden 認証(RBAC)エラーによりアクセスが拒否されました。
404 Not found 要求で参照されているリソースが存在しません。
405 Method not allowed 要求のHTTPメソッドがリソースに対してサポートされていません。
409 Conflict 先に別のオブジェクトを作成する必要があるか、要求されたオブジェクトがすでに存在するため、オブジェクトを作成できませんでした。
500 Internal error サーバで一般的な内部エラーが発生しました。

応答ヘッダー

ONTAPによって生成されるHTTP応答には、いくつかのヘッダーが含まれています。

Location

オブジェクトが作成されたときに、オブジェクトに割り当てられた一意の識別子を含む、新しいオブジェクトへの完全なURLが含まれます。

Content-type
通常はapplication/hal+jsonです。

応答の本文

API要求の結果として返される応答の本文の内容は、オブジェクト、処理タイプ、および要求の成否によって異なります。応答は常にJSON形式になります。

HALリンク

ONTAP REST APIでは、Hypermedia as the Engine of Application State(HATEOAS)をサポートするメカニズムとしてHALを使用しています。特定のリソースを識別するオブジェクトまたは属性を返す場合、リソースに関する追加の詳細を簡単に見つけて確認できるようにHAL形式のリンクも返されます。

エラー

エラーが発生した場合は、応答の本文でエラー オブジェクトが返されます。

形式
エラー オブジェクトの形式は次のとおりです。
"error": {
   "message": "<string>",
   "code": <integer>[,
   "target": "<string>"]
}
codeの値で一般的なエラーの種類やカテゴリを特定し、messageで具体的なエラーの内容を確認できます。特定可能な場合は、エラーに関連するユーザ入力がtargetフィールドに含まれます。
一般的なエラー コード
次の表に一般的なエラー コードを示します。特定のAPI呼び出しについては、追加のエラー コードが含まれる場合があります。
エラー コード HTTPステータス コード 説明
1 409 同じ識別子のオブジェクトがすでに存在します。
2 400 フィールドの値が無効であるか、値が指定されていないか、不要なフィールドが指定されています。
3 400 サポートされていない操作です。
4 405 指定した識別子を持つオブジェクトが見つかりません。
6 403 要求を実行する権限が拒否されました。
8 409 リソースが使用中です。