Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Actualización más reciente 2024-06-06 GMT+08:00

Hacer una solicitud de API

Esta sección describe la estructura de una solicitud de API de REST y utiliza la API de IAM para obtener un token de usuario como ejemplo para demostrar cómo invocar a una API. El token obtenido se puede usar luego para autenticar la invocación de otras API.

Solicitud de URI

Un URI de solicitud consta de lo siguiente:

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

Aunque se incluye un URI de solicitud en una cabecera de solicitud, la mayoría de los lenguajes de programación o marcos requieren que el URI de solicitud se transmita por separado, en lugar de ser transportado en un mensaje de solicitud.

Tabla 1 Parámetros en un URI

Parámetro

Descripción

URI-scheme

Protocolo utilizado para transmitir solicitudes. Todas las API usan HTTPS.

Endpoint

Nombre de dominio o dirección IP del servidor que lleva el servicio de REST. El punto de conexión varía entre los servicios en diferentes regiones. Se puede obtener de Regions y puntos de conexión.

Por ejemplo, el punto de conexión de IAM en la región CN-Hong Kong es iam.ap-southeast-1.myhuaweicloud.com.

resource-path

Ruta de acceso de una API para realizar una operación especificada. Obtener la ruta de acceso desde el URI de una API. Por ejemplo, la resource-path de la API utilizada para obtener un token de usuario es /v3/auth/tokens.

query-string

Parámetro de consulta, que es opcional. Asegúrese de que se incluya un signo de interrogación (?) antes de cada parámetro de consulta que tenga el formato de "Nombre de parámetro=Valor de parámetro". Por ejemplo, ? limit=10 indica que se mostrará un máximo de 10 registros de datos.

Por ejemplo, para obtener un token IAM en la región CN-Hong Kong, obtenga el punto de conexión de IAM (iam.ap-southeast-1.myhuaweicloud.com) para esta región y la resource-path (/v3/auth/tokens) en el URI de la API utilizada para obtener un token de usuario. A continuación, construya el URI de la siguiente manera:

1
https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/tokens

Para simplificar la visualización de URI en este documento, cada API se proporciona solo con una ruta de recursos y un método de solicitud. El URI-scheme de todas las API es HTTPS, y los puntos de conexión de todas las API en la misma región son idénticos.

Métodos de solicitud

El protocolo HTTP define los siguientes métodos de solicitud que se pueden usar para enviar una solicitud al servidor:
Tabla 2 Métodos HTTP

Método

Descripción

GET

Solicita al servidor que devuelva los recursos especificados.

PUT

Solicita al servidor que actualice los recursos especificados.

POST

Solicita al servidor que agregue recursos o realice operaciones especiales.

DELETE

Solicita al servidor que elimine los recursos especificados, por ejemplo, un objeto.

Por ejemplo, en el caso de la API usada para obtener un token de usuario, el método de solicitud es POST. La solicitud es la siguiente:

1
POST https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/tokens

Encabezado de la solicitud

También puede agregar campos adicionales a una solicitud, como los campos requeridos por un URI especificado o un método HTTP. Por ejemplo, para solicitar la información de autenticación, agregue Content-Type, que especifica el tipo de cuerpo de la solicitud.

Tabla 3 enumera los campos de encabezado de solicitud comunes.
Tabla 3 Encabezados de solicitud comunes

Nombre

Descripción

Obligatorio

Ejemplo

Host

Especifica la información del servidor solicitada, que se puede obtener de la URL de la API de servicio. El valor está en el formato hostname[:port]. Si no se especifica el número de puerto, se utiliza el puerto predeterminado. El número de puerto predeterminado para https es 443.

No

Este parámetro es obligatorio para la autenticación AK/SK.

code.test.com

o

code.test.com:443

Content-Type

Especifica el tipo MIME del cuerpo de la solicitud. Se recomienda utilizar el valor predeterminado application/json. Para las API utilizadas para cargar objetos o imágenes, el valor puede variar dependiendo del tipo de flujo.

application/json

Content-Length

Especifica la longitud del cuerpo de la solicitud. The unit is byte.

No

3495

X-Project-Id

Especifica el ID del proyecto. Obtenga el ID del proyecto siguiendo las instrucciones en Obtención de un ID de proyecto.

No

Este parámetro es obligatorio para las solicitudes que usan autenticación AK/SK en el escenario de nube dedicada (DeC) o multiproyecto.

e9993fc787d94b6c886cbaa340f9c0f4

X-Auth-Token

Especifica el token de usuario.

El token de usuario es una respuesta a la API usada para obtener un token de usuario. Esta API es la única que no requiere autenticación.

Después de procesar la solicitud, el valor de X-Subject-Token en el encabezado del mensaje es el valor de token.

No

Este parámetro es obligatorio para la autenticación de tokens.

Lo siguiente es parte de un token de ejemplo:

MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

Además de admitir la autenticación basada en tokens, las API admiten la autenticación mediante ID de clave de acceso/clave de acceso secreta (AK/SK). Durante la autenticación basada en AK/SK, se utiliza un SDK para firmar la solicitud, y los campos de encabezado Authorization (información de firma) y X-Sdk-Date (hora en la que se envía la solicitud) se añaden automáticamente a la solicitud.

Para obtener más información, consulte AK/SK-based Authentication en Autenticación.

La API utilizada para obtener un token de usuario no requiere autenticación. Por lo tanto, solo es necesario agregar el campo Content-Type a las solicitudes para invocar a la API. Un ejemplo de tales solicitudes es el siguiente:
POST https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/tokens
Content-Type: application/json

Cuerpo de solicitud (Opcional)

Esta parte es opcional. El cuerpo de una solicitud se envía a menudo en un formato estructurado (por ejemplo, JSON o XML) como se especifica en el campo de encabezado Content-Type. Si el cuerpo de la solicitud contiene caracteres de ancho completo, estos caracteres deben estar codificados en UTF-8.

El cuerpo de la solicitud varía en función de las API. Algunas API no requieren el cuerpo de la solicitud, como las API solicitadas mediante los métodos GET y DELETE.

En el caso de la API usada para obtener un token de usuario, los parámetros de solicitud y la descripción de parámetros se pueden obtener a partir de la solicitud de API. A continuación se proporciona una solicitud de ejemplo con un cuerpo incluido. Reemplace username, domainname, ******** (contraseña de inicio de sesión), y xxxxxxxxxxxxxxxxxx (nombre de proyecto, como ap-southeast-1) con valores actuales. Puede obtener los valores de Regions y puntos de conexión.

El parámetro de scope especifica dónde surte efecto un token. Puede establecer scope para una cuenta o un proyecto en una cuenta. En el siguiente ejemplo, el token solo tiene efecto para los recursos de un proyecto especificado. Para obtener más información sobre esta API, consulte Obtener un token de usuario.

POST https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/tokens
Content-Type: application/json

{
    "auth": {
        "identity": {
            "methods": [
                "password"
            ],
            "password": {
                "user": {
                    "name": "username",
                    "password": "********",
                    "domain": {
                        "name": "domainname"
                    }
                }
            }
        },
        "scope": {
            "project": {
                "name": "xxxxxxxxxxxxxxxxxx"
            }
        }
    }
}

Si todos los datos necesarios para la solicitud de API están disponibles, puedes enviar la solicitud para llamar a la API a través de curl, Postman o codificación. En la respuesta a la API utilizada para obtener un token de usuario, x-subject-token es el token de usuario deseado. Este token se puede utilizar para autenticar la invocación de otras API.