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 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 el token IAM en la región CN North-Beijing4, obtener el punto final de IAM (iam.cn-north-4.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:

https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens

Figura 1 URI de ejemplo

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.cn-north-4.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.

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 llamar a la API. Un ejemplo de tales solicitudes es el siguiente:

POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens
Content-type: application/json

Cuerpo de la solicitud

El cuerpo de una solicitud se envía a menudo en un formato estructurado (JSON o XML) como se especifica en el campo 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 utilizada para obtener un token de usuario, los parámetros de solicitud y la descripción de parámetros pueden obtenerse a partir de la solicitud de API. A continuación se proporciona una solicitud de ejemplo con un cuerpo incluido. Reemplace user_name, domainname (account name), ******** (login password), and xxxxxxxxxxxxxxxxxx (ID de proyecto) con los reales.

El parámetro de scope especifica dónde surte efecto un token. En el ejemplo, el token solo tiene efecto en los recursos especificados por el proyecto. 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.

POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens
Content-type: application/json

{
    "auth": {
        "identity": {
            "methods": [
                "password"
            ],
            "password": {
                "user": {
                    "name": "user_name",
                    "password": "********",
                    "domain": {
                        "name": "domainname"
                    }
                }
            }
        },
        "scope": {
            "project": {
                "id": "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 llamada de otras API.