Code	説明
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 サーバーで一般的な内部エラーが発生しました。

応答ヘッダー

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

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

通常はapplication/jsonです。

応答の本文

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

単一のオブジェクトを要求に基づいて一連のフィールドとともに返すことができます。たとえば、GETで一意の識別子を使用して、クラスタの選択したプロパティを取得できます。

リソースコレクションから複数のオブジェクトを返すことができます。いずれの場合も一貫した形式が使用され、レコードの数を示すnum_recordsとオブジェクトインスタンスの配列を格納したrecordsが含まれます。たとえば、特定のクラスタで定義されているノードを取得できます。

API呼び出しが非同期で処理されると、バックグラウンドタスクのアンカーを設定するジョブオブジェクトが返されます。たとえば、クラスタ構成の更新に使用されるPATCH要求は非同期で処理され、ジョブオブジェクトが返されます。

エラーが発生した場合は、常にエラーオブジェクトが返されます。たとえば、クラスタに定義されていないフィールドを変更しようとするとエラーが返されます。

場合によっては、データが返されず、応答の本文に空のJSONオブジェクトが含まれることがあります。

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

エラーオブジェクトの形式は次のとおりです。

"error": {
"message": "<string>",
"code": <integer>[,
"target": "<string>"]
}

codeの値で一般的なエラーの種類やカテゴリーを特定し、messageで具体的なエラーの内容を確認できます。特定可能な場合は、エラーに関連するユーザー入力がtargetフィールドに含まれます。

次の表に一般的なエラーコードを示します。特定のAPI呼び出しについては、追加のエラーコードが含まれる場合があります。

Code	説明
409	同じ識別子のオブジェクトがすでに存在します。
400	フィールドの値が無効であるか、値が指定されていないか、不要なフィールドが指定されています。
400	サポートされていない操作です。
405	指定した識別子を持つオブジェクトが見つかりません。
403	要求を実行する権限が拒否されました。
409	リソースが使用中です。