Documentation Index

Fetch the complete documentation index at: https://knowledge.catonetworks.com/llms.txt

Use this file to discover all available pages before exploring further.

Cato API - AccountMetrics > 站点 > 接口

Prev Next

AccountMetrics > 站点 > 接口

AccountMetrics > 站点 > 接口字段包含与站点的Socket WAN链路相关的数据。

接口指标字段

接口指标字段包含Socket WAN链路的数据。 以下是查询的详细信息和字段:

  • metrics - 链路的流量数据(具有嵌套字段的数组)

  • 名称 - Cato 管理应用程序中的链路名称

  • timeseries - 数据的时间范围,并定义桶和数据之间的关系(具有嵌套查询和字段的数组)

  • annotations - 时间戳注释,显示GUI的时间增量(具有嵌套查询和字段的数组)

  • periods - 代表特定时间持续的对象(具有嵌套字段的数组)

  • info (SocketInterface) - 与链路相关的数据,例如网关IP 地址(具有嵌套字段的数组)

  • remoteIPinfo - 与链路IP 地址相关的数据,例如国家代码(具有嵌套字段的数组)

  • remoteIP - 此链接的 ISP 的 IP 地址

  • socket信息 - 与Socket和vSocket站点相关的数据,例如序列号和Socket版本(包含嵌套字段的数组)

  • ipsec信息 - 与IPsec站点相关的数据,例如IKE版本(包含嵌套字段的数组)

  • interfaceInfo - 关于Socket接口的基本配置信息(具有嵌套字段的数组)

指标 (InterfaceMetrics)

指标字段显示WAN 链路的流量分析。 这些是字段的详细信息:

  • duration - Socket数据的总时间

  • granularity - 单个指标桶的持续时间,以秒为单位

  • bytesDownstream - 总下行流量(从Cato Cloud到Socket)

  • bytesUpstream - 总上行流量(从Socket到Cato Cloud)

  • bytesTotal - Socket的总流量

  • lostDownstream - 下行流量丢失的数据包数

  • lostDownstreamPcnt - 下行流量丢失的数据包百分比

  • lostUpstream - 上行流量丢失的数据包数

  • lostUpstreamPcnt - 上行流量丢失的数据包百分比

  • packetsDownstream - 总下行数据包

  • packetsUpstream - 总上行数据包

  • jitterUpstream - 上行流量的抖动(数据包之间的时间延迟差异,以毫秒(ms)为单位)

  • jitterDownstream - 下行流量的抖动(数据包之间的时间延迟差异,以毫秒(ms)为单位)

  • packetsDiscardedDownstream - 下行流量丢弃的数据包总数

  • packetsDiscardedUpstream - 上行流量丢弃的数据包总数

  • rtt - 从Socket到Cato Cloud的往返时间

toRate 参数

当bool参数toRate设置为true时,数据以每秒返回。 当参数设置为 false 时,查询返回整个时间段内的数据。

toRate 参数仅适用于以字节为单位的数据类型,不适用于RTT、健康状况等。

Name

名称字段显示在Cato管理应用程序中配置的链路名称(配置 > 站点 > Socket 配置)。

时间序列

接口指标时间序列字段根据查询中指定的时间范围(桶)显示链路的指标。 包括历史和接近实时的统计数据和指标。

接口指标时间序列字段和参数的详细信息与AccountMetrics时间序列相同,请参见 Cato API - AccountMetrics > 时间序列

注释

注释字段和参数根据时间和事件类型显示特定事件。 这些是字段的详细信息:

  • time - 事件的时间戳

  • label - 事件的描述

  • shortLabel - 事件的简短描述

  • type - 事件的类型

    • popChange - 站点连接到不同的PoP

    • roleChange - HA 状态角色变更

    • remoteIPChange - ISP IP地址(远程IP)已更改

    • generic - 注释中包含的其他事件

注释类型参数

指定查询中包含的事件类型:popChange、roleChange或generic。

周期

周期字段显示指定时间持续的周期类型指标。 这些是字段的详细信息:

  • duration - 一个表示开始和结束时间的数字元组(以毫秒为单位),根据起始和结束桶索引

  • title - 描述指标的标签

  • type - 识别此周期数据类型的枚举数组:

    • packetLoss - 由于连接问题造成的数据包丢失

    • missingData - 此周期无可用数据

    • passiveLink - 链路处于待机模式,不传递流量

    • active - 链路处于活动负载状态并传递流量

    • overflowed - 一些数据包被排队并延迟发送

    • congested - 一些数据包因在队列中超时而被丢弃

    • lastmilePacketLoss - 在Socket和PoP之间测量的数据包丢失

    • lastmileLatency - 在Socket和PoP之间测量的延迟

    • generic - 来自未知因素影响链路

    • pop - 当前链接的特定PoP

remoteIP信息

remoteIP信息字段显示链路的IP地址的数据。 以下是与IP地址相关字段的详细信息:

  • ip - 链路的IP 地址

  • countryCode - 地理位置ISO 国家代码

  • countryName - 地理位置国家名称

  • city - 地理位置城市

  • state - 地理位置状态

  • provider - ISP 互联网提供商

  • latitude - ISP的地理位置纬度

  • longitude - ISP的地理位置经度

remoteIP

remoteIP 字段显示链接的 IP 地址,不包括来自 remoteIPInfo 的额外数据。

socketInfo

socketInfo 字段显示关于 Socket 的数据,如版本号和序列号。 这些是字段的详细信息:

  • ID(id) - Socket的唯一ID

  • serial - Socket 的序列号

  • isPrimary - 对于 HA 配置,当此布尔值为 true 时,这是主 Socket

  • 平台 - 显示Socket类型:

    • not_set - 没有为 Socket 设置平台

    • VM - 旧值

    • X1 - 旧值

    • X1500 - X1500 Socket

    • NATIVE - 旧值

    • X1500_BR2 - 待定

    • X1700 - X1700 Socket

    • AWS1500 - AWS vSocket

    • RPI64 - 旧值

    • AZ1500 - Azure vSocket

    • ESX1500 - VMware ESX vSocket

  • 版本 - 当前安装在Socket上的软件版本号

  • 版本更新时间 - Socket升级到当前硬件版本的时间戳

ipsecInfo

ipsecInfo 字段显示有关 IPsec 站点连接设置的数据。 这些是字段的详细信息:

  • isPrimary - 对于HA 配置,当此布尔值为真时,这是主要IPsec防火墙或路由设备

  • catoIP - Cato云中IPsec隧道的源IP 地址

  • remoteIP - IPsec隧道(在站点中)的目标IP地址

  • ike版本 - 显示1表示IKEv1,2表示IKEv2

interfaceInfo

interfaceInfo 字段包含在 Cato 管理应用程序中配置的站点 Socket 端口相关的数据(Configuration > 站点 > Socket 配置)。 这些是字段的详细信息:

  • id - Socket WebUI 监控 标签页中的 Socket 端口 ID

  • name - Cato 管理应用程序中该端口的名称

  • upstreamBandwidth - 从站点到 Cato Cloud 流量的此端口允许的最大带宽

  • downstreamBandwidth - 从 Cato Cloud 到站点的流量在此端口允许的最大带宽