Cato Ler Apenas API - appStats – Base de Conhecimento

Visão geral do appStats

A API appStats é baseada na tela Analytics da Aplicação e fornece dados agregados de rede ao longo de um intervalo de tempo por fonte, destino, aplicativo, e assim por diante.

Cada consulta calcula a agregação sobre diferentes medidas (bytes enviados, bytes recebidos, número de fluxos, etc...) dada uma certa função de agregação (soma, máximo, média, etc...) e diferentes dimensões (nome_do_site, usuário, aplicativo, etc...)

Exemplos de uso da consulta appStats:

Calcular total/média/máximo de largura de banda de um site específico
Máximo número de fluxos gerados para um destino específico
Os 10 aplicativos mais usados por um determinado host

Argumentos para appStats

Estes são os argumentos que você pode passar e definir os dados que são retornados pela consulta (todos os campos são obrigatórios):

IDs de contas
medidas
filtros
dimensão
classificação
intervalo de tempo

Argumento appStats ID da Conta

Insira um ou mais IDs de contas para os dados que a consulta retorna.

Este ID da conta não é mostrado no Aplicativo de Gerenciamento Cato, em vez disso, é o número na URL para o Aplicativo de Gerenciamento Cato. Por exemplo, o ID da conta é 26 para a seguinte URL: https://cc.catonetworks.com/#!/26/topologia.

Argumento appStats filtros

O argumento filtros permite definir os dados específicos que são incluídos na consulta. Estes são os argumentos que você pode definir:

fieldName - define o tipo de campo que você deseja filtrar (para mais informações, consulte abaixo Campos appStats)
operator - define como ativar os valores para filtrar os dados (para mais informações, consulte abaixo Operador de filtro appStats)
values - define o valor do filtro que é usado com o operador

A seguinte sintaxe de filtros é um exemplo de uma consulta que é filtrada para mostrar dados para uma aplicação específica:

"filters": [
    {
        "fieldName": "application",
        "operator": "is",
        "values": [
            "Slack"
        ]
    }
]

Argumento appStats dimensões

Use o argumento dimensões para agrupar campos com os mesmos valores em linhas de resumo.

O exemplo a seguir agrupa os campos de acordo com os nomes dos sites:

"dimensions": [
    {
        "fieldName": "site_name"
    }
]

Argumento appStats medidas

O argumento medidas permite definir os campos que você deseja que a consulta retorne e seu tipo de agregação. Estes são os argumentos que você pode definir:

fieldName - define o tipo de campo que você deseja filtrar (para mais informações, consulte abaixo Campos appStats)
aggType - define o tipo de agregação (para mais informações, consulte abaixo Agregação appStats)

O exemplo a seguir mostra a sintaxe de medidas para uma consulta que mede o resumo dos fluxos criados para o aplicativo Slack:

"filters": [
    {
        "fieldName": "application",
        "operator": "is",
        "values": [
            "Slack"
        ]
    }
]
"measures": [
    {
        "fieldName": "flows_created",
        "aggType": "sum"
    }
]

Argumento appStats classificação

O argumento classificação define como os dados são classificados.

O exemplo a seguir mostra a sintaxe de classificação para uma consulta que mede o resumo dos fluxos criados para o aplicativo Slack. Em seguida, classifica os dados em ordem decrescente de fluxos criados:

"filters": [
    {
        "fieldName": "application",
        "operator": "is",
        "values": [
            "Slack"
        ]
    }
]
"measures": [
    {
        "fieldName": "flows_created",
        "aggType": "sum"
    }
]
"sort": [
    {
        "fieldName": "flows_created",
        "order": "desc"
    }
]

Argumento appStarts intervalo de tempo

Define o intervalo de tempo da consulta.

"intervalo de tempo": "últimos.P2D"

Consulta de exemplo appStats

Este é um exemplo de uso da consulta API appStats para retornar a soma de fluxos criados para o aplicativo Slack para cada site ao longo do período de tempo dos últimos dois dias. Os dados são classificados em ordem decrescente para os cinco principais sites.

Consulta de Exemplo

consulta appStats($accountID: ID!, $medidas: [Medida], $dimensões: [Dimensão], $filtros: [AppStatsFiltro!], $classificação: [AppStatsClassificação!], $intervalo de tempo: Intervalo de Tempo!, $limite: Int, $de: Int) {
  appStats(
    accountID: $accountID
    timeFrame: $intervalo de tempo
    medidas: $medidas
    dimensões: $dimensões
    filtros: $filtros
    classificação: $classificação
  ) {
    id
    records(limite: $limite, de: $de) {
      fieldsUnitTypes
      fieldsMap
      trends
    }
  }
}

Valores de variáveis

{
  "accountID": "1234",
  "dimensões": [
    {
      "fieldName": "site_name"
    }
  ],
  "medidas": [
    {
      "fieldName": "flows_created",
      "aggType": "sum"
    }
  ],
"filters": [
    {
        "fieldName": "application",
        "operator": "is",
        "values": [
            "Slack"
        ]
    }
]
  "classificação": [
    {
      "fieldName": "flows_created",
      "order": "desc"
    }
  ],
  "intervalo de tempo": "últimos.P2D",
  "limite": 5,
  "de": 0
}

Saída de Exemplo AppStats

{
    "data": {
      "appStats": {
        "id": "1234",
        "records": [
          {
            "fieldsMap": {
              "flows_created": "116660",
              "site_name": "Sample Socket"
            }
          },
          {
            "fieldsMap": {
              "flows_created": "105655",
              "site_name": "Sample Socket 2"
            }
          }
        ]
      }
    }
  }

Campos appStats

Esta é uma descrição dos campos nas consultas de appStats.

Item	Descrição
aplicação	nome da aplicação na nuvem
nova_aplicação	novo identificador de aplicação na nuvem
aplicação_descoberta	número total de aplicativos utilizados
tráfego	a soma total dos dados enviados e recebidos em bytes
fluxo ascendente	dados enviados para aplicativos na nuvem
fluxo descendente	dados baixados de aplicativos na nuvem
score_de_risco	a pontuação de risco da aplicação atribuída pelo Cato
nível_de_risco	o nível de risco da aplicação
autorizado	aplicativos na nuvem aprovados para uso e gerenciados pela organização
localização_da_sede	o país onde a sede registrada da aplicação está localizada
é_aplicação_na_nuvem	indica se a aplicação é considerada um aplicativo na nuvem/app SaaS
categoria	a categoria de aplicação na nuvem
descrição	descrição da categoria
ip	IP do host ou Cliente SDP
subnet	nome da subnet
domínio	SNI SSL, nome do host HTTP, nome DNS ou IP do destino
ip_de_destino	endereço IP do servidor (apenas relevante para conexões WAN)
id_do_site_de_origem	ID interna única do Cato para o site
nome_do_site_de_origem	site de origem ou usuário SDP
país_do_site	país onde o site está localizado
estado_do_site	estado onde o site está localizado
id_do_usuário_vpn	ID interna única do Cato para o usuário SDP
fluxos_criados	Número de conexões criadas
site_de_destino	site de destino ou ID do usuário SDP (proto)
destino_é_site_ou_vpn	site de destino ou usuário SDP
id_do_site_de_destino	site de destino ou ID do usuário SDP (DB)
nome_do_site_de_destino	site de destino ou nome de usuário SDP
direção_do_tráfego	direção do tráfego
device_name	Nome do PC ou dispositivo
ad_name	Nome do Active Directory
src_ip	IP para host ou Cliente SDP
socket_interface	Nome para interface de Socket
src_is_site_or_vpn	O tráfego é site ou Cliente SDP

agregação de appStats

Estes são os valores para o appStats aggType:

soma
contagem
contagem_distinta
distinto
média
max
min
qualquer

appStats filterOperator

Estes são os valores para o appStats filterOperator:

é
não_é
em
não_em
existe
não_existe
entre
não_entre
maior_que
maior ou igual
menor_que
menor ou igual

Cato Ler Apenas API - appStats