API конфигурации - updateSiteGeneralDetails

Мы настоятельно рекомендуем перед началом использования Cato API ознакомиться с Политикой поддержки Cato API.

Обзор функции updateSiteGeneralDetails

Используйте мутацию updateSiteGeneralDetails API для обновления следующих настроек в разделе Общие для сайта в приложении управления Cato (Сеть > Сайты > {site name} > Конфигурация сайта > Общие)

Название
Description
Тип доверенной сети
Часовой пояс
Страна
Штат
Адрес

Поиск accountId для вашей учетной записи

Этот ID аккаунта не отображается в Приложение Управления Cato, вместо этого номер указан в URL для Приложение Управления Cato. Например, ID учетной записи равен 26 для следующего URL: https://cc.catonetworks.com/#!/26/topology.

Введите этот ID в аргумент accountId для API создания сайта, например:

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

Поиск siteID для сайта

ID сайта не отображается в Приложении управления Cato, вы можете найти ID сайта:

Используя запрос API entityLookup (см. Cato API - EntityLookup), используйте type со значением site
Вы также можете использовать параметр search со значением в качестве названия сайта, и запрос вернет ID сайта
Номер в URL для Приложения управления Cato, когда вы выбрали сайт (Сеть > Сайты > {название сайта}). Например, ID сайта равен 12345 для следующего URL: https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

Детали аргументов updateSiteGeneralDetails

Это аргументы для обновления следующих общих настроек для сайта с использованием API конфигурации Cato. Аргументы обязательны, если не отмечено как необязательные:

имя - Имя сайта
siteType - Тип сайта в вашей организации, например, Облачный Центр Данных
description - (необязательно) Описание сайта
siteLocation - Данные о физическом местоположении сайта

updateSiteGeneralDetails Имя

Обновите имя сайта.

updateSiteGeneralDetails siteType

siteType - это перечислимый аргумент, который определяет тип сайта, что определяет, какой значок используется для сайта на экране Мониторинг > Топология в Приложении управления Cato.

Вот доступные параметры:

BRANCH - Физические или виртуальные сайты
HEADQUARTERS - Физические сайты для корпоративных штаб-квартир
CLOUD_DC - Виртуальные сайты для облачных центров данных
DATACENTER - Физические сайты для центров данных

updateSiteGeneralDetails описание (Необязательно)

description - это необязательное текстовое поле для описания сайта.

updateSiteGeneralDetails siteLocation

Аргументы siteLocation определяют следующие физические детали для сайта. countryCode имеет отношение к количеству лицензий на сайт, которые доступны для конкретного Региона в вашей учетной записи.

Вы можете использовать запрос API entityLookup для получения значений для этих аргументов, см. Cato API - EntityLookup.

Это аргументы siteLocation:

countryCode - Двухбуквенный код (ISO 3166-1 alpha-2) для страны, где находится сайт
Для entityLookup, используйте type со значением country
stateCode - (необязательно) Для применимых стран, штат, где находится сайт
Для entityLookup, используйте type со значением countryState
timezone - Часовой пояс для сайта, используется для установки временных рамок для Окон Технического Обслуживания для обновлений Socket и vSocket
Для entityLookup, используйте type со значением timezone
address - (необязательно) Адрес улицы для физического сайта

Пример скрипта для Postman

мутация updateSiteGeneralDetails ($accountId: ID!, $siteID: ID!, $input: UpdateSiteGeneralDetailsInput!) {
    site(accountId: $accountId) {
        updateSiteGeneralDetails (siteId: $siteID, input: $input) {
            siteId
        }
    }
}

Переменные GraphQL

{
    "accountId": "",
    "siteID": "",
    "input": {
        "name": "MySite",
        "description": "My first DC using the API",
        "siteType": "DATACENTER",
        "siteLocation": {
            "countryCode": "FR",
            "timezone": "Europe/Paris"
        }
    }
}

Связанные ресурсы