Устранение неполадок вызовов API Cato

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

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

Необходимые аргументы API

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

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

Типичные ошибки GRAPHQL_PARSE_FAILED

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

Сообщение: Непредвиденный )

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

Сообщение: Ожидаемое Имя, найдено <символ>

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

Сообщение: Ожидаемое Имя, найдено <Invalid>

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

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

Типичные ошибки GRAPH_QL_VALIDATION_FAILED

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

Сообщение: Ожидаемый тип String!, найдено <число>

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

Например, аргумент sites ids (accountMetrics > sites) является STRING, поэтому нужно использовать кавычки для значения, ids: ["4242"] правильно и ids:[4242] вызывает эту ошибку.

Сообщение: Ожидаемый тип Int!, найдено \"<число>\"

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

Например, аргумент sites ids (accountSnapshot > sites) является INT, поэтому НЕ нужно использовать кавычки для значения, ids: [2626] правильно и ids:["2626"] вызывает эту ошибку.

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

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

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

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

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

Это пример допустимого HTTP заголовка для API Клиента:

POST /api/v1/graphql2 HTTP/2
Host: api.catonetworks.com
User-Agent: curl/8.7.1
Принять: */*
Content-Type:application/json
x-api-key: abcdef123456789

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

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

Преобразование Данных Аналитики API

API Cato возвращает данные о трафике в байтах. Чтобы преобразовать данные в более крупные единицы (например, МБ или ГБ), необходимо делить на экспоненциальные значения 1024: 1024² для МБ, и 1024³ для ГБ.

Например, чтобы преобразовать 536,870,912,000 байт в ГБ, разделите на 1024³, чтобы отобразить 500 ГБ данных.