Press CTRL+K to open search

配置 API - 更新 Socket 接口

  • 更新于 Jul 30, 2026
  • 发布于 Jul 7, 2026
  • 2 分钟阅读
Prev Next

我们强烈建议您在开始使用Cato API之前，请查看Cato API支持政策。

更新SocketInterface概述

使用 updateSocketInterface mutation API 在 Cato 管理应用 (网络 > 站点 > {site name} > 站点配置 > Socket) 的 Socket 部分更新以下 Socket 接口设置

  • 接口的目的地

  • Name

  • LAN 接口设置

  • 站点带宽

  • WAN 接口设置

  • 脱离云 (适用于 Cato 目的地)

  • 备用 WAN 接口设置

  • LAG (链路聚合) 成员

  • VRRP 类型

定位站点的站点 ID

站点 ID 未显示在 Cato 管理应用程序中，您可以定位站点 ID：

  • 使用 entityLookup API 查询（请参阅Cato API - EntityLookup），使用类型，值为site

    您还可以使用 search 参数，将值设为站点名称，查询返回站点 ID

  • Cato 管理应用程序的 URL 中的数字，当您选择了一个站点时 (网络 > 站点 > {site name})。 例如，此网址的站点 ID 是 12345： https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

了解 Socket 的 socketInterfaceId 值

socketInterfaceId 是一个枚举，其中包含 Cato Sockets 的值。 站点的 Sockets 屏幕中会显示接口名称 (网络 > 站点 > {site name} > 站点配置 > Socket)，如下所示：

  • X1500 Socket - 自动, LAN1, LAN2, WAN1, WAN2, WAN3, USB1, USB2

  • X1600 Socket - 1-8, USB1, USB2

  • X1700 Socket - INT_1 - INT_12

updateSocketInterfaceInput 参数的详细信息

以下是使用 Cato 配置 API 更新站点 Socket 接口设置的参数。 仅 destType 参数是必需的，否则请包括您正在更新的 Socket 接口设置的参数。

  • destType - 接口的目的地

  • name - 站点的名称

  • lan - LAN 接口设置

  • bandwidth - 站点的上行和下行带宽

  • wan - WAN 接口设置

  • offCloud - 对于目的地为 Cato 的接口的 脱离云 设置

  • altWAN - 对于目的地为 备用 WAN 或 备用 WAN (二层) 的接口的设置

  • lag - 对于目的地为 LAN LAG 主控制端的接口，该链路聚合 (LAG) 的最少链路数（包括主控端和成员）

  • vrrp - 对于 Socket 高可用性 (HA) 配置，Socket 之间 VRRP 连接的类型

updateSocketInterfaceInput destType

destType 是一个枚举参数，它定义了接口的目的地。

这些是选项：

  • CATO - Cato Cloud 的 WAN 流量

  • LAN - 连接 Socket 的内部 LAN

  • VRRP_AND_LAN - 对于 Socket HA，接口用于 LAN 和 VRRP 流量

  • INTERFACE_DISABLED - 接口被禁用且不传送流量

  • ALTERNATIVE - 非 Cato Cloud 的 WAN 流量，例如 MPLS

  • LAYER_2_WAN - 备用 WAN (二层) 选项适用于在同一子网中的 Socket 站点的 MPLS 网络

  • VRRP - 对于 Socket HA，接口仅用于 VRRP 流量

  • LAN_LAG_MASTER_AND_VRRP - 对于 Socket HA 和 LAN LAG 配置，接口是 LAN LAG 主控端并用于 VRRP 流量

  • LAN_LAG_MASTER - 对于 LAN LAG 配置，接口是 LAN LAG 主控端

  • LAN_LAG_MEMBER - 对于 LAN LAG 配置，接口是 LAN LAG 成员

  • LAN_AND_HA - 对于 Azure 和 AWS 中的 vSocket HA，接口用于 LAN 和 HA 流量

updateSocketInterfaceInput 名称

name 参数用于指定 Socket 接口的名称。

updateSocketInterfaceInput lan

lan 参数用于 Socket 的 LAN 接口设置。

这些是选项:

  • subnet - 用于 LAN 接口的本机范围，格式为 CIDR

  • localIP - LAN 网络范围的本地 IP 地址

updateSocketInterfaceInput 带宽

对于用于 WAN 流量的接口，bandwidth 参数定义接口的上行和下行带宽。

这些是选项:

  • upstreamBandwidth - 此接口的最大上行带宽

  • downstreamBandwidth - 此接口的最大下行带宽

updateSocketInterfaceInput wan

wan 参数用于 Socket 的 WAN 接口设置。 WAN 角色通常用于定义网络规则中的流量。 优先级用于具有主动和被动接口的 Socket 的故障转移优先级。

这些是选项:

  • 角色 - 定义 WAN 接口的角色: 无, 自动, wan_1, wan_2, wan_3

  • 优先级 - 定义接口的故障转移优先级: 活跃, 被动, 最后手段

    最后手段 是优先级最低的接口

updateSocketInterfaceInput offCloud

offCloud 参数用于使用离线云功能通过公共互联网而不是通过卡托云路由流量的 Socket 站点。

这些是选项:

  • 启用 - 布尔值，当真时，站点的离线云流量已启用

  • publicIP (可选) - 定义用于连接互联网的静态公共 IP 地址

  • publicStaticPort (可选) - 定义离线云流量的静态端口号

updateSocketInterfaceInput altWan

altWan 参数用于连接到备用 WAN 网络（如 MPLS）的 Socket 站点。 通常使用私有 IPs 和接口直接连接到 MPLS 提供商。

这些是选项:

  • privateInterfaceIp - Socket 接口用于流量的私有 IP 地址

  • privateNetwork - 局域网的私有 IP 范围（带 CIDR）

  • privateGatewayIp - 备用 WAN 网关（如 MPLS 防火墙或路由器）的私有 IP 地址

  • privateVlanTag (可选) - 接口的 VLAN 标签（私有 IP 地址）

  • publicInterfaceIP (可选) - Socket 接口用于流量的公共 IP 地址

  • publicNetwork (可选) - 局域网的公共 IP 范围（带 CIDR）

  • publicGatewayIp (可选) - 备用 WAN 网关（如 MPLS 防火墙或路由器）的公共 IP 地址

  • publicVlantag (可选) - 接口的 VLAN 标签（公共 IP 地址）

updateSocketInterfaceInput lag

lag 参数用于主 LAN LAG 接口，并定义 LAG 的最小接口数量（包括主控和成员）用于此 Socket 站点。

这是选项:

  • minLinks - LAG 中的最小接口（链路）数量

updateSocketInterfaceInput vrrp

vrrp 枚举参数用于 Socket HA 配置，并定义 Sockets 之间用于保持活动消息的 VRRP 连接类型。

这些是选项：

  • VIA_SWITCH - VRRP 连接通过 Sockets 之间的交换机路由

  • DIRECT_LINK - VRRP 连接直接在 Sockets 之间路由

示例Postman脚本

示例脚本 - 更新原生范围和名称

这是一个使用配置 API 将 LAN1 接口的名称更改为 LAN-01，并更新套接字的原生范围的子网和本地 IP 的示例。

mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
 site(accountId: $accountId) {
 updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
 siteId
 socketInterfaceId
 }
 }
}

GraphQL变量

{
 "accountId": "26",
 "siteId": 26,
 "socketInterfaceId": "LAN1",
 "input": {
 "name": "LAN-01",
 "destType": "LAN",
 "lan": {
 "subnet": "10.0.0.0/24",
 "localIp": "10.0.0.1"
 }
 }
}

示例脚本 - 更改带宽和名称

这是一个使用配置 API 更改 WAN 接口的带宽和名称的示例。

mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
 site(accountId: $accountId) {
 updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
 siteId
 socketInterfaceId
 }
 }
}

GraphQL变量

{
 "accountId": "26",
 "siteId": 126,
 "socketInterfaceId": "WAN1",
 "input": {
 "name": "WAN Demo",
 "destType": "CATO",
 "bandwidth": {
 "upstreamBandwidth": 100,
 "downstreamBandwidth": 100
 }
 }
}

相关文章