AccountSnapshot > 用户

UserSnapshot 字段包含有关账户中 VPN 用户的数据。当您运行账户中所有用户的查询时（ID 参数为空），API 调用将返回当前连接到 VPN 和 Cato Cloud 的用户数据。

如果您使用 ID 参数对特定用户进行查询，即使这些用户未连接到 VPN，API 调用也会返回这些用户的数据。

UserSnapshot 字段

UserSnapshot 字段包含已连接 VPN 用户的数据及其与 Cato Cloud 的连接。使用 IDs 参数来指定查询中包含哪些 VPN 用户。

以下是 UserSnapshot 字段可以为查询返回的详细信息：

id - VPN 用户 ID
connectivityStatus - 到 Cato Cloud 的连接性（带有嵌套字段的数组）
operationalStatus - 站点或 VPN 用户的状态（带有嵌套字段的数组）
name - VPN 用户的姓名
deviceName - 计算机或设备的名称
uptime - 客户端已连接到 Cato Cloud 的时长（以秒为单位）
lastConnected - VPN 用户连接到 PoP 的时间戳
version - 客户端软件版本（字符串）
versionNumber - 客户端软件版本（整数）
popID - 客户端连接的 PoP 的 ID
popName - VPN 用户连接的 PoP 的名称
RemoteIP - 客户端的 IP 地址
RemoteIPInfo - 与客户端相关的 IP 地址、ISP 和地理信息
internalIP - 客户端连接的 PoP 的 IP 地址
osType - 客户端运行的设备的操作系统
osVersion - 设备的操作系统版本
devices - 客户端相关的数据（带有嵌套字段的数组）
connectedInOffice - 显示客户端是否使用办公室模式连接到 VPN
metrics - 客户端的实时（基于最近 30 秒）流量指标和数据（带有嵌套字段的数组）
info - 关于 VPN 用户的一般信息（带有嵌套字段的数组）
recentConnections - 近期完成的 VPN 连接数据（带有嵌套查询和字段的数组）

ID

显示账户的唯一 VPN 用户内部 ID，该值不会显示在 Cato 管理应用程序中。

connectivityStatus

用户 > connectivityStatus 字段显示 VPN 用户的连接性：

已连接到 Cato Cloud
已断开从 Cato Cloud

operationalStatus

用户 > operationalStatus 字段显示 VPN 用户的状态：

活跃 - 正在传输流量
已禁用 - 在 Cato 管理应用程序中被禁用
已锁定 - 此 VPN 用户的账户已锁定
新建 - 与 VPN 用户无关
pending_user_configuration - 等待 VPN 用户确认账户
pending_mfa_configuration - 等待 VPN 用户配置 MFA 设置
pending_code_generation - 等待 VPN 用户输入注册码

名称

名称字段显示 Cato 管理应用程序中的 VPN 用户姓名。

deviceName

deviceName 字段显示连接到 Cato Cloud 的计算机或设备的名称。

uptime

uptime 字段显示 VPN 用户连接到 Cato Cloud 的总秒数。

lastConnected

对于未连接到 Cato Cloud 的 VPN 用户，lastConnected 字段显示客户端上次连接到 Cato Cloud 的时间戳。

版本

版本字段显示客户端的版本类型 STRING。

versionNumber

versionNumber 字段显示客户端的版本类型 INT。

popID

用户 > PoP ID 字段显示客户端连接的 PoP 的 ID。

popName

用户 > PoP Name 字段显示客户端连接的 PoP 的名称。

RemoteIP

用户 > RemoteIP 字段显示客户端的 IP 地址。

RemoteIPInfo

用户 > RemoteIPInfo 字段显示与客户端连接的 PoP 的 IP 地址、ISP 和物理位置相关的数据。以下是字段的详细信息：

ip - 连接 PoP 的 WAN 连接的 IP 地址
countryCode - PoP 的物理位置代码（基于 IP 地址地理位置）
countryName - PoP 的物理位置所在的国家（基于 IP 地址地理位置）
city - PoP 所在的城市（基于 IP 地址地理位置）
state - PoP 所在的州（基于 IP 地址地理位置）
provider - Cato Cloud 和 PoP 之间最后一公里连接的 ISP 提供商
latitude - PoP 的纬度（基于 IP 地址地理位置）
longitude - PoP 的经度（基于 IP 地址地理位置）

InternalIP

用户 > internalIP 字段显示客户端连接的 PoP 的 IP 地址。

osType

osType 字段显示客户端安装的设备的操作系统。

osVersion

osVersion 字段显示客户端安装的设备的操作系统版本。

设备

用户 > DeviceSnapshot 字段显示连接到 Cato Cloud 的设备的指标和数据。 DeviceSnapshot 中的某些字段会重复，以便于您更灵活地处理数据。此外，相同的 DeviceSnapshot 基础架构用于 VPN 用户和站点，其中一些字段仅与用户或站点相关。

这是您可以看到的数据：

id - 设备的唯一内部 Cato ID
名称 - 设备的名称
标识符 - 设备的唯一标识符
connected - 一个布尔值，指示客户端是否连接到Cato Cloud
haRole - 此字段用于站点快照 > 站点 > 设备
接口 - 显示客户端的实时数据（包含嵌套查询和字段的数组）
有关DeviceSnapshot的接口字段的更多信息，请参见Cato API - 账户快照 > 站点 > 设备 > 接口。
lastConnected - 客户端连接到Cato Cloud的时间戳
lastDuration - 客户端已连接到Cato Cloud的总时间
connectedSince - 显示客户端活跃连接到Cato Cloud的时间戳
lastPopName - 客户端连接到的PoP 名称
lastPopID - 客户端连接到的PoP ID
指标 - Socket的实时流量和数据（包含嵌套查询和字段的数组）
有关DeviceSnapshot的指标字段的更多信息，请参见Cato API - 账户快照 > 站点 > 设备 > 接口。
recentConnections - 最近完成的流量相关的数据（包含嵌套查询和字段的数组）
有关DeviceSnapshot的recentConnections字段的更多信息，请参见Cato API - 账户快照 > 站点 > 设备。
type - 显示设备类型
uptimeSeconds - 显示客户端已活跃的秒数
socketInfo - 此字段用于站点快照 > 站点 > 设备
interfacesLinkState - 此字段用于站点快照 > 站点 > 设备
osType - 客户端运行的设备的操作系统
osVersion - 设备的操作系统版本
版本 - 客户端软件版本，例如4.4.1234（字符串）
versionNumber - 客户端主要软件版本，例如4（INT）
releaseGroup - 显示客户端的发布状态，如GA 或EA
mfaExpirationTime - 显示MFA 令牌过期前剩余的时间

connectedInOffice

connectedInOffice字段是一个布尔值，当它为真时，表明客户端使用办公室模式连接到网络。

指标

用户 > 指标字段显示客户端的实时流量分析。您可以看到的数据：

duration - 客户端数据的总时间
granularity - 单个指标存储桶的持续时间（秒）
bytesDownstream - 总下行流量（从Cato Cloud到客户端）
bytesUpstream - 总上行流量（从客户端到Cato Cloud）
bytesTotal - 客户端的总流量
lostDownstream - 下行流量丢失的数据包数量
lostDownstreamPcnt - 下行流量丢失的数据包百分比
lostUpstream - 上行流量丢失的数据包数量
lostUpstreamPcnt - 上行流量丢失的数据包百分比
packetsDownstream - 总下行数据包
packetsUpstream - 总上行数据包
jitterUptstream - 上行流量的抖动（数据包之间的时间延迟差异，以毫秒（ms）为单位）
jitterDownstream - 下行流量的抖动（数据包之间的时间延迟差异，以毫秒（ms）为单位）
packetsDiscardedDownstream - 下行流量丢弃的数据包总数
packetsDiscardedUpstream - 上行流量丢弃的数据包总数
rtt - 从客户端到Cato Cloud的往返时间

信息

UserInfo字段显示有关VPN 用户的基本信息，以简明的形式呈现。以下是字段的详细信息：

name - VPN 用户的名称
status - 客户端作为字符串类型的状态
email - VPN 用户的电子邮件地址
creationTime - 创建VPN用户账户的时间戳
phoneNumber - VPN 用户的电话号码
origin - 显示如何将VPN 用户添加到账户：
- regular - 手动添加到Cato管理应用程序中
- LDAP - 使用LDAP 同步添加
authMethod - 此VPN 用户的多因素认证（MFA）设置：
- 无 - VPN 用户无需MFA 即可认证到客户端
- MFA - VPN 用户需要MFA 以认证到客户端

快照 > 用户ID 参数

输入查询返回的数据的VPN 用户ID。当此参数为空时，查询会返回连接到Cato Cloud的所有VPN 用户。

Cato API - AccountSnapshot > 用户