La API appStats se basa en la pantalla de Análisis de Aplicaciones y proporciona datos de red agregados sobre un rango de tiempo por fuente, destino, aplicación, etc.
Cada consulta calcula la agregación sobre diferentes medidas (bytes subidos, bytes bajados, número de flujos, etc.) dado una función de agregación determinada (suma, máx, promedio, etc.) y diferentes dimensiones (nombre_del_sitio, usuario, aplicación, etc.)
Ejemplos de uso de la consulta appStats:
-
Calcular el total/promedio/máximo del ancho de banda de un sitio específico
-
Número máximo de flujos generados a un destino específico
-
Las 10 aplicaciones más usadas por un host dado cierto
Estos son los argumentos que puedes pasar y definir los datos que devuelve la consulta (todos los campos son obligatorios):
Introduce uno o más IDs de cuenta para los datos que la consulta devuelve.
Este ID de cuenta no se muestra en la Aplicación de Gestión de Cato, en su lugar es el número en la URL para la Aplicación de Gestión de Cato. Por ejemplo, el ID de cuenta es 26 para la siguiente URL: https://cc.catonetworks.com/#!/26/topology.
El argumento filtros te permite definir los datos específicos que se incluyen en la consulta. Estos son los argumentos que puedes definir:
-
nombreDeCampo - define el tipo de campo que deseas filtrar (para más información, consulta abajo Campos de appStats)
-
operador - define cómo activar los valores para filtrar los datos (para más información, consulta abajo filterOperator de appStats)
-
valores - define el valor del filtro que se usa con el operador
La siguiente sintaxis de filtros es un ejemplo de una consulta que se filtra para mostrar datos para una aplicación específica:
"filters": [
{
"fieldName": "application",
"operator": "is",
"values": [
"Slack"
]
}
]
Usa el argumento dimensiones para agrupar campos con los mismos valores en filas de resumen.
El siguiente ejemplo, agrupa los campos de acuerdo a los nombres de los sitios:
"dimensions": [
{
"fieldName": "site_name"
}
]
El argumento measures te permite definir los campos que deseas que la consulta devuelva y su tipo de agregación. Estos son los argumentos que puedes definir:
-
nombreDeCampo - define el tipo de campo que deseas filtrar (para más información, consulta abajo Campos de appStats)
-
tipoAgregación - define el tipo de agregación (para más información, consulta abajo Agregación de appStats)
El siguiente ejemplo muestra la sintaxis de measures para una consulta que mide el resumen de los flujos creados para la aplicación de Slack:
"filters": [
{
"fieldName": "application",
"operator": "is",
"values": [
"Slack"
]
}
]
"measures": [
{
"fieldName": "flows_created",
"aggType": "sum"
},
]
El argumento ordenar define cómo se ordenan los datos.
El siguiente ejemplo muestra la sintaxis de ordenar para una consulta que mide el resumen de los flujos creados para la aplicación de Slack. Luego ordena los datos en orden descendente de los flujos creados:
"filters": [
{
"fieldName": "application",
"operator": "is",
"values": [
"Slack"
]
}
]
"measures": [
{
"fieldName": "flows_created",
"aggType": "sum"
},
]
"sort": [
{
"fieldName": "flows_created",
"order": "dec"
},
]
Este es un ejemplo de cómo usar la consulta de API appStats para retornar la suma de flujos creados para la aplicación de Slack para cada sitio durante el periodo de los últimos dos días. Los datos se ordenan en orden descendente para los cinco sitios principales.
Consulta de Ejemplo
query appStats($accountID: ID!, $measures: [Measure], $dimensions: [Dimension], $filters: [AppStatsFilter!], $sort: [AppStatsSort!], $timeFrame: TimeFrame!, $limit: Int, $from: Int) {
appStats(
accountID: $accountID
timeFrame: $timeFrame
measures: $measures
dimensions: $dimensions
filters: $filters
sort: $sort
) {
id
records(limit: $limit, from: $from) {
fieldsUnitTypes
fieldsMap
trends
}
}
}
Valores de las Variables
{
"accountID": "1234",
"dimensions": [
{
"fieldName": "site_name"
}
],
"measures": [
{
"fieldName": "flows_created",
"aggType": "sum"
},
],
"filters": [
{
"fieldName": "application",
"operator": "is",
"values": [
"Slack"
]
}
]
"sort": [
{
"fieldName": "flows_created",
"order": "desc"
}
],
"timeFrame": "last.P2D",
"limit": 5,
"from": 0
}
Salida de Ejemplo de AppStats
{
"data": {
"appStats": {
"id": "1234",
"records": [
{
"fieldsMap": {
"flows_created": "116660",
"site_name": "Sample Socket"
}
},
{
"fieldsMap": {
"flows_created": "105655",
"site_name": " Sample Socket 2"
}
}
]
}
}
}
Esta es una descripción de los campos en las consultas de appStats.
|
Ítem |
Descripción |
|---|---|
|
aplicación |
nombre de la aplicación en la nube |
|
nueva_aplicación |
nuevo identificador de aplicación en la nube |
|
aplicación_descubierta |
número total de aplicaciones usadas |
|
tráfico |
la suma total de datos upstream y downstream en bytes |
|
ascendente |
datos cargados a aplicaciones en la nube |
|
descendente |
datos descargados de aplicaciones en la nube |
|
puntuación_de_riesgo |
la puntuación de riesgo de la aplicación asignada por Cato |
|
nivel_de_riesgo |
el nivel de riesgo de la aplicación |
|
sancionado |
aplicaciones en la nube aprobadas para su uso y gestionadas por la organización |
|
ubicación_sede |
el país en el cual la sede registrada de la aplicación está ubicada |
|
es_aplicación_en_la_nube |
indica si la aplicación se considera una aplicación en la nube o SaaS |
|
categoría |
la categoría de la aplicación en la nube |
|
descripción |
descripción de la categoría |
|
ip |
IP del host o Cliente SDP |
|
subred |
nombre de la subred |
|
dominio |
SSL SNI, nombre de host HTTP, nombre DNS o IP de destino |
|
ip_destino |
dirección IP del servidor (sólo relevante para conexiones WAN) |
|
id_sitio_fuente |
ID interno único de Cato para el sitio |
|
nombre_sitio_fuente |
sitio fuente o usuario SDP |
|
país_sitio |
país donde se ubica el sitio |
|
estado_sitio |
estado donde se ubica el sitio |
|
id_usuario_vpn |
ID interno único de Cato para el usuario SDP |
|
flujos_creados |
Número de conexiones creadas |
|
sitio_destino |
sitio de destino o ID de usuario SDP (proto) |
|
destino_es_sitio_o_vpn |
sitio de destino o usuario SDP |
|
id_sitio_destino |
sitio de destino o ID de usuario SDP (DB) |
|
nombre_sitio_destino |
sitio de destino o nombre de usuario SDP |
|
dirección_de_tráfico |
dirección del tráfico |
|
nombre del dispositivo |
Nombre de PC o dispositivo |
|
nombre_ad |
Nombre de Directorio Activo |
|
src_ip |
Dirección IP para host o Cliente SDP |
|
interfaz_socket |
nombre de la interfaz de Socket |
|
src_es_sitio_o_vpn |
tráfico es sitio o Cliente SDP |
Estos son los valores para el aggType de appStats:
0 comentarios
Inicie sesión para dejar un comentario.