Cato 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>

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

メッセージ: 期待される名前、見つかった <Invalid>

エラーメッセージは、無効な値を持つエラーを示しています。

例えば、Cato API の timeFrame 引数 (accountMetrics) は ISO 8601 の日付と時間標準のために引用符を使用します。timeFrame: "last.P1D" は正しく、timeFrame: last.P1D はこのエラーを引き起こします。

一般的な GRAPH_QL_VALIDATION_FAILED エラー

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

メッセージ: 期待される型 String!、見つかった <number>

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

例えば、sites ids 引数 (accountMetrics > sites) は STRING であるため、値に引用符を使用する必要があります。ids: ["4242"] は正しく、ids:[4242] はこのエラーを引き起こします。

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

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

例えば、sites ids 引数 (accountSnapshot > sites) は INT であり、値に引用符を使用してはなりません。ids: [2626] は正しく、ids:["2626"] はこのエラーを引き起こします。

API エラーメッセージ

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

メッセージ: 認証エラーまたは 403

アカウントの API キーに問題があります。 推奨ソリューション:

  • Cato 管理アプリケーション (システム > API アクセス管理) で、以下を確認してください。

    • 使用している API キーがまだ有効である（存在し、期限切れでない）こと

    • IP からのアクセスを許可 オプションが設定されている場合、API クライアントが特定の許可された IP アドレスまたは範囲からの呼び出しを行っていること

  • API クエリソフトウェアの HTTP ヘッダー設定でキーが正しく設定されていることを確認してください: x-api-key: <key value>、例えば x-api-key: abcdef12345

  • 問題が続く場合は、新しい API キーを生成して API クエリソフトウェアに追加してください

これは API クライアントの有効な HTTP ヘッダーの例です:

POST /api/v1/graphql2 HTTP/2
Host: api.catonetworks.com
User-Agent: curl/8.7.1
Accept: */*
Content-Type:application/json
x-api-key: abcdef123456789

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

クエリが複数のサイトを含む場合、groupDevices 引数 (accountMetrics) の値は true である必要があります。

API 分析データの変換

Cato API はトラフィックデータをバイト単位で返します。 データを大きな単位（MB や GB など）に変換するには、1024 の指数倍で割る必要があります: MB には 10242、GB には 10243。

例えば、536,870,912,000 バイトを GB に変換するには、10243 で割って 500GB のデータを表します。

この記事は役に立ちましたか？

1人中1人がこの記事が役に立ったと言っています

0件のコメント