Realización de una solicitud de API

URI de solicitud

Un URI de solicitud tiene el siguiente formato:

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

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

Por ejemplo, para obtener un token de 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 el 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:

1

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

Figura 1 Ejemplo de URI

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

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:

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.

Además de admitir la autenticación mediante tokens, las API admiten la autenticación mediante AK/SK, que utiliza SDK para firmar una solicitud. Durante la firma, los encabezados Authorization (autenticación de firma) y X-Sdk-Date (hora en que se envía una solicitud) se agregan automáticamente en la solicitud.

Para obtener más información, consulte "Autentificación con AK/SK" en Autenticación.

La API utilizada para obtener un token de usuario no requiere la 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 como se especifica en el campo de encabezado Content-Type. El cuerpo de la solicitud transfiere el contenido excepto el encabezado de la solicitud.

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 desde la solicitud de API. A continuación se proporciona un ejemplo de solicitud con un cuerpo incluido. Reemplace username, domainname, ******** (contraseña de inicio de sesión) y xxxxxxxxxxxxxxxxxx (nombre del proyecto) con los valores reales. Obtener un nombre de proyecto de Regiones y puntos de conexión.

El parámetro 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 la sección Obtención de un token de ususario.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

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, puede enviar la solicitud para invocar 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 las invocaciones a otras API.