Solución de problemas de llamadas de API de Cato

Este artículo proporciona sugerencias de solución de problemas para errores comunes que pueden ocurrir cuando usas Cato para ejecutar una consulta de API con herramientas y software de API. Por ejemplo, Altair y Postman.

No se admite el soporte para problemas relacionados con scripts y codificación de API.

Argumentos requeridos de la API

Estos son los argumentos que debes incluir en la consulta de la API. Cuando eliminas un argumento opcional de la consulta de API, se usa el valor predeterminado.

  • consulta de accountMetrics

    • id - ID de cuenta

    • timeframe - marco de tiempo de datos que la consulta devuelve

    • groupDevices - Para múltiples sitios y sitios con múltiples Sockets, combina las analíticas en un solo Socket (para valor booleano true)

  • consulta de accountSnapshot

    • id - ID de cuenta

Errores comunes GRAPHQL_PARSE_FAILED

Esta sección explica algunos ejemplos comunes de mensajes de error relacionados con el esquema Cato GraphQL.

Mensaje: Paréntesis inesperado )

Hay un paréntesis adicional en la consulta. A menudo, este error se produce cuando no se proporciona un valor booleano para un argumento. Por ejemplo, groupInterfaces: , en lugar de groupInterfaces: true,

Mensaje: Se esperaba Nombre, se encontró <carácter>

El archivo JSON no está formateado correctamente. El mensaje muestra un carácter relacionado con el carácter faltante o adicional. Por ejemplo, Se esperaba Nombre, se encontró ( para el argumento accountSnapshot((id: 42). El formato correcto para este argumento es accountSnapshot(id: 1941)

Mensaje: Se esperaba Nombre, se encontró <Inválido>

El mensaje de error indica que hay un valor no válido.

Por ejemplo, el argumento timeFrame (accountMetrics) en la API de Cato usa comillas para el estándar de fecha y hora ISO 8601, timeFrame: "last.P1D" es correcto y timeFrame: last.P1D produce este error.

Errores comunes GRAPH_QL_VALIDATION_FAILED

Esta sección explica algunos ejemplos comunes de mensajes de error relacionados con el formato incorrecto de los argumentos en la consulta.

Mensaje: Se esperaba tipo String!, se encontró <número>

El mensaje de error indica que un argumento tiene un valor no válido, generalmente relacionado con el formato del argumento.

Por ejemplo, el argumento sites ids (accountMetrics > sites) es una STRING, por lo que debes usar comillas para el valor, ids: ["4242"] es correcto y ids:[4242] produce este error.

Mensaje: Se esperaba tipo Int!, se encontró \"<número>\"

El mensaje de error indica que un argumento tiene un valor no válido, generalmente relacionado con el formato del argumento.

Por ejemplo, el argumento sites ids (accountSnapshot > sites) es un INT, por lo que NO debes usar comillas para el valor, ids: [2626] es correcto y ids:["2626"] produce este error.

Mensajes de error de API

Esta sección explica mensajes de error comunes que no están específicamente relacionados con el esquema o formato de Cato GraphQL.

Mensaje: error de autenticación o 403

Hay un problema con la clave de API para tu cuenta. Soluciones sugeridas:

  • En la Aplicación de Gestión de Cato (Sistema > Gestión de Acceso a la API), asegúrate de que:

    • La clave de API que estás usando sigue siendo válida (existe y no ha expirado)

    • Si la opción Permitir acceso desde IPs está configurada, el cliente API está realizando la llamada desde una dirección IP o rango específico permitido
  • Confirma que la clave está configurada correctamente en la configuración del encabezado HTTP para el software de consulta API: x-api-key: <valor de la clave>, por ejemplo, x-api-key: abcdef12345

  • Si el problema continúa, genera una nueva clave de API y agrégala al software de consulta de API

Este es un ejemplo de un encabezado HTTP válido para el Cliente 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

Mensaje: no se pueden separar los dispositivos (groupDevices = false) cuando se seleccionan múltiples sitios

El valor para el argumento groupDevices (accountMetrics) debe ser true cuando la consulta incluye múltiples sitios.

Convirtiendo datos analíticos de API

La API de Cato devuelve datos de tráfico en bytes. Para convertir los datos a unidades más grandes (como MB o GB), debes dividir por valores exponenciales de 1024: 10242 para MB y 10243 para GB.

Por ejemplo, para convertir 536,870,912,000 bytes a GB, divide por 10243 para mostrar 500GB de datos.

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 1 de 1

0 comentarios