この記事では、GraphQL Playgroundを使ってサンプルクエリを実行し、Cato Networks APIエンドポイントへの接続をテストする方法を説明します。
GraphQL Playgroundは、Cato APIサーバーに直接送信されるAPIクエリを実行することができます。 AltairやPostmanなどのサードパーティのAPIクエリソフトウェアは、APIコールを実行するための強力な機能を提供します。 しかし、APIクエリに接続の問題がある場合、Playgroundを使用して問題の原因を特定するのに役立ちます。
GraphQL PlaygroundからCato APIクエリを実行するには、アカウントのAPIキーが必要です (Resources > API Keys)。 APIキーの詳細については、Cato APIのAPIキーの生成を参照してください。
サンプルクエリにアカウントのCato Management Application (CMA) IDを入力する必要があります。 CMA IDは、アカウント情報ページで確認できます。
APIエンドポイントのURLは、Cato Management Application (CMA)インスタンスがホストされている場所に特有です。 CMAアカウントのURLおよびAPIエンドポイントに追加される<prefix>値がある場合があります。
-
プレフィックスがない場合 (
cc.catonetworks.com)、次のURLを使用します:https://api.catonetworks.com/api/v1/graphql2 -
プレフィックスがある場合 (例:
cc.us1.catonetworks.com)、次のURLを使用します:https://api.us1.catonetworks.com/api/v1/graphql2
Cato APIサーバーへの接続をテストするために、サンプルAPIクエリを実行できます。 accountID引数とAPIキーが正しく構成されている場合、サンプルAPIクエリはアカウントデータを返し、GraphQL Playgroundに結果を表示します。 クエリがアカウントの結果を返さない場合、APIサーバーへの接続に問題があるか、サーバーがダウンしている可能性があります。 以下のサンプルAPIクエリは、Cato APIサーバーへの接続をテストするのに役立ちます:
インターネットブラウザを使用して、Cato APIのGraphQL Playgroundを開きます。 PlaygroundにAPIキーを使用してHTTPヘッダーを構成します。 左ペインにサンプルクエリを貼り付け、アカウントIDを入力します。 その後、クエリを実行してPlaygroundに結果を表示することができます。
-
この記事からサンプルAPIクエリの1つをダウンロードし、Notepadなどのテキストエディタでファイルを開きます。
-
インターネットブラウザから、Cato APIのGraphQL Playgroundにアクセスします。
-
左ペインの下部で、HTTP HEADERSをクリックします。
-
次のフォーマットでAPIキーを入力します:
{ "x-api-key" :"<api key>" }。以下のスクリーンショットは、APIキー AaBbCcDdEeFf0123456789ABCDEF1234 で構成されたHTTPヘッダーを示しています。
-
Playgroundの左ペインにサンプルクエリの1つをコピーして貼り付けます。
-
クエリの先頭で、
accountID引数にアカウントIDを入力します。以下のスクリーンショットは、値2626で構成された
accountID引数を示しています。 -
再生ボタンをクリックします。
-
右ペインにAPIクエリの結果が表示されます。 以下のスクリーンショットは、アカウントID 2626のサンプルaccountMetricsクエリの結果を示しています。
0件のコメント
サインインしてコメントを残してください。