卡托只读 API - 应用程序统计

应用程序统计概览

应用程序统计 API 基于应用程序分析屏幕,提供按来源、目的地、应用程序等的时间范围内的网络数据汇总。

每个查询在给定的聚合功能(求和,最大值,平均值等)和不同维度(网站名称,用户,应用程序等)下计算不同指标(上传字节数,下载字节数,流数量等)的聚合。

应用程序统计查询的使用示例:

  • 计算特定站点的总/平均/最大带宽

  • 产生到特定目的地的最大流数量

  • 特定主机使用的前 10 个应用程序

应用程序统计的参数

这些是您可以传递的参数,这些参数定义查询返回的数据(所有字段均为必填项):

  • 账户 ID

  • 指标

  • 过滤器

  • 维度

  • 排序

  • 时间范围

应用程序统计账户 ID 参数

输入一个或多个账户 ID,以确定查询返回的数据。

此账户 ID 不显示在 Cato 管理应用程序中,而是 URL 中 Cato 管理应用程序的号码。 例如,以下 URL 的账户 ID 为 26:https://cc.catonetworks.com/#!/26/topology。

应用程序统计过滤器参数

过滤器参数让您定义查询中包含的特定数据。 这些是您可以定义的参数:

  • 字段名称 - 定义要过滤的字段类型(有关详细信息,请参阅下方应用程序统计字段)

  • 操作符 - 定义如何激活值以过滤数据(有关更多信息,请参阅下方应用程序统计过滤器操作符)

  • 值 - 定义与操作符一起使用的过滤器值

以下过滤器语法是一个过滤查询示例,显示特定应用程序的数据:

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

应用程序统计维度参数

使用维度参数将拥有相同值的字段分组为汇总行。

以下示例根据网站名称分组字段:

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

应用程序统计措施参数

措施参数允许您定义要查询返回的字段及其聚合类型。 这些是您可以定义的参数:

  • 字段名称 - 定义要过滤的字段类型(有关详细信息,请参阅下方应用程序统计字段)

  • 聚合类型 - 定义聚合类型(有关更多信息,请参阅下方应用程序统计聚合)

下面的示例显示了一个查询的措施语法,用于测量为 Slack 应用程序创建的流总数:

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

]

应用程序统计排序参数

排序参数定义数据如何排序。

下面的示例显示了一个查询的排序语法,测量为 Slack 应用程序创建的流总数。 然后按创建的流的降序排列数据:

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

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

]

应用程序统计时间范围参数

定义查询的时间范围。

"timeFrame": "last.P2D"

应用程序统计查询示例

这是一个使用应用程序统计 API 查询的示例,返回过去两天根据站点的 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
}

应用程序统计输出示例

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

应用程序统计字段

这是应用程序统计查询中字段的描述。

项目

描述

应用程序

云应用程序名称

新增应用

新增云应用程序标识

被发现的应用

使用的应用程序总数

流量

上行和下行数据总和,单位字节

上行

上传到云应用程序的数据

下行

从云应用程序下载的数据

风险得分

由卡托分配的应用程序风险得分

风险级别

应用程序的风险级别

认可

经过组织批准并管理的云应用程序

总部位置

注册应用程序总部所在的国家

是否为云应用

指示应用程序是否被认为是云应用程序/ SaaS 应用程序

类别

云应用程序类别

描述

类别描述

IP

主机或 SDP 客户端的 IP

子网

子网的名称

SSL SNI、HTTP 主机名、DNS 名称或目标 IP

目标 IP

服务器 IP 地址(仅适用于 WAN 连接)

源站点 ID

站点的独特内部卡托 ID

源站点名

源站点或 SDP 用户

网站国家

站点所在的国家

网站状态

站点所在的州

VPN 用户 ID

SDP 用户的独特内部卡托 ID

创建的流量

创建的连接数

目标站点

目标站点或 SDP 用户 ID(原型)

目标是站点或 VPN

目标站点或 SDP 用户

目标站点 ID

目标站点或 SDP 用户 ID(数据库)

目标站点名称

目标站点或 SDP 用户名

流量方向

流量方向

设备名称

PC或设备名称

广告名称

Active Directory名称

源IP

主机或SDP客户端的IP

接口插座

插座接口的名称

源是站点或VPN

流量是站点或SDP客户端

应用统计汇聚

这些是appStats aggType的值:

  • 总和

  • 计数

  • 计数_独立

  • 独立

  • 平均值

  • 最大值

  • 最小值

  • 任意

应用统计过滤运算符

这些是应用统计过滤运算符的值:

  • 不是

  • 不在

  • 存在

  • 不存在

  • 在之间

  • 不在之间

  • 大于

  • 大于或等于

  • 小于

  • 小于或等于

这篇文章有帮助吗?

1 人中有 0 人觉得有帮助

0 条评论