Este artigo ajuda você a começar com a API Cato para monitorar e configurar configurações e itens em sua conta.
A API Cato é a interface de automação primária para integração contínua com a Nuvem Cato. Use as APIs Cato para configurar fluxos de trabalho operacionais eficientes, como implantação e configuração, além de monitoramento de status abrangente, estatísticas e coleta de dados, e análises para otimizar o gerenciamento de sua rede e segurança.
A URL para o endpoint e o esquema da API é específica para o local onde a Instância do Aplicativo de Gerenciamento Cato (Aplicativo) está hospedada. Pode haver um valor <prefix> que é anexado à URL da sua conta de Aplicação e ao endpoint e esquema da API.
A URL para o endpoint da API está no formato, https://api.<prefix>.catonetworks.com/api/v1/graphql2.
A URL para o esquema da API está no formato, https://api.<prefix>.catonetworks.com/api/schema.
URLs para Endpoint API
-
Se não houver prefixo (
cc.catonetworks.com), use a seguinte URL:https://api.catonetworks.com/api/v1/graphql2 -
Se houver um prefixo (como
cc.us1.catonetworks.com), então você usaria a seguinte URL (modifique o prefixo para diferentes localidades):https://api.us1.catonetworks.com/api/v1/graphql2
URLs para Esquema API
-
Se não houver prefixo (
cc.catonetworks.com), use a seguinte URL:https://api.catonetworks.com/api/schema -
Se houver um prefixo (como
cc.us1.catonetworks.com), então você usaria a seguinte URL (modifique o prefixo para diferentes localidades):https://api.us1.catonetworks.com/api/schema
As APIs Cato são construídas em GraphQL, oferecendo uma interface intuitiva totalmente compatível com ferramentas e clientes API RESTful. GraphQL também oferece a flexibilidade adicional de consultar exatamente os dados necessários, reduzindo o excesso de requisições e melhorando a eficiência.
A documentação da API Cato está disponível em Referência da API GraphQL Cato Networks, que contém:
-
Definição e documentação do esquema
-
Exemplo de chamadas de API e respostas de amostra correspondentes
-
Endpoint de API GraphQL com Playground interativo para explorar e testar a API
Esta seção descreve os diferentes estágios do ciclo de vida com base no nível de maturidade e disponibilidade de uma API específica.
Cada nova API é inicialmente lançada na fase Beta. A transição de Beta para GA está sujeita a revisão interna e consideração para verificar se a API é estável e pronta para produção. Normalmente, a transição de Beta para GA leva cerca de um ano.
Observação
Observação: O ciclo de vida descrito abaixo refere-se apenas à API formal Cato, conforme definido na Referência da API GraphQL Cato Networks. Não cobre quaisquer ferramentas adicionais e exemplos que possam ser fornecidos como referências.
Por exemplo, não abrange os exemplos e utilidades de código aberto disponíveis na conta no GitHub da Cato. Esses recursos são fornecidos “como estão” sem garantia ou obrigação de desenvolvimento, manutenção ou suporte futuros.
Estes são os níveis de maturidade da API como parte do estágio do ciclo de vida:
-
Beta: APIs na fase Beta são completas em termos de funcionalidades e consideradas totalmente operacionais, adequadas para uso em ambientes de produção. No entanto, elas podem sofrer alterações com base no feedback dos usuários ou em considerações adicionais. Essas mudanças, incluindo alterações significativas no esquema da API, podem ocorrer com curta antecedência e exigir atualizações no código do cliente.
-
GA (Disponibilidade Geral): APIs em GA são estáveis, prontas para produção e vêm com suporte de longo prazo e compromisso de compatibilidade retroativa. Alterações significativas no esquema da API são raras e são anunciadas com bastante antecedência para proporcionar tempo suficiente para ajustes no código do cliente.
APIs que não são explicitamente rotuladas como Beta são consideradas GA. Em alguns casos, dentro de uma API GA, campos individuais, tipos e entradas podem ser marcados como Betas.
Estes são os níveis de disponibilidade para APIs como parte do estágio do ciclo de vida:
-
EA (Disponibilidade Antecipada): APIs em EA estão disponíveis para um grupo limitado de usuários para testes e feedback antes do lançamento mais amplo. O acesso pode requerer aprovação especial ou condições.
-
Implementação Gradual: Seguindo as melhores práticas padrão da indústria para serviços baseados em nuvem, as APIs Cato são implementadas gradualmente para garantir estabilidade e monitorar desempenho, com a disponibilidade expandindo para todas as contas ao longo do tempo.
APIs não marcadas como EA ou Implementação Gradual são consideradas totalmente implantadas e acessíveis a todos os usuários.
Esta seção resume os rótulos usados para APIs na documentação com base nos níveis de maturidade e disponibilidade.
APIs sem rótulo estão totalmente disponíveis para todas as contas e raramente há mudanças significativas no esquema. Qualquer mudança deste tipo será anunciada vários meses de antecedência. Para mais sobre essas mudanças, veja abaixo Mudanças Potencialmente Significativas no Esquema.
-
EA
-
Apenas disponível para clientes que ingressam no programa EA da Cato, para se inscrever, entre em contato conosco em ea@catonetworks.com
-
-
Beta
-
Pode haver mudanças no esquema
-
Aviso limitado para mudanças significativas, possivelmente em até duas semanas
-
APIs Beta suportam funcionalidade completa
-
-
Implementação
-
Essas APIs GA estão sendo gradualmente implementadas em todas as contas durante um período de algumas semanas
-
Chamar uma API com status de Implementação pode resultar em uma mensagem de erro porque essa API ainda não está disponível para sua conta
-
Esta seção discute quando a Cato faz alterações no esquema da API GraphQL que podem impactar o comportamento e os resultados das chamadas de API.
Uma mudança potencialmente significativa em GraphQL ocorre quando modificações na API exigem que aplicativos clientes atualizem suas consultas ou lógica para manter a funcionalidade. Exemplos incluem:
-
Remover um campo, tipo ou argumento.
-
Renomear campos, tipos ou argumentos.
-
Modificar valores padrão para argumentos de maneira que mude os resultados esperados de consultas ou mutações.
-
Alterar o tipo ou comportamento de um campo de maneira que impacte a compatibilidade. Por exemplo, mudando o tipo de um campo (por exemplo, de Int para String) ou modificando a nulabilidade de um argumento (por exemplo, de anulável para não anulável).
Trabalhamos o máximo possível para evitar mudanças potencialmente significativas. No entanto, no caso raro de haver tal mudança, ela será comunicada aos clientes conforme explicado abaixo em Notificando sobre APIs Fim de Vida.
Essas mudanças podem ocorrer com mais frequência para APIs Beta, mas são raras para APIs GA.
Uma API ou um campo marcado como Obsoleto indica que o uso não é mais recomendado, e uma melhor alternativa existe. Recomendamos que você atualize scripts e processos para não utilizar mais APIs e campos obsoletos, para manter o comportamento e funcionalidade esperados.
Se uma API ou um campo está planejado para remoção ou substituição, ele passará por um processo de Fim de Vida (EoL). Este processo inclui as seguintes etapas:
-
Marcar a API ou Campo como Obsoleto
-
A API ou campo planejado para remoção é marcado como Obsoleto na Referência da API GraphQL Cato Networks.
-
Este rótulo é acompanhado por uma mensagem, especificando uma API ou campo alternativo, se aplicável, e a data planejada de EoL.
-
-
Notificações de EoL
-
O artigo Mudanças Potencialmente Significativas da API Cato e Fim de Vida é atualizado com a data específica que o esquema será atualizado com a mudança.
-
O período de tempo entre a notificação e as mudanças no esquema é conforme segue:
-
API GA: Pelo menos 3 meses de antecedência e geralmente 6 meses de antecedência
-
API Beta: Tipicamente com 2 semanas de antecedência
-
-
Durante o período de tempo entre a notificação de EoL e a data de EoL, espera-se que os clientes atualizem o código cliente para acomodar as mudanças no esquema GraphQL.
-
Mudanças no GraphQL que são não significativas e ainda assim relevantes, como novas APIs ou novos campos, são anunciadas no artigo Changelog da API Cato.
A Referência da API GraphQL Cato Networks sempre inclui o esquema completo suportado e atualizado do GraphQL.
0 comentário
Por favor, entre para comentar.