--- title: "Cato API - 账户快照 > 用户" slug: "cato-api-accountsnapshot-users" updated: 2026-07-30T03:23:23Z published: 2026-07-30T03:23:23Z canonical: "knowledge.catonetworks.com/cato-api-accountsnapshot-users" --- > ## 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 - 账户快照 > 用户 ## 账户快照 > 用户 UserSnapshot 字段包含与账户中的 VPN 用户相关的数据。 当您运行查询以获取账户中的所有用户(ID 参数为空)时,API 调用会返回当前连接到 VPN 和 Cato Cloud 的用户数据。 如果您使用 ID 参数来查询特定用户,即使他们未连接到 VPN,API 调用也会返回这些用户的数据。 ## UserSnapshot 字段 UserSnapshot 字段包含已连接的 VPN 用户及其与 Cato 云连接的数据。 使用 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 - info - 关于 VPN 用户的一般信息(带有嵌套字段的数组) - recentConnections - 最近完成的 VPN 连接相关数据(带有嵌套查询和字段的数组) ## ID 显示账户的唯一 VPN 用户内部 ID,此值不会在 Cato 管理应用程序中显示。 ## connectivityStatus 用户 > connectivityStatus 字段显示 VPN 用户的连接情况: - **已连接** 到 Cato 云 - **已断开** 从 Cato 云 ## operationalStatus 用户 > operationalStatus 字段显示 VPN 用户状态: - active - 正在传递流量 - disabled - 在 Cato 管理应用程序中禁用 - locked - 该 VPN 用户的账户被锁定 - new - 对 VPN 用户无关 - pending_user_configuration - 正在等待 VPN 用户确认账户 - pending_mfa_configuration - 正在等待 VPN 用户配置多因素身份验证设置 - pending_code_generation - 正在等待 VPN 用户输入注册代码 ## 名称 名称字段显示 Cato 管理应用程序中 VPN 用户的名称。 ## 设备名称 deviceName 字段显示连接到 Cato 云的计算机或设备的名称。 ## uptime uptime 字段显示 VPN 用户连接到 Cato Cloud 的总时间(以秒为单位)。 ## lastConnected 对于未连接到 Cato 云的 VPN 用户,lastConnected 字段显示客户端最后一次连接到 Cato 云的时间。 ## version version 字段显示客户端的字符串类型版本。 ## versionNumber versionNumber 字段显示客户端的整数类型版本。 ## PoPID 用户 > PoPID 字段显示客户端连接的 PoP 的 ID。 ## PoP名称 用户 > PoPName 字段显示客户端连接的 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 - name - 设备名称 - identifier - 设备的唯一标识符 - connected - 一个布尔值,表示客户端是否连接到 Cato Cloud - haRole - 此字段用于 SiteSnapshot > Site > Devices - interfaces - 显示客户端的实时数据 (带嵌套查询和字段的数组) 有关 DeviceSnapshot 的接口字段的更多信息,请参阅 [Cato API - AccountSnapshot > Sites > Devices > Interfaces](/v1/docs/cato-api-accountsnapshot-sites-devices-interfaces)。 - lastConnected - 客户端连接到 Cato Cloud 的时间戳 - lastDuration - 客户端连接到 Cato Cloud 的总时间 - connectedSince - 显示客户端连接到 Cato Cloud 的持续时间戳 - lastPopName - 客户端连接的 PoP 名称 - lastPopID - 客户端连接的 PoP ID - recentConnections - 与最近完成的流量相关的数据 (带嵌套查询和字段的数组) 有关 DeviceSnapshot 的 recentConnections 字段的更多信息,请参阅 [Cato API - AccountSnapshot > Sites > Devices](/v1/docs/cato-api-accountsnapshot-sites-devices)。 - type - 显示设备类型 - uptimeSeconds - 显示客户端活跃的秒数 - socketInfo - 此字段用于 SiteSnapshot > Site > Devices - interfacesLinkState - 此字段用于 SiteSnapshot > Site > Devices - osType - 客户端运行的设备操作系统 - osVersion - 设备的操作系统版本 - version - 客户端软件版本,例如 4.4.1234 (字符串) - versionNumber - 客户端主要软件版本,例如 4 (整数) - releaseGroup - 显示客户端的发布状态,例如 GA 或 EA - mfaExpirationTime - 显示 MFA 令牌过期前的剩余时间 ## connectedInOffice connectedInOffice 字段是一个布尔值,当其为 **true** 时,表明客户端使用 Office 模式连接到网络。 ## 信息 用户信息字段显示关于 VPN 用户的基本信息,以简洁的方式呈现。 这些是字段的详细信息: - name - VPN 用户名称 - status - 客户端状态为字符串类型 - email - VPN 用户的电子邮件地址 - creationTime - VPN 用户创建在账户中的时间戳 - phoneNumber - VPN 用户的电话号码 - origin - 显示 VPN 用户如何添加到账户中: - regular - 在 Cato 管理应用程序中手动添加 - LDAP - 通过 LDAP 同步添加 - authMethod - VPN 用户的多因素认证 (MFA) 设置: - None - VPN 用户无需 MFA 来验证客户端身份 - MFA - VPN 用户需要 MFA 来验证客户端身份 ## RecentConnections 用户 > RecentConnections 字段显示最新客户端连接到 Cato Cloud 的相关数据。 这些是该字段可以返回的查询详细信息: - duration - 查询数据的总时间 - interfaceName - Cato 管理应用程序中的端口名称 - deviceName - 安装客户端的设备名称 - lastConnected - 显示客户端连接到 Cato Cloud 的时间戳 - popID - 客户端连接的 PoP ID - popName - 客户端连接的 PoP 名称 - remoteIP - 客户端的 IP 地址 - remoteIPInfo - 与流量流量连接的 PoP 相关的 IP 地址、ISP 和地理信息 ## 快照 > 用户 ID 参数 输入查询返回的 VPN 用户 ID 数据。 当该参数为空时,查询返回连接到 Cato Cloud 的所有 VPN 用户。