Hacer una solicitud de 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 el encabezado de solicitud, la mayoría de los lenguajes de programación o marcos requieren que el URI de solicitud se pase por separado.

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

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 resource-path 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

En el URI de la API para obtener un token de usuario, se puede ver que el método de solicitud es POST. La solicitud es la siguiente:

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

Encabezado de la solicitud

También puede agregar campos de encabezado adicionales a una solicitud, como los campos requeridos por un método URI o HTTP especificado. 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.

Además de admitir la autenticación basada en tokens, las API también 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 (autenticación de firma) y X-Sdk-Date (hora en la que se envía la solicitud) se agregan automáticamente a la solicitud.

Para obtener más información, consulte AK/SK-based Authentication de 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

(Opcional) Cuerpo de solicitud

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. El cuerpo de la solicitud transfiere contenido excepto el encabezado de la solicitud. Si el cuerpo de la solicitud contiene caracteres chinos, estos caracteres deben estar codificados en UTF-8.

El cuerpo de la solicitud varía entre 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 del parámetro 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, ******** (login password), y xxxxxxxxxxxxxxxxxx (ID del proyecto) por los valores reales. Para obtener información sobre cómo obtener un ID de proyecto, consulte Obtención de un ID de proyecto.

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 Obtención de un token de usuario de servicio IAM.

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": {
                "id": "xxxxxxxxxxxxxxxxxx"
            }
        }
    }
}

Todos los datos necesarios para la solicitud de API están disponibles. Puede enviar la solicitud para invocar a la API a través de curl, Postman o coding. 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.