付録A API 応答コード

Red Hat Satellite 6 API には、API 呼び出しの HTTP 応答ステータスコードがあります。以下のコードは、Satellite API の全リソースに共通します。

表A.1 API 応答コード

応答説明

200 OK

show、index、update、delete (GET、PUT、DELETE 要求) などの要求アクションに成功した場合

201 Created

create アクション (POST 要求) に成功した場合

301 Moved Permanently

Satellite が HTTPS しか使用できないように制限されているにも拘らず、HTTP が試行された時にリダイレクトされる場合

400 Bad Request

必要なパラメーターがないか、検索クエリーに無効な構文が含まれている場合

401 Unauthorized

ユーザー認証に失敗した場合 (認証情報が不正な場合など)

403 Forbidden

ユーザーにアクションの実行、リソースの読み込みなど、十分なパーミッションがないか、アクション自体がサポートされていない場合

404 Not Found

指定の ID のレコードが存在しない場合。要求のレコードが存在しない場合には show または delete アクションに、関連のレコードの 1 つが存在しない場合には create、update、delete アクションに表示されることがあります。

409 Conflict

既存の依存関係が原因でレコードを削除できない場合 (例: ホストのあるホストグループなど)

415 Unsupported Media Type

HTTP 要求のコンテンツタイプが JSON でない場合

422 Unprocessable Entity

バリデーションエラーが原因でエンティティーの作成に失敗した場合。アクションの作成または更新にのみ適用されます。

500 Internal Server Error

予期しないサーバーエラーが発生した場合

503 Service Unavailable

サーバーが実行されていない場合