Hacer una solicitud de API

Solicitud de URI

Un URI de solicitud tiene el siguiente formato:

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

Por ejemplo, para obtener un token 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 para obtener un token de usuario a través de autenticación de contraseña. A continuación, construya el URI de la siguiente manera:

https://v3/auth/tokens

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

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

• GET: solicita al servidor que devuelva los recursos especificados.
• PUT: solicita al servidor que actualice los recursos especificados.
• POST: solicita al servidor que añada recursos o realice operaciones especiales.
• DELETE: solicita al servidor que elimine los recursos especificados, por ejemplo, un objeto.
• HEAD: igual que GET excepto que el servidor debe devolver solo el encabezado de respuesta.
• PATCH: solicita al servidor que actualice el contenido parcial de un recurso especificado. Si el recurso no existe, se creará un nuevo recurso.

Por ejemplo, en la API utilizada para obtener un token de usuario a través de autenticación de contraseña, 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 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.

Los campos de encabezado de solicitud comunes son los siguientes:

• Content-Type: especifica el tipo o formato del cuerpo de la solicitud. Este campo es obligatorio y su valor predeterminado es application/json.
• X-Auth-Token: especifica un token de usuario solo para la autenticación API basada en tokens. El token de usuario es una respuesta a la API utilizada para obtener un token de usuario a través de autenticación de contraseña. Esta API es la única que no requiere autenticación.
  

  Además de admitir la autenticación basada en tokens, las API de nube pública también admiten la autenticación mediante 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 Autenticación basada en AK/SK.

La API utilizada para obtener un token de usuario a través de autenticación de contraseña 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 la solicitud

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 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 utilizada para obtener un token de usuario (Obtención de un token de usuario mediante autenticación de contraseña), 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, ******** (login password), y xxxxxxxxxxxxxxxxxx (ID del proyecto) por los valores reales. Para obtener más información sobre cómo obtener un ID de proyecto, consulte Obtención de información de cuenta, usuario de IAM, grupo, proyecto, región y delegación.

El parámetro de scope especifica dónde surte efecto un token. El valor puede ser project o domain. En el ejemplo anterior, el valor de scope es de project indicando que el token obtenido solo tiene efecto para los recursos de un proyecto especificado. Si el valor de scope es de domain el token obtenido tiene efecto para todos los recursos de la cuenta especificada. Para obtener más información, consulte la API para obtener un token de usuario a través de la autenticación de contraseña.

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"
            }
        }
    }
}

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 el encabezado de respuesta para la API utilizada para obtener un token de usuario a través de autenticación de contraseña, x-subject-token es el token de usuario deseado. Este token se puede utilizar para autenticar la invocación de otras API.