:Uso de OpenAPI

Este tema describe cómo invocar operaciones de API.

Como desarrollador, considere la siguiente información al invocar operaciones de API:

1. Dirección de invocación

2. Si es obligatorio iniciar sesión

3. Si se requiere autorización

4. Método de invocación

5. Resultado devuelto

Lo anterior también aplica a las API de Alibaba Cloud.

Diagrama de secuencia de la invocación de una operación de API de Alibaba Cloud

El siguiente diagrama muestra la secuencia completa de eventos, desde que un usuario inicia una solicitud de API en el cliente hasta que recibe la respuesta del servicio de Alibaba Cloud.

1. El usuario inicia una solicitud HTTP para invocar la operación proporcionada por el servidor empresarial. Por ejemplo, la solicitud sirve para consultar el estado de una instancia de Elastic Compute Service (ECS).

2. El servidor empresarial recibe la solicitud del cliente empresarial y comprueba la validez de los parámetros. El servidor organiza los parámetros según la documentación de la API y firma la solicitud. Si utiliza un SDK de Alibaba Cloud para invocar operaciones de API, el servidor empresarial no necesita firmar la solicitud porque el SDK ya incluye la lógica de firma.

3. El servidor empresarial inicia una solicitud para acceder al endpoint de la puerta de enlace de API.

4. La puerta de enlace de API recibe la solicitud del servidor empresarial, verifica la firma, analiza la identidad del llamador y ejecuta la autenticación.

5. Una vez autenticada correctamente, la solicitud se reenvía a la dirección del servicio interno.

6. El producto en la nube recibe la solicitud de la puerta de enlace, ejecuta operaciones en los recursos en la nube especificados según la solicitud y devuelve el resultado.

7. La puerta de enlace de API recibe los datos devueltos por el producto en la nube, los convierte al formato de salida estándar y los retorna al servidor empresarial.

8. El servidor empresarial recibe los datos devueltos por la puerta de enlace de API, procesa los resultados y los envía al cliente empresarial.

Términos

Endpoint

Un endpoint es una dirección de servicio registrada en la puerta de enlace mediante la cual los clientes pueden acceder a un producto en la nube. Es una URL que especifica el protocolo de acceso, el nombre de host, el puerto y la ruta del servicio. Los usuarios pueden utilizar esta información para comunicarse con el servicio en la nube desde sus clientes.

Identidad, credencial y autenticación

Las API de Alibaba Cloud se clasifican en dos tipos: API anónimas y API autenticadas. Si invoca una API anónima, solo debe asegurarse de que su solicitud cumpla con el estilo de la API. No se requiere autenticación.

Si invoca una API autenticada, la puerta de enlace debe verificar la credencial de la solicitud para confirmar la identidad del llamador. La puerta de enlace reenvía la solicitud al servicio en la nube solo después de que la identidad supere la comprobación de permisos.

Método de invocación

Alibaba Cloud proporciona varios métodos para que los desarrolladores invoquen operaciones de API, incluidos los SDK de Alibaba Cloud, Alibaba Cloud CLI y Resource Orchestration Service (ROS). También puede implementar solicitudes HTTP de forma independiente.