Cato Read Only API - appStats – База знаний

Обзор appStats

API appStats основано на экране Application Analytics и предоставляет агрегированные сетевые данные за период времени по источнику, назначению, приложению и так далее.

Каждый запрос выполняет агрегацию по различным показателям (байты вверх, байты вниз, количество потоков и др.) с использованием определенной функции агрегации (сумма, макс, среднее и др.) и различных размерностей (имя площадки, пользователь, приложение и др.)

Примеры использования запроса appStats:

Рассчитать общий/средний/максимальный пропускную способность конкретной площадки
Максимальное количество потоков, созданных для конкретного назначения
Топ 10 используемых приложений по заданному хосту

Аргументы для appStats

Это аргументы, которые вы можете передать и определить данные, возвращаемые запросом (все поля обязательны):

accountIDs
measures
filters
dimension
sort
timeframe

Аргумент appStats accountIDs

Введите один или несколько ID учетных записей для данных, которые возвращает запрос.

Этот ID учетной записи не отображается в Приложение Управления Cato, вместо этого это номер в URL для Приложение Управления Cato. Например, ID учетной записи равен 26 для следующего URL: https://cc.catonetworks.com/#!/26/topology.

Аргумент appStats filters

Аргумент filters позволяет определить конкретные данные, которые включены в запрос. Это аргументы, которые вы можете определить:

fieldName - определяет тип поля, который вы хотите отфильтровать (для получения дополнительной информации, смотрите ниже appStats Fields)
operator - определяет, как активировать значения для фильтрации данных (для получения дополнительной информации, смотрите ниже appStats filterOperator)
values - определяет значение фильтра, которое используется с оператором

Следующий синтаксис filters является примером запроса, который фильтруется, чтобы показать данные для конкретного приложения:

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

Аргумент appStats dimensions

Используйте аргумент dimensions, чтобы сгруппировать поля с одинаковыми значениями в сводные строки.

Следующий пример группирует поля по названиям площадок:

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

Аргумент appStats measures

Аргумент measures позволяет определить поля, которые вы хотите, чтобы запрос возвратил, и их тип агрегации. Это аргументы, которые вы можете определить:

fieldName - определяет тип поля, которое вы хотите отфильтровать (для получения дополнительной информации, смотрите ниже appStats Fields)
aggType - определяет тип агрегации (для получения дополнительной информации, смотрите ниже appStats Aggregation)

Следующий пример показывает синтаксис measures для запроса, который измеряет сводку потоков, созданных для приложения Slack:

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

]

Аргумент appStats sort

Аргумент sort определяет, как данные сортируются.

Следующий пример показывает синтаксис sort для запроса, который измеряет сводку потоков, созданных для приложения Slack. Затем сортирует данные в порядке убывания по количеству созданных потоков:

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

]
"sort": [
    {
        "fieldName": "flows_created",
        "order": "dec"
    },

]

Аргумент appStarts timeframe

Определяет timeframe запроса.

"timeFrame": "last.P2D"

Пример запроса appStats

Это пример использования запроса API appStats для возврата суммы созданных потоков для приложения Slack для каждой площадки за период последних двух дней. Данные сортируются в порядке убывания для пяти лучших площадок.

Пример запроса

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
   
    }
  }
}

Значения переменных

{
  "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
}

Вывод appStats

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

Поля appStats

Это описание полей в запросах appStats.

Элемент	Описание
Приложение	Имя облачного приложения
новое приложение	идентификатор нового облачного приложения
обнаруженное приложение	общее количество использованных приложений
трафик	общая сумма данных вверх и вниз в байтах
вверх	данные, загруженные в облачные приложения
вниз	данные, загруженные из облачных приложений
оценка риска	оценка риска приложения, назначенная Cato
уровень риска	уровень риска приложения
санкционированный	облачные приложения, утвержденные для использования и управляемые организацией
расположение штаб квартиры	страна, в которой расположена зарегистрированная штаб-квартира приложения
является облачным приложением	указывает, считается ли приложение облачным/SaaS
категория	категория облачного приложения
описание	описание категории
ip	IP-адрес хоста или SDP клиента
подсеть	название подсети
домен	название SSL SNI, HTTP хоста, DNS или IP назначения
ip назначения	IP-адрес сервера (актуально только для WAN-соединений)
id источника площадки	уникальный внутренний Cato ID для площадки
имя источника площадки	источниковая площадка или пользователь SDP
страна площадки	страна, где расположена площадка
штат площадки	штат, где расположена площадка
id пользователя vpn	уникальный внутренний Cato ID для пользователя SDP
созданные потоки	Количество созданных соединений
место назначения	место назначения или ID пользователя SDP (proto)
место назначения или vpn	место назначения или пользователь SDP
id места назначения	место назначения или ID пользователя SDP (DB)
имя места назначения	имя места назначения или имя пользователя SDP
направление трафика	направление трафика
device_name	Имя ПК или устройства
ad_name	Имя Active Directory
src_ip	IP-адрес для хоста или SDP Клиента
socket_interface	название для интерфейса Socket
src_is_site_or_vpn	трафик является сайтом или SDP Клиентом

appStats Аггрегация

Это значения для appStats aggType:

сумма
количество
количество_уникальных
уникальные
среднее
максимум
минимум
любой

appStats оператор_фильтра

Это значения для appStats оператор_фильтра:

равно
не равно
входит в
не входит в
существует
не существует
между
не между
больше
больше или равно
меньше
меньше или равно

Cato Read Only API - appStats