Base de conhecimento  /  Nuvem privada de borda Lumen  /  API
Base de conhecimento  /  Nuvem privada de borda Lumen  /  API

Como usar a API

Atualizado por Anthony Hakim em jul 12, 2021
Código do artigo: kb/88

Descrição

In this KB article, we walk through the basics of creating a New Session (Logging In) with the VMware Cloud Director (vCD) API that is part of Lumen Private Cloud on VMware Cloud Foundation™. Assim que uma nova sessão estiver estabelecida você deve seguir a documentação detalhada na API da VMware.

Criar uma Nova sessão (Como fazer login)

To begin using the API, request the system to create a Session object. In this request, supply your credentials in an Authorization header of the form prescribed by the identity provider that your organization uses. A resposta incluirá um token de autorização que você deverá usar nas solicitações subsequentes.

Every version of the vCloud API supported by VMware Cloud Director has a login URL that a client can obtain by making an unauthenticated GET request to the api/versions URL. Consulte Exemplo: Veja o exemplo: Recuperar a URL de login e a lista de versões de API compatíveis. Como todas as solicitações da API vCloud devem ser autenticadas, todo fluxo de trabalho da API vCloud deve iniciar-se com uma solicitação de login que crie uma sessão e devolva um token de autorização no valor do cabeçalho x-vcloud-authorization. O token deverá ser informado nas solicitações subsequentes à API da vCloud.

To create a session object, supply your credentials in an Authorization header of the form prescribed by the identity provider that your organization uses, then POST a request to the vCloud API login URL. Essa solicitação não tem um corpo. Todas as informações necessárias para a criação de uma sessão estão incluídas no cabeçalho de autorização.

Pré-requisitos

  • Faça login das credenciais de um usuário da Lumen Private Cloud na VMware Cloud Foundation com direitos apropriados.

Procedimento

  • Crie uma Nova Sessão com o ponto de extremidade do vCD, usando o seguinte:
    • Cabeçalho: Autorização = Básico (nome de usuário: username@org)
    • Cabeçalho: Accept = application/vnd.vmware.vcloud.session+xml;version=27.0 (your version # will vary)
    • Método POST
    • URL: https://yourLPCurl/api/sessions

Resposta:

O CABEÇALHO da resposta incluirá um token reutilizável de x-vcloud-authorization e um elemento de Sessão cujos elementos de Link fazem referência aos objetos da API vCloud para os quais você tenha direitos de acesso.

  • Certifique-se de anotar o cabeçalho de retorno com o nome chave x-vcloud-authorization. Isto incluirá um número hexadecimal de uma sessão exclusiva para este cabeçalho como, por exemplo,  0a1c2f3f4fa5d6a7d8.
  • Esse cabeçalho, incluindo o respectivo token, deve ser incluído em cada solicitação subsequente para a API de vCloud.
  • Se o cabeçalho da autorização estiver faltando na solicitação, o servidor retornará um código de resposta de HTTP0.
  • Caso as credenciais informadas no cabeçalho de autorização forem inválidas, o servidor retornará o código de resposta HTTP0.

Important
The authorization token expires after a configurable interval of client inactivity. O intervalo padrão é de 0 minutos. Depois que o token expirar, você deverá fazer novo login para obter um novo token. O administrador do sistema pode alterar esse padrão.

Powered by Translations.com GlobalLink OneLink SoftwarePowered By OneLink