Поиск и устранение неисправностей вызовов API Cato

Эта статья предоставляет рекомендации для устранения ошибок, которые могут возникать при использовании Cato для выполнения API-запроса с инструментами и программным обеспечением API. Например, Altair и Postman.

Проблемы, связанные с API-скриптами и кодированием, не поддерживаются.

Обязательные аргументы API

Это аргументы, которые вы должны включить в API-запрос. Когда вы удаляете необязательный аргумент из API-запроса, используется значение по умолчанию.

• запрос accountMetrics
  • id - идентификатор аккаунта
  • временной интервал - временной диапазон данных, которые возвращает запрос
  • groupDevices - Для нескольких площадок и площадок с несколькими сокетами, объедините аналитику в один сокет (для булева значения true)
• запрос accountSnapshot
  • id - идентификатор аккаунта

Общие ошибки GRAPHQL_PARSE_FAILED

В этом разделе объясняются некоторые распространенные примеры сообщений об ошибках, связанных со схемой GraphQL Cato.

Сообщение: Неожиданная )

В запросе есть лишняя скобка. Часто эта ошибка возникает, когда вы не предоставляете булево значение для аргумента. Например, groupInterfaces: , вместо groupInterfaces: true,

Сообщение: Ожидается Имя, обнаружен <character>

Файл JSON некорректно отформатирован. Сообщение показывает символ, связанный с отсутствующим или лишним символом. Например, Ожидается Имя, обнаружен ( для аргумента accountSnapshot((id: 42). Правильный формат для этого аргумента - accountSnapshot(id: 1941)

Сообщение: Ожидается Имя, обнаружен <Invalid>

Сообщение об ошибке указывает на наличие недопустимого значения.

Например, аргумент временной интервал (accountMetrics) в API Cato использует кавычки для ISO 8601 стандарта даты и времени, временной интервал: "last.P1D" является правильным, а временной интервал: last.P1D вызывает эту ошибку.

Общие ошибки GRAPH_QL_VALIDATION_FAILED

В этом разделе объясняются некоторые распространенные примеры сообщений об ошибках, связанных с неправильным форматом аргументов в запросе.

Сообщение: Ожидается тип Строка!, обнаружен <number>

Сообщение об ошибке указывает, что аргумент имеет недопустимое значение, обычно связанное с форматом аргумента.

Например, аргумент идентификаторы сайтов (accountMetrics > сайты) представляет собой СТРОКУ, поэтому вы должны использовать кавычки для значения, идентификаторы: ["4242"] - правильный формат, а идентификаторы:[4242] вызывает эту ошибку.

Сообщение: Ожидается тип Int!, обнаружен \"<number>\

Сообщение об ошибке указывает, что аргумент имеет недопустимое значение, обычно связанное с форматом аргумента.

Например, аргумент идентификаторы сайтов (accountSnapshot > сайты) представляет собой ЦЕЛОЕ ЧИСЛО, поэтому вам НЕ нужно использовать кавычки для значения, идентификаторы: [2626] - правильный формат, а идентификаторы:["2626"] вызывает эту ошибку.

Сообщения об ошибках API

В этом разделе объясняются общие сообщения об ошибках, которые не связаны напрямую со схемой или форматом GraphQL Cato.

Сообщение: ошибка аутентификации

Проблема с ключом API для вашей учетной записи. Предлагаемые решения:

• В Приложении Управления Cato (Система > Управление доступом к API) убедитесь, что используемый вами ключ API все еще действителен. Ключ удаляется при его отзыве.
• Подтвердите, что ключ правильно настроен в настройках заголовка HTTP для программного обеспечения API-запросов: x-api-key <значение ключа>
• Если проблема сохраняется, сгенерируйте новый ключ API и добавьте его в программное обеспечение API-запросов.

Сообщение: невозможно разделить устройства (groupDevices = false) при выборе нескольких сайтов.

Значение для аргумента groupDevices (accountMetrics) должно быть true при включении запроса на несколько площадок.

Общая ошибка API при запуске скриптов в окно обслуживания

Во время окна обслуживания (обычно каждое второе воскресенье) Cato обновляет сервер API, и он может быть временно недоступен до двух минут. Если вы запускаете рекурсивные API-скрипты, то во время окна обслуживания скрипт может завершиться с ошибкой. Это никак не влияет на данные вашей учетной записи.

Для получения актуальной информации о запланированных окнах обслуживания и статусе Cato Cloud, смотрите https://status.catonetworks.com/.

Общая Ошибка API для Таймаута с Сервером API

Если задержка API-запроса превышает 40 секунд, возникает таймаут с сервером API, и вам нужно повторить запрос. Мы рекомендуем включить механизм повторного запроса в API-скрипт для вашего Cato аккаунта. Этот механизм должен включать как минимум две попытки повторного запроса и ждать как минимум 30 секунд между попытками.