:Uso do OpenAPI

Este tópico descreve como chamar operações de API.

Como desenvolvedor, você deve prestar atenção às seguintes informações ao chamar operações de API:

1. Endereço de chamada

2. Necessidade de login

3. Necessidade de autorização

4. Método de chamada

5. Resultado retornado

O mesmo se aplica às APIs da Alibaba Cloud.

O diagrama de sequência de chamada de uma operação de API da Alibaba Cloud

O diagrama a seguir mostra a sequência completa de eventos, desde o momento em que um usuário inicia uma solicitação de API no cliente até o recebimento da resposta do serviço da Alibaba Cloud.

1. O usuário inicia uma solicitação HTTP para chamar a operação fornecida pelo servidor de negócios. Por exemplo, a solicitação pode consultar o status de uma instância do Elastic Compute Service (ECS).

2. O servidor de negócios recebe a solicitação do cliente e verifica a validade dos parâmetros. Em seguida, organiza os parâmetros conforme a documentação da API e assina a solicitação. Caso utilize um SDK da Alibaba Cloud para chamar operações de API, não é necessário assinar a solicitação no servidor de negócios, pois o SDK já contém a lógica de assinatura.

3. O servidor de negócios inicia uma requisição para acessar o endpoint do gateway de API.

4. O gateway de API recebe a solicitação do servidor de negócios, valida a assinatura, identifica o chamador e executa a autenticação.

5. Após a autenticação bem-sucedida, o gateway encaminha a solicitação para o endereço interno do serviço.

6. O produto de nuvem recebe a solicitação do gateway, executa as operações nos recursos de nuvem especificados e retorna o resultado da execução.

7. O gateway de API recebe os dados retornados pelo produto de nuvem, converte-os para o formato de saída padrão e os envia de volta ao servidor de negócios.

8. O servidor de negócios recebe os dados do gateway de API, processa os resultados e os retorna ao cliente de negócios.

Termos

Endpoint

Um endpoint é um endereço de serviço registrado no gateway por meio do qual os clientes acessam um produto de nuvem. Trata-se de uma URL que especifica o protocolo de acesso, nome do host, porta e caminho do serviço. Os usuários dos clientes utilizam essas informações para se comunicar com o serviço de nuvem.

Identidade, credencial e autenticação

As APIs da Alibaba Cloud dividem-se em dois tipos: APIs anônimas e APIs autenticadas. Ao chamar uma API anônima, basta garantir que sua solicitação esteja em conformidade com o estilo da API. Nenhuma autenticação é necessária.

Para chamadas a uma API autenticada, o gateway precisa verificar a credencial da solicitação para confirmar a identidade do chamador. O gateway encaminha a solicitação ao serviço de nuvem somente após a identidade passar pela verificação de permissões.

Método de chamada

A Alibaba Cloud oferece diversas formas para os desenvolvedores chamarem operações de API, incluindo SDKs da Alibaba Cloud, Alibaba Cloud CLI e Resource Orchestration Service (ROS). Também é possível implementar solicitações HTTP independentemente.

Instruções

1. Leia o conteúdo em inglês para compreender O QUE precisa ser comunicado

2. Escreva o texto em português do Brasil DO ZERO — esqueça a estrutura das frases em inglês

3. Preserve toda a formatação markdown, blocos de código, links e imagens exatamente como estão

4. Tags xref (<a data-tag="xref" ...>texto</a>) — preserve a tag INTEIRA com todos os atributos na ordem e caixa originais, traduza APENAS o texto visível entre > e

5. Aplique todas as regras específicas do idioma rigorosamente

6. Aplique as regras de stopwords com tolerância zero

7. Use o modo imperativo em etapas numeradas e listas de procedimentos

8. Garanta a consistência terminológica — o mesmo termo deve ter a mesma tradução em todo o documento

9. Varie os inícios de frase em listas e tabelas — nenhum iniciador deve se repetir mais de 3 vezes

10. Retorne APENAS o documento markdown em português do Brasil, sem explicações