カトAPIコールのトラブルシューティング

この記事は、APIツールやソフトウェアを使用してCatoを使い、API クエリを実行する際に発生する可能性のある一般的なエラーのトラブルシューティングの提案を提供します。 例えば、AltairとPostman。

API スクリプトやコーディングに関連する問題はサポートされていません。

必須API引数

これらは、API クエリに含める必要がある引数です。 API クエリからオプションの引数を削除すると、デフォルト値が使用されます。

• accountMetricsクエリ
  • id - アカウントID
  • timeframe - クエリが返すデータの時間枠
  • groupDevices - 複数のサイトや複数のソケットを持つサイトの場合、アナリティクスを単一のソケットに結合します（ブール値trueの場合）
• accountSnapshotクエリ
  • id - アカウントID

よくあるGRAPHQL_PARSE_FAILED のエラー

このセクションでは、Cato GraphQL スキーマに関連するエラーメッセージの一般的な例を説明します。

メッセージ: 予期しない )

クエリに余分な括弧があります。 多くの場合、このエラーは、引数にブール値を提供しないときに発生します。 例えば、groupInterfaces: ,ではなくgroupInterfaces: true,

メッセージ: 予期しない名前, 見つかった <character&gt；

JSON ファイルが正しくフォーマットされていません。 メッセージは、不足または余分な文字に関連する文字を表示します。 例えば、引数accountSnapshot((id: 42)の場合、予期しない名前, 見つかった ( この引数の正しいフォーマットはaccountSnapshot(id: 1941)です

メッセージ: 期待される名前, 見つかった <Invalid&gt；

エラーメッセージは、引数に無効な値があることを示しています。

例えば、Cato APIのtimeFrame引数(accountMetrics)は、ISO 8601の日付と時間標準に対して引用符を使用しており、timeFrame: "last.P1D"は正しいが、timeFrame: last.P1Dはこのエラーを生成します。

よくあるGRAPH_QL_VALIDATION_FAILEDのエラー

このセクションでは、クエリ内の引数のフォーマットが不正確であることに関連するエラーメッセージの一般的な例を説明します。

メッセージ: 期待されるタイプString!, 見つかった <number&gt；

エラーメッセージは、引数に無効な値があり、通常は引数フォーマットに関連していることを示しています。

例として、サイトids引数（accountMetrics > サイト）は文字列ですので、値には必ず引用符を使用しなければなりません。ids: ["4242"] は正しく、ids:[4242] はこのエラーを発生させます。

メッセージ: 期待されたタイプ Int!、見つかった \"<number>\"

エラーメッセージは、引数に無効な値があることを示しています。通常、引数の形式に関連しています。

例として、サイトids引数（accountSnapshot > サイト）はINTですので、値には引用符を使用してはいけません。ids: [2626] は正しく、ids:["2626"] はこのエラーを発生させます。

APIエラーメッセージ

このセクションでは、カトGraphQLスキーマやフォーマットに特に関連しない一般的なエラーメッセージについて説明します。

メッセージ: 認証エラー

あなたのアカウントのAPIキーに問題があります。 提案された解決策：

• カト管理アプリケーション（システム > API アクセス管理）で、使用しているAPIキーがまだ有効であることを確認してください。 キーは取り消されると削除されます。
• APIクエリソフトウェアのHTTP設定でキーが正しく構成されていることを確認してください: x-api-key <key value>
• 問題が続く場合は、新しいAPIキーを生成してAPIクエリソフトウェアに追加してください

メッセージ: 複数のサイトが選択されているときにデバイスを分離することはできません（groupDevices = false）

クエリに複数のサイトが含まれている場合、groupDevices引数（accountMetrics）の値はtrueでなければなりません。

メンテナンスウィンドウ中のスクリプト実行時の一般APIエラー

メンテナンスウィンドウ中（通常は隔週の日曜日）、カトはAPIサーバーをアップグレードし、一時的に最大2分間利用できない可能性があります。 再帰的なAPIスクリプトを実行している場合、メンテナンスウィンドウ中にスクリプトが失敗し、エラーを返す可能性があります。 あなたのアカウントのデータには影響はありません。

予定されたメンテナンスウィンドウとカトクラウドのステータスについての最新情報については、https://status.catonetworks.com/ を参照してください。

APIサーバーでのタイムアウトの場合の一般APIエラー

APIクエリに40秒以上の遅延がある場合、APIサーバーでタイムアウトが発生し、クエリを再度実行する必要があります。 カトアカウントのAPIスクリプトには、再試行機構を含めることをお勧めします。 このメカニズムは少なくとも2回の再試行を含め、各再試行の間には少なくとも30秒待つべきです。