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

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

No se admiten problemas relacionados con scripts y codificación de API.

Argumentos API Requeridos

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 de accountMetrics

    • id - ID de cuenta

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

    • groupDevices - Para múltiples sitios, y sitios con múltiples Sockets, combine los análisis 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 de Cato GraphQL.

Mensaje: Unexpected )

Hay un paréntesis adicional 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: Expected Name, found <character>

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

Mensaje: Expected Name, found <Invalid>

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

Mensaje: Expected type String!, found <number>

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 > sitios) es una CADENA, por lo que debe usar comillas para el valor, ids: ["4242"] es correcto y ids:[4242] produce este error.

Mensaje: Expected type Int!, found \"<number>\"

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 > sitios) 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 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 API para su cuenta. Soluciones sugeridas:

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

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

    • Si la opción Permitir acceso desde Direcciones IP está configurada, el cliente API está realizando la llamada desde una dirección IP permitida específica o rango
  • Confirme 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, genere una nueva clave API y agréguela al software de consulta 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 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.

Conversión de datos de análisis de la 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), necesita dividir por valores exponenciales de 1024: 10242 para MB, y 10243 para GB.

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

¿Fue útil este artículo?

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

0 comentarios