コンテンツにスキップ

エラー応答

GraphQL Analytics APIは、HTTPSリクエストとJSONレスポンスに基づくRESTful APIであり、一般的なHTTPステータスコード(例えば、404500504)を返します。しかし、一般的なRESTアプローチとは対照的に、200のレスポンスにはエラーが含まれる場合があり、これはGraphQL仕様に準拠しています。

すべてのレスポンスにはerrors配列が含まれており、エラーがない場合はnullとなり、エラーがあった場合は少なくとも1つのエラーオブジェクトが含まれます。非nullのエラーオブジェクトには以下のフィールドが含まれます:

  • message: エラーを説明する文字列。
  • path: エラーに関連するノード、ルートから始まります。パス配列に含まれる数値(例えば、01)は、エラーが適用されるゾーンを指定します;0はリストの最初のゾーン(または、1つだけクエリされている場合は唯一のゾーン)を示します。
  • timestamp: エラーが発生したUTC日時。

{
"data": null,
"errors": [
{
"message": "2678400秒より古いデータを要求することはできません",
"path": ["viewer", "zones", "0", "firewallEventsAdaptiveGroups"],
"extensions": {
"timestamp": "2019-12-09T21:27:19.195060142Z"
}
}
]
}

一般的なエラータイプ

データセットのアクセス制限(権利)が超過

サンプルエラーメッセージ:

  • “古いデータを要求することはできません…”
  • “フィールドの数はこれ以上にすることはできません…”

これらのメッセージは、クエリがあなたのプランの特定のデータセットに対して許可されている範囲を超えていることを示しています。詳細についてはノード制限を参照してください。

パースの問題

サンプルエラーメッセージ:

  • “引数のパースエラー…”
  • “スカラーフィールドには選択が必要です”

これらのメッセージは、クエリが不正なため処理できないことを示しています。

レート制限の超過

サンプルエラーメッセージ:

  • “制限に達しました。短い期間で再試行してください”
  • “クォータを超過しました。次の1分後にリクエストを繰り返してください”
  • “レートリミターバジェットが枯渇しました。5分後に再試行してください”

レート制限の詳細については、制限セクションを参照してください。