コンテンツAPIのエラーレスポンス
コンテンツAPIへのリクエスト時に発生するエラーについて種別ごとにまとめます。
Caution
- 下記に示す情報は、エラー時の全てのステータスコードを網羅することを保証していません。予期せぬ不具合や考慮の漏れにより、その他のエラーも発生する可能性がございます。あらかじめご了承ください。
Caution
- エラーメッセージは、予告なく変更される可能性がございます。エラーメッセージを元にしたハンドリングは行わないよう、ご注意ください。
GET APIに関するエラー
GET APIに関する、各種ステータスコードとエラーメッセージ別のエラーを示します。
ステータスコード: 400 Bad Request
"IP address rejected"
許可されていないIPアドレスからのリクエストの場合"GET is forbidden."
APIキー設定にて、GET操作が許可されていない場合"API is stopped for xxxxxxxx service. Please upgrade your plan."
何らかの制限によりAPIが停止している場合
(Hobbyプランで20GBの転送量制限をオーバーした場合、プランのダウングレード後にAPI数やメンバー数などの上限を超過している場合、など)"Invalid 'limit' value."
クエリパラメータの "limit" の値が不正な場合"Invalid 'offset' value."
クエリパラメータの "offset" の値が不正な場合"invalid parameter."
その他、パラメータの値が不正な場合"Response body size is too long. Check your url parameters."
レスポンスボディが大きすぎる場合
ステータスコード: 401 Unauthorized
"X-MICROCMS-API-KEY header is invalid."
APIキー(X-MICROCMS-API-KEY)の値が不正な場合
ステータスコード: 404 Not Found
アクセスしたAPI自体が存在しない場合や、APIにコンテンツが存在しない場合(公開停止の場合も含む)
ステータスコード: 414 Request-URI Too Large
リクエストURLの最大長(8KB)の制限を超過した場合
ステータスコード: 429 Too Many Requests
"Too many requests, please try again later."
APIの呼び出し回数に関する制限を超えた場合
Tips
429エラーが出てしまう場合の対処法として、以下のヘルプ記事をご参考ください。
Tips
microcms-js-sdkをお使いいただいている場合、500番台のエラーレスポンスが返ってくる場合の対策としてリトライオプションがございますので、こちらの追加もご検討ください。
ステータスコード: 503 Service Unavailable
一時的ににアクセスが集中して、リクエストを処理できない場合
ステータスコード: 504 Gateway Timeout
リクエストに対する処理中にタイムアウトしてしまった場合