API エラー

Zonos GraphQL API によって返されるエラーを理解し、解決します。

GraphQL

Zonos API は 2 種類のエラーを返します。トランスポートレベルの障害の場合は HTTP ステータスコード、アプリケーションレベルの問題の場合は GraphQL エラーです。ほとんどのエラーは GraphQL エラーであり、原因と適切な解決策の特定に役立つ extensions フィールドの分類が含まれています。

HTTP ステータスコード

HTTP エラーは、リクエストをトランスポートレベルで処理できない場合に返されます。

ステータスコード↕	意味↕
400	無効な引数/不正なリクエスト — リクエストに無効な入力が含まれています。
401	未承認 — 有効な認証情報が提供されませんでした。
404	見つかりません — 要求されたリソースは存在しません。
409	リソースの競合 — リクエストはリソースの現在の状態と競合します。
412	前提条件の失敗 — 処理前に必要な条件が満たされませんでした。
422	処理できないエンティティ — リクエスト本文は構造的には有効ですが、無効な値が含まれています。
429	レート制限 — 短期間にリクエストが多すぎます。指数バックオフを使用して再試行してください。
500	内部サーバーエラー — 予期しないサーバー側の障害が発生しました。再試行してください。解決しない場合はサポートにお問い合わせください。
503	サービスを利用できません — サービスは一時的にオフラインです。少し待ってから再試行してください。
504	タイムアウト — サーバーは時間内に応答を受信しませんでした。リクエストを再試行してください。

GraphQL エラー形式

アプリケーションレベルのエラーは、応答本文の errors フィールドのリストとして返されます。各エラーには、message、失敗した操作の path、およびエラータイプと要求 ID を含む extensions オブジェクトが含まれます。

1{

2 "errors": [

3 {

4 "message": "Description of the error",

5 "path": [

6 "landedCostCalculate"

7 ],

8 "extensions": {

9 "errorType": "BAD_REQUEST",

10 "requestId": "req_abc123"

11 }

12 }

13 ]

14}

エラーの分類

extensions.errorType フィールドは、エラーのカテゴリと推奨されるアクションを示します。

分類↕	HTTP と同等↕	意味↕	アクション↕
`BAD_REQUEST`	400	入力パラメータまたはリクエストパラメータが無効です。	リクエストを修正してください。必須フィールド、形式、値を確認してください。
`NOT_FOUND`	404	参照されたリソースが存在しません。	ID、コード、および必要なデフォルトが設定されていることを確認してください。
`UNAVAILABLE`	503	要求されたサービスまたはオプションは、このルートでは利用できません。	別の方法、サービスレベル、または宛先を試してください。
`PERMISSION_DENIED`	401 / 403	認証または認可の失敗。	資格情報とアカウント権限を確認してください。
`FAILED_PRECONDITION`	412	必要な構成またはセットアップ条件が満たされませんでした。	組織の設定を確認するか、サポートにお問い合わせください。
`INTERNAL`	500	予期しないサーバー側の障害が発生しました。	リクエストを再試行してください。問題が解決しない場合は、サポートにお問い合わせください。
`UNKNOWN`	500	予期しないエラーであり、それ以上の分類はありません。	リクエストの形式を確認してください。問題が解決しない場合は、サポートにお問い合わせください。

デモを予約する

API エラー

HTTP ステータス コード

GraphQL エラー形式

エラーの分類

このページは役に立ちましたか？

HTTP ステータスコード