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

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

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

Требуемые аргументы API

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

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

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

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

Сообщение: Unexpected )

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

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

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

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

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

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

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

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

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

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

Например, аргумент sites ids (accountMetrics > sites) является строкой, поэтому необходимо использовать кавычки для значения, 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 и добавьте его в программное обеспечение запроса API

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

POST /api/v1/graphql2 HTTP/2
Host: api.catonetworks.com
User-Agent: curl/8.7.1
Accept: */*
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 ГБ данных.