11.10 HTTPステータスコード
REST API は、処理結果を示すために次に示す標準的なHTTPのステータスコードを使用します。
HTTPステータスコード |
説明 |
---|---|
200 |
OK リクエストが正しく処理されました。 |
202 |
Accepted 非同期処理のリクエストの受け付けが完了したことを示します。 |
400 |
Bad Request リクエストヘッダ、クエリパラメータ、オブジェクトID、またはリクエストボディが不正であることを示します。 |
401 |
Unauthorized リクエストヘッダにAuthorizationヘッダが指定されていない、またはAuthorizationヘッダに指定された情報での認証に失敗したことを示します。 |
403 |
Forbidden 操作を実行するために必要な権限がないことを示します。 |
404 |
Not Found URLで指定したリソースが見つからない、または指定したURLにリソースがないことを示します。 |
406 |
Not acceptable Acceptヘッダに、サポートしていないメディアタイプが指定されたことを示します。 |
415 |
Unsupported Media Type 指定されたメディアタイプはサポートされていないことを示します。 |
500 |
Internal Server Error サーバで内部エラーが発生したことを示します。最も重要なエラーが代表として返却されます。 複数のリソースを操作するAPIを実行した場合、一部だけ情報が取得できている、または操作が一部だけ完了しているときは、次に示す属性が出力されます。 partialSuccessResponses 出力される内容は操作したHTTPメソッドの種類によって異なります。
|
503 |
Service Unavailable サービスが、ビジー状態またはメンテナンスなどで一時的に使用できないことを示します。最も重要なエラーが代表として返却されます。 レスポンスヘッダに「Retry-After」が返却された場合、返却された値(推奨待機時間(秒))を目安に再度リクエストを実行してください。 複数のリソースを操作するAPIを実行した場合、一部だけ情報が取得できている、または操作が一部だけ完了しているときは、次に示す属性が出力されます。 partialSuccessResponses 出力される内容は操作したHTTPメソッドの種類によって異なります。
|
504 |
Gateway Timeout 装置から時間内に応答がないことを示します。最も重要なエラーが代表として返却されます。 複数のリソースを操作するAPIを実行した場合、一部だけ情報が取得できている、または操作が一部だけ完了しているときは、次に示す属性が出力されます。 partialSuccessResponses 出力される内容は操作したHTTPメソッドの種類によって異なります。
|