配置 API - 更新站点一般详情

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

更新站点一般详情概览

使用 updateSiteGeneralDetails 变更 API 更新 Cato 管理应用程序（网络 > 站点 > {site name} > 站点配置 > 一般）中站点的一般部分中的以下设置

名称
描述
类型
时区
国家
州
地址

定位您的账户 ID

这个账户 ID 不会显示在Cato 管理应用程序中，而是在Cato 管理应用程序的 URL 中。例如，账号 ID 为以下 URL 的 26：https://cc.catonetworks.com/#!/26/topology。

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

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

定位站点的站点 ID

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

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

您也可以使用搜索参数，值为站点名称，查询返回站点 ID
Cato 管理应用程序的 URL 中的编号，当您选择了一个站点时（网络 > 站点 > {site name}）。例如，以下 URL 的站点 ID 为 12345：https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

更新站点一般详情参数的详情

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

name - 站点的名称
siteType - 组织中站点的类型，例如云数据中心
description - （可选）站点的描述
siteLocation - 站点物理位置的数据

更新站点一般详情的名称

更新站点的名称。

更新站点一般详情的站点类型

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

这些是选项：

更新站点一般详情的描述（可选）

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

更新站点一般详情的站点位置

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

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

这些是siteLocation参数：

示例 Postman 脚本

mutation updateSiteGeneralDetails ($accountId: ID!, $siteID: ID!, $input: UpdateSiteGeneralDetailsInput!) {
    site(accountId: $accountId) {
        updateSiteGeneralDetails (siteId: $siteID, input: $input) {
            siteId
        }
    }
}

GraphQL 变量

{
    "accountId": "",
    "siteID": "",
    "input": {
        "name": "MySite",
        "description": "我使用 API 的第一个数据中心",
        "siteType": "DATACENTER",
        "siteLocation": {
            "countryCode": "FR",
            "timezone": "Europe/Paris"
        }
    }
}

相关资源