API de Configuração - updateSiteGeneralDetails

Recomendamos fortemente que, antes de começar a usar a API do Cato, revise a Política de Suporte para a API do Cato.

Visão Geral do updateSiteGeneralDetails

Use a API de mutação updateSiteGeneralDetails para atualizar as seguintes configurações na seção Geral para um site no Aplicativo de Gerenciamento Cato (Network > Sites > {site name} > Configuração do Site > Geral)

Nome
Descrição
Tipo
Fuso horário
País
Estado
Endereço

Localizando o accountId para Sua Conta

Este ID de conta não é mostrado no Aplicativo de Gerenciamento Cato, em vez disso, é o número na URL para o Aplicativo de Gerenciamento Cato. Por exemplo, o ID da conta é 26 para a seguinte URL: https://cc.catonetworks.com/#!/26/topology.

Digite este ID no argumento accountId para a API de criação de site, por exemplo:

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

Localizando o siteID para um Site

O ID do site não é exibido no Aplicativo de Gerenciamento Cato, você pode localizar o ID do site:

Usando a consulta de API entityLookup (veja Cato API - EntityLookup), use o tipo com o valor site

Você também pode usar o parâmetro search com o valor como o nome do site, e a consulta retorna o ID do site
Número na URL para o Aplicativo de Gerenciamento Cato, quando você selecionou um site (Network > Sites > {site name}). Por exemplo, o ID do site é 12345 para a seguinte URL: https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

Detalhes para os Argumentos de updateSiteGeneralDetails

Estes são os argumentos para atualizar as seguintes configurações Gerais para um site usando a API de configuração Cato. Os argumentos são obrigatórios, a menos que marcados como opcionais:

nome - Nome do site
siteType - Tipo de site na sua organização, por exemplo, Centro de Dados na Nuvem
descrição - (opcional) Descrição do site
localização do site - Dados sobre a localização física do site

updateSiteGeneralDetails Nome

Atualize o nome do site.

updateSiteGeneralDetails siteType

O siteType é um argumento enum que define o tipo de site que determina qual ícone é usado para o site na tela Monitoring > Topologia no Aplicativo de Gerenciamento Cato.

Essas são as opções:

updateSiteGeneralDetails descrição (Opcional)

O descrição é um campo de texto livre opcional para descrever o site.

updateSiteGeneralDetails local do site

Os argumentos siteLocation definem os seguintes detalhes físicos para o site. O countryCode é relevante para o número de licenças de site que estão disponíveis para uma Região específica na sua conta.

Você pode usar a consulta de API entityLookup para recuperar valores para estes argumentos, veja Cato API - EntityLookup.

Estes são os argumentos siteLocation:

countryCode - Código de duas letras (ISO 3166-1 alpha-2) para o país onde o site está localizado

Para entityLookup, use o tipo com o valor country
stateCode - (Opcional) Para os países aplicáveis, o estado onde o site está localizado

Para entityLookup, use o tipo com o valor countryState
timezone - Fuso horário para o site, usado para definir o período da Janela de Manutenção para atualizações de Socket e vSocket

Para entityLookup, use o tipo com o valor timezone
endereço - (Opcional) Endereço da rua para o site físico

Script de Exemplo do Postman

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

Variáveis GraphQL

{
    "accountId": "",
    "siteID": "",
    "input": {
        "name": "MySite",
        "description": "Meu primeiro DC usando a API",
        "siteType": "DATACENTER",
        "siteLocation": {
            "countryCode": "FR",
            "timezone": "Europe/Paris"
        }
    }
}

Recursos Relacionados