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 2022-11-07 GMT+08:00

Hacer una solicitud de API

Esta sección describe la estructura de una API de REST, y utiliza la API de IAM para obtención de un token de usuario. El token obtenido se utiliza para autenticar la llamada de otras API.

Solicitud de URI

Un URI de solicitud tiene el siguiente formato:

{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 Descripción del parámetro de URI

Parámetro

Descripción

URI-scheme

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

Endpoint

Especifica el nombre de dominio o la dirección IP del servidor que lleva el punto de conexión del servicio REST. Obtenga el valor de Regions y puntos de conexión.

resource-path

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

query-string

Parámetro de consulta, que es opcional. No todas las API tienen un parámetro de consulta. Asegúrese de que se incluya un signo de interrogación (?) antes de un parámetro de consulta que tenga el formato de "Nombre de parámetro=Valor de parámetro". Por ejemplo, ? limit=10 indica que un máximo de 10 fragmentos de datos deben ser vistos.

Para simplificar la visualización de URI, cada API se proporciona solo con una resource-path y un método de solicitud. Esto se debe a que el valor de URI-scheme de todas las API es HTTPS, y los puntos de conexión en una región son los mismos. Por lo tanto, se omiten las dos partes.

Métodos de solicitud

Los métodos de solicitud basados en HTTP, que también se denominan operaciones o acciones, especifican el tipo de operaciones que está solicitando.
Tabla 2 Métodos de HTTP

Método

Descripción

GET

Solicita a un servidor que devuelva los recursos especificados.

PUT

Solicita a un servidor que actualice los recursos especificados.

POST

Solicita a un servidor que agregue recursos o realice operaciones especiales.

DELETE

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

Por ejemplo, en el URI para obtención de un token de usuario, el método de solicitud es POST, y la solicitud es como sigue:

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, agregue Content-Type que define un tipo de cuerpo de solicitud para solicitar la información de autenticación.

Tabla 3 enumera los campos de encabezado de solicitud comunes.
Tabla 3 Campos de encabezado 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

or

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. La unidad es byte.

Este parámetro es opcional para las solicitudes POST, pero debe dejarse en blanco para las solicitudes GET.

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.

Después de procesar la solicitud, el valor de X-Subject-Token en el encabezado 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, esta API solo requiere agregar el campo Content-Type. La solicitud con el encabezado Content-Type agregado es la siguiente:

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

(Opcional) cuerpo de solicitud

Esta parte es opciona. Un cuerpo de solicitud se envía generalmente en un formato estructurado (por ejemplo, JSON o XML), correspondiente a Content-Type en el encabezado de solicitud, y se usa para transferir contenido distinto al encabezado de solicitud. Si el cuerpo de la solicitud contiene caracteres chinos, convierta los caracteres chinos al formato de codificación UTF-8.

El cuerpo de la solicitud varía según las API. Algunas API no requieren el cuerpo de la solicitud, como las API GET y DELETE.

Para la API utilizada para obtener un token de usuario, los parámetros de solicitud y la descripción de parámetros se pueden obtener en la solicitud de API. A continuación se proporciona una solicitud de ejemplo con un cuerpo incluido. Reemplazar username, domianname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project ID, for example, ap-southeast-1) con los valores reales. Obtenga el valor de Regions y puntos de conexión.

scope especifica dónde surte efecto un token. En el siguiente ejemplo, el token solo tiene efecto en los recursos especificados por el ID del proyecto. Puede establecer el ámbito en una cuenta o un proyecto bajo una cuenta. Para obtener detalles, consulte Obtención de 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": "domianname"
                    }
                }
            }
        },
        "scope": {
            "project": {
                "name": "xxxxxxxxxxxxxxxxxx"
            }
        }
    }
}

Si todos los datos requeridos por una solicitud están disponibles, puede enviar la solicitud para llamar a una API a través de curl, Postman o codificación. Para la API utilizada para obtener un token de usuario, x-subject-token en el encabezado de respuesta es el token de usuario deseado. A continuación, puede usar el token para autenticar la llamada de otras API.