Resolución de problemas de llamadas a la API de Cato

Este artículo ofrece sugerencias para solucionar problemas comunes que pueden ocurrir cuando utiliza Cato para ejecutar una consulta API con herramientas y software de API. Por ejemplo, Altair y Postman.

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

Argumentos requeridos de la API

Estos son los argumentos que debe incluir en la consulta API. Cuando elimina un argumento opcional de la consulta API, se utiliza el valor predeterminado.

• Consulta accountMetrics
  • id - ID de la cuenta
  • timeframe - periodo de tiempo de los datos que la consulta devuelve
  • groupDevices - Para múltiples sites, y sites con múltiples Sockets, combine los analíticos en un solo Socket (para valor booleano true)
• Consulta accountSnapshot
  • id - ID de la cuenta

Errores comunes GRAPHQL_PARSE_FAILED

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

Mensaje: Paréntesis inesperado )

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

Mensaje: Se esperaba un Name, se encontró <character>

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

Mensaje: Se esperaba un Name, se encontró <Invalid>

El mensaje de error indica que hay un valor invá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 argumentos en la consulta.

Mensaje: Se esperaba tipo String!, se encontró <number>

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

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

Mensaje: Se esperaba tipo Int!, se encontró \"<number>\"

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

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

Mensajes de error de la API

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

Mensaje: error de autenticación

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

• En la Aplicación de Gestión de Cato (System > API Access Management), asegúrese de que la clave API que está utilizando siga siendo válida. La clave se elimina cuando es revocada.
• Confirme que la clave esté configurada correctamente en las configuraciones del encabezado HTTP para el software de consulta API: x-api-key <key value>
• Si el problema continúa, genere una nueva clave API y añádala al software de consulta API

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

El valor del argumento groupDevices (accountMetrics) debe ser true cuando la consulta incluye múltiples sites.

Error general de API al ejecutar scripts durante la ventana de mantenimiento

Durante la ventana de mantenimiento (generalmente cada dos domingos), Cato actualiza el servidor de la API y puede estar temporalmente no disponible por hasta dos minutos. Si está ejecutando scripts API recursivos, durante una ventana de mantenimiento el script puede fallar y devolver un error. No hay impacto en los datos de su cuenta.

Para obtener información actualizada sobre las ventanas de mantenimiento programadas y el estado de Cato Cloud, consulte https://status.catonetworks.com/.

Error general de API por tiempo de espera con el servidor de API

Si hay un retraso de más de 40 segundos para una consulta API, entonces hay un tiempo de espera con el servidor API y necesita ejecutar la consulta nuevamente. Le recomendamos que incluya un mecanismo de reintento con un script API para su cuenta Cato. Este mecanismo debe incluir al menos dos intentos de reintento y esperar al menos 30 segundos entre cada intento de reintento.