Cato API 呼び出しのトラブルシューティング

Prev Next

この記事は、Catoを使用してAPIツールとソフトウェアで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> が見つかりました

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

例:サイトID 引数 (accountMetrics > sites) は STRING なので、値には引用符を使用する必要があります。 ids: ["4242"] は正しく、ids:[4242] はこのエラーを発生させます。

メッセージ:型 Int! が予期されましたが、\"<number>\" が見つかりました

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

例:サイトID 引数 (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
ホスト: api.catonetworks.com
ユーザーエージェント: curl/8.7.1
受け入れ: */*
コンテンツタイプ: application/json
x-api-key: abcdef123456789

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

groupDevices 引数 (accountMetrics) の値は複数のサイトを含むクエリでは true でなければなりません。

API アナリティクス データの変換

Cato API はトラフィックデータをバイトで返します。 データをMBやGBのような大きな単位に変換するには、10242 でMB、10243でGBに分割する必要があります。

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