O

VMware Aria Automation

inclui as seguintes APIs. A documentação da API está disponível com o produto. Para acessar todas as especificações do Swagger em uma única página de aterrissagem, acesse

https://<

your_FQDN

>/automation/api-docs

, em que

your_FQDN

é o FQDN de seu dispositivo

VMware Aria Automation

.

É altamente recomendado, mas não necessário, usar o controle de versão da API. O controle de versão da API permite que você bloqueie a API para um valor e controle quando você atualiza para uma nova versão da API. Se você não usar o controle de versão da API, o comportamento padrão variará dependendo da API.

Para as APIs IaaS, a versão mais recente é
2021-07-15
. Se você consumir as APIs de IaaS sem versionamento ou se atribuir um valor diferente de
2021-07-15
, as solicitações usarão a versão 2019-01-15.
Como prática recomendada, bloqueie suas solicitações de API de IaaS com o parâmetro de consulta
apiVersion
atribuído ao
2021-07-15
para garantir uma transição suave para a versão mais recente antes que a versão 2019-01-15 chegue ao fim de sua vida útil. Consulte Using Automation Assembler APIs to Build your Resource Infrastructure.
Para outras APIs, você pode especificar qualquer data que escolher para o parâmetro de consulta
apiVersion
. Se você deixar o valor não especificado, as solicitações usarão a versão mais recente da API por padrão. No entanto, a compatibilidade com versões anteriores não é preservada e, se a API mudar, você poderá encontrar uma alteração inesperada na resposta da API.
Como boas práticas, use o parâmetro de consulta
apiVersion
em suas solicitações de API e bloqueie sua API para a versão mais recente listada na especificação do Swagger. Então, se uma nova versão da API for anunciada, você controla quando optar por essa versão alterando o parâmetro de consulta
apiVersion
para o novo valor da versão.

O exemplo a seguir mostra como usar o parâmetro de consulta

apiVersion

para a API do catálogo. As versões da API do catálogo são: 2020-08-25, 2020-01-30 e 2019-01-15. A inclusão do parâmetro de consulta

apiVersion

adicional bloqueia a chamada para a versão da API que estava em vigor em 30 de janeiro de 2020 e até 24 de agosto de 2020.

GET https://appliance.domain.com/catalog/api/sources?apiVersion=2020-01-30

Quando estiver pronto para optar pelos recursos lançados com a versão datada de 25/08/2020, altere o valor do parâmetro de consulta

apiVersion

.

GET https://appliance.domain.com/catalog/api/sources?apiVersion=2020-08-25

Definir o parâmetro de consulta

apiVersion

para a versão mais recente garante que você também receberá atualizações para a API do catálogo que ocorrerem após 25/08/2020. No entanto, nenhuma alteração drástica ocorrerá até que uma nova versão seja anunciada e você só experimentará essas alterações se alterar o valor do parâmetro de consulta

apiVersion

para uma data equivalente à nova versão ou posterior.

Para fazer chamadas de serviço de API, você usa um aplicativo de navegador ou um aplicativo cliente HTTP para enviar solicitações e analisar respostas. Os seguintes aplicativos de código aberto são comumente usados:

Para aprender a usar a API, comece obtendo um token de autenticação. Então você pode executar as etapas descritas nos casos de uso neste guia. Os casos de uso incluem comandos

curl

nos exemplos de solicitação. Para usar os comandos, certifique-se de que o processador JSON de linha de comando

jq

esteja instalado com

curl

. O analisador

jq

garante que as respostas sejam formatadas para facilitar a leitura. Para obter informações sobre a instalação dde

jq

, consulte https://stedolan.github.io/jq/.