GraphQL PlaygroundからCato APIへの接続

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

GraphQL Playground の概要

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

前提条件

GraphQL Playground から Cato API クエリを実行するには、アカウントの API キーが必要です (リソース > API キー)。 API キーに関する詳細は、Cato API の API キーを生成するを参照してください。

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

APIエンドポイントのURLは、Cato管理アプリケーション (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 クエリで接続をテストする

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

GraphQL Playground でサンプル API クエリを実行する

インターネットブラウザを使用して、Cato API の GraphQL Playground を開きます。 Playground の HTTP プロトコルヘッダーを API キーで設定します。 サンプルクエリを左側のペインに貼り付け、アカウントIDを入力します。 その後、クエリを実行し、Playgroundで結果を確認できます。

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

  2. インターネットブラウザから、Cato API の GraphQL Playground にアクセスします。

  3. 左側のペインの下部で HTTP HEADERS をクリックします。

  4. API キーを以下のフォーマットで入力します： { "x-api-key" :"<api key>" }。

    次のスクリーンショットは、APIキーAaBbCcDdEeFf0123456789ABCDEF1234で設定されたHTTPプロトコルヘッダーを示しています：

    graphql1.png

  5. Playgroundの左側のペインにサンプルクエリをコピーして貼り付けます。

  6. クエリの上部で、accountID引数にアカウントIDを入力します。

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

    graphql2.png

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

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

    graphql3.png

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

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

0件のコメント