GraphQLプレイグラウンドからCato APIへの接続

Prev Next

この記事では、いくつかのサンプルクエリを実行し、Cato Networks APIエンドポイントへの接続をテストするためにGraphQL プレイグラウンドを使用する方法を説明します。

GraphQL プレイグラウンドの概要

GraphQL プレイグラウンドでは、Cato API サーバーに直接送信されるAPI クエリを実行できます。 AltairやPostmanなどのサードパーティ製API クエリソフトウェアは、API呼び出しを実行するための強力な機能を提供します。 しかし、API クエリで接続の問題が発生した場合は、プレイグラウンドを使用して問題の原因を特定するのに役立ちます。

前提条件

GraphQL プレイグラウンドからCato API クエリを実行するには、アカウント用のAPI キーが必要です(リソース > API  キー)。 API キーについて詳しくは、「Cato API用API  キーの生成」をご覧ください。

サンプルクエリにはアカウントのCato Management Application (CMA) IDを入力する必要があります。 アカウント情報ページでCMA IDを見つけることができます。

APIエンドポイントのURLは、Cato Management Application (CMA)インスタンスがホストされている場所に特有です。 あなたのCMAアカウントとAPIエンドポイント用のURLに追加される可能性のある<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 クエリを使用した接続テスト

Cato API サーバーへの接続をテストするために、サンプルAPI クエリを実行できます。 accountID引数とAPI キーが正しく設定されていると、サンプルAPI クエリがアカウントデータを返し、GraphQL プレイグラウンドに結果が表示されます。 クエリがアカウントの結果を返さない場合、API サーバーへの接続性の問題、またはサーバーがダウンしている可能性があります。 以下のサンプルAPI クエリがCato API サーバーへの接続テストに役立ちます:

GraphQL プレイグラウンドでサンプルAPI クエリを実行中

インターネットブラウザを使用して、Cato API のGraphQL プレイグラウンドを開きます。 プレイグラウンドのためのHTTP ヘッダーをAPI キーで設定します。 左側のペインにサンプルクエリを貼り付け、アカウントIDを入力してください。 その後、クエリを実行してPlaygroundで結果を見ることができます。

  1. この記事からサンプルAPI クエリをダウンロードし、メモ帳などのテキストエディタでファイルを開きます。

  2. インターネットブラウザからCato API 用のGraphQL プレイグラウンドへ行きます。

  3. 左ペインの下部でHTTP ヘッダーをクリックします。

  4. 次の形式でAPI キーを入力します: { "x-api-key" :"<api key>" }。

    以下のスクリーンショットは、APIキーAaBbCcDdEeFf0123456789ABCDEF1234で設定されたHTTPヘッダーを示しています:

    graphql1.png

  5. プレイグラウンドの左ペインにサンプルクエリをコピーして貼り付けます。

  6. クエリの先頭で、accountID引数にあなたのアカウントIDを入力します。

    以下のスクリーンショットは、値2626で設定されたaccountID引数を示しています:

    graphql2.png

  7. 再生ボタンをクリックします。

  8. 右ペインにAPI クエリの結果が表示されます。 下記のスクリーンショットは、アカウントID 2626のためのサンプルaccountMetricsクエリの結果を示しています:

    graphql3.png