配置 API - addSocketSite

addSocketSite 概述

使用 addSocketSite 变更 API 在您的账户中创建一个新的 Socket 站点，并为该站点定义以下设置：

名称
描述
类型
连接类型
时区
国家
州
地址
本地范围

该站点将使用默认的带宽设置创建，即下行25 Mbps和上行25 Mbps，并且未分配许可证。

对于经销商账户，您可以在配置 Cato API 的设置时，在每个客户的账户中创建单独的 API 密钥。

查找您账户的 accountId

此账户 ID 未显示在 Cato 管理应用程序中，而是该 Cato 管理应用程序的 URL 中的数字。例如，对于以下URL，账户ID为26：https://cc.catonetworks.com/#!/26/topology。

在站点创建 API 中，将此 ID 输入到 accountId 参数，例如：

site(accountId: 26) {
    addSocketSite(input: $addSocketSite) { 
        siteId 
    } 
}

addSocketSite 参数详情

这些是使用 Cato 配置 API 创建一个新的 Socket 站点的参数。除非标记为可选，否则参数是必需的：

name - 站点名称
connectionType - 该站点的物理 Socket 或 vSocket
siteType - 您组织中的站点类型，例如云数据中心
description - （可选）站点描述
nativeNetworkRange - 站点后本地 LAN 的 IP 范围，以 CIDR 格式
siteLocation - 站点物理位置的数据

AddSocketSite 名称

定义您正在创建的 Socket 站点的名称。

AddSocketSite 连接类型

connectionType 是一个枚举参数，用于定义站点的物理或虚拟 Socket 类型。

这些是选项：

SOCKET_X1500 - 物理站点的 X1500 或 X1500B Socket
SOCKET_X1600 - 物理站点的 X1600 Socket
SOCKET_X1700 - 物理站点的 X1700 或 X1700B Socket
SOCKET_ESX - 虚拟 VMware 站点的 vSocket
SOCKET_AWS - 虚拟 AWS 站点的 vSocket
SOCKET_AZURE - 虚拟 Azure 站点的 vSocket

AddSocketSite 站点类型

siteType 是一个枚举参数，用于定义站点类型，这决定了在 Cato 管理应用程序的监控 > 拓扑屏幕中为站点使用的图标。

这些是选项：

AddSocketSite 描述（可选）

description 是一个可选的自由文本字段，用于描述站点。

AddSocketSite 本地网络范围

定义站点的 LAN 本地范围的 IP 范围，在 nativeNetworkRange 参数中以 IPSubnet 格式。本地范围使用 CIDR 用于子网，/32 CIDR 区块不被支持。

AddSocketSite 站点位置

siteLocation 参数定义站点的以下物理细节。 countryCode 与您账户中特定区域可用的站点许可证数量相关。

您可以使用 entityLookup API 查询来检索这些参数的值，详见 Cato API - EntityLookup。

这些是 siteLocation 参数：

示例 Postman 脚本

变更 addSocketSite ($accountId: ID!, $input: AddSocketSiteInput!) {
    site(accountId: $accountId) {
        addSocketSite (input: $input) {
            siteId
        }
    }
}

GraphQL 变量

{
    "accountId": "26",
    "input": {
        "name": "SampleUsSite2",
        "description": "My first API site",
        "siteType": "BRANCH",
        "connectionType": "SOCKET_X1500",
        "nativeNetworkRange": "10.0.0.0/24",
        "siteLocation": {
            "countryCode": "US",
            "timezone": "US/Central",
            "stateCode": "US-AL"
        }
    }
}

相关资源

使用卡托站点创建API与Postman