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

この記事は、APIツールおよびソフトウェアを使用してCatoでAPIクエリを実行するときに発生する一般的なエラーのトラブルシューティングの提案を提供します。 例として、AltairおよびPostmanがあります。

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

必要なAPI引数

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

  • accountMetricsクエリ

    • id - アカウントID

    • timeframe - クエリが返すデータの期間

    • groupDevices - 複数のサイトと複数のソケットを持つサイトの場合、分析を単一のソケットに結合する（ブール値 true の場合）

  • accountSnapshotクエリ

    • id - アカウントID

一般的なGRAPHQL_PARSE_FAILEDエラー

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

メッセージ: Unexpected )

クエリに余分な括弧があります。 多くの場合、このエラーは引数にブール値を指定しない場合に発生します。 例として、groupInterfaces: , の代わりに groupInterfaces: true, を使用します。

メッセージ: Expected Name, found <character>

JSONファイルが正しくフォーマットされていません。 メッセージは、不足または余分な文字に関連する文字を示しています。 たとえば、引数 accountSnapshot((id: 42) の場合、Expected Name, found ( となります。 この引数の正しい形式は accountSnapshot(id: 1941) です。

メッセージ: Expected Name, found <Invalid>

エラーメッセージは無効な値に関連しています。

たとえば、Cato APIの timeFrame 引数（accountMetrics）はISO 8601日付/時間標準のために引用符を使用します、timeFrame: "last.P1D" は正しく、timeFrame: last.P1D はこのエラーを発生させます。

一般的なGRAPH_QL_VALIDATION_FAILEDエラー

このセクションでは、クエリ内の引数の形式が正しくないことに関連するエラーメッセージの一般的な例を説明します。

メッセージ: Expected type String!, found <number>

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

たとえば、sites ids 引数（accountMetrics > sites）はSTRINGであり、値には引用符を使用する必要があります。ids: ["4242"] は正しく、ids:[4242] はこのエラーを発生させます。

メッセージ: Expected type Int!, found \"<number>\"

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

たとえば、sites ids 引数（accountSnapshot > sites）はINTであり、値に引用符を使用しないでください。ids: [2626] は正しく、ids:["2626"] はこのエラーを発生させます。

APIエラーメッセージ

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

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

アカウントのAPIキーに問題があります。 提案されたソリューション:

  • Cato管理画面 (System > API Access Management) で、以下を確認してください:

    • 使用している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アナリティクスデータの変換

カトAPIはバイト単位でトラフィックデータを返します。 データをより大きな単位（例えばMBまたはGB）に変換するには、1024の指数値で割る必要があります。MBは10242、GBは10243です。

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

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

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

0件のコメント