Эта статья объясняет, как использовать GraphQL Playground для выполнения примерных запросов и тестирования подключения к конечной точке API Cato Networks.
GraphQL Playground позволяет вам выполнять запросы API, которые отправляются непосредственно на сервер API Cato. Стороннее программное обеспечение для запросов API, такое как Altair или Postman, предоставляет мощную функциональность для выполнения вызовов API. Однако, если есть проблема с подключением API, вы можете использовать Playground для выявления причины проблемы.
Чтобы выполнить запрос API Cato из GraphQL Playground, у вас должен быть ключ API для вашего аккаунта (Ресурсы > API-ключи). Для получения дополнительной информации о ключах API, см. Generating API Keys for the Cato API.
Вам необходимо ввести ID Учетная запись Приложения управления Cato (CMA) в примерных запросах. Вы можете найти ID CMA на странице Информация об аккаунте.
URL для API конечной точки специфичен для местоположения, где размещен экземпляр Приложения управления Cato (CMA). Может существовать значение <префикс>, которое добавляется к URL вашего аккаунта CMA и к конечной точке API.
-
Если префикс отсутствует (
cc.catonetworks.com), используйте следующий URL:https://api.catonetworks.com/api/v1/graphql2 -
Если имеется префикс (например,
cc.us1.catonetworks.com), используйте следующий URL:https://api.us1.catonetworks.com/api/v1/graphql2
Вы можете выполнить примерный запрос API, чтобы проверить соединение с сервером API Cato. Когда аргумент accountID и ключ API настроены правильно, примерный запрос API возвращает данные аккаунта и показывает результаты в GraphQL Playground. Если запрос не возвращает результаты для вашего аккаунта, это может означать проблему с подключением к серверу API или что сервер может быть недоступен. Следующие примерные запросы API могут помочь вам протестировать соединение с сервером API Cato:
Используйте интернет-браузер для открытия GraphQL Playground для API Cato. Настройте HTTP заголовок для Playground с вашим ключом API. Вставьте примерный запрос в левую панель и введите ваш ID Учетной записи. Затем вы можете запустить запрос и увидеть результаты в Playground.
-
Скачайте один из примерных запросов API из этой статьи и откройте файл в текстовом редакторе, например, Notepad.
-
Из интернет-браузера, перейдите на GraphQL Playground для API Cato.
-
В нижней части левой панели нажмите на HTTP ЗАГОЛОВКИ.
-
Введите ваш ключ API в следующем формате:
{ "x-api-key" :"<api key>" }.На следующем скриншоте показан заголовок HTTP, настроенный с Ключом APIAaBbCcDdEeFf0123456789ABCDEF1234:
-
Скопируйте и вставьте один из примерных запросов в левую панель Playground.
-
В верхней части запроса в аргументе
accountIDвведите ваш ID Аккаунт.На следующем скриншоте показан аргумент
accountID, настроенный со значением 2626: -
Нажмите кнопку воспроизведения.
-
Правая панель показывает результаты запроса API. На следующем скриншоте показаны результаты для примерного запроса accountMetrics для ID аккаунта 2626:
0 комментариев
Войдите в службу, чтобы оставить комментарий.