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 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.

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

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:

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.

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:

(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.