Hacer una solicitud de API
Esta sección describe la estructura de una solicitud de API de REST y utiliza la API de IAM para obtener un token de usuario como ejemplo para demostrar cómo llamar a una API. El token obtenido se puede usar entonces para autenticar la llamada de otras 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.
Parámetro |
Descripción |
---|---|
URI-scheme |
Protocolo utilizado para transmitir solicitudes. Todas las API usan HTTPS. |
Endpoint |
Nombre de dominio o dirección IP del servidor que lleva el servicio REST. El punto de conexión varía entre los servicios en diferentes regiones. Se puede obtener del Regions y puntos de conexión. Por ejemplo, el punto final de IAM en la región CN-Hong Kong is iam.ap-southeast-1.myhuaweicloud.com. |
resource-path |
Ruta de acceso de una API para realizar una operación especificada. Obtener la ruta de acceso desde el URI de una API. Por ejemplo, la resource-path de la API utilizada para obtener un token de usuario es /v3/auth/tokens. |
query-string |
Parámetro de consulta, que es opcional. Asegúrese de que se incluye un signo de interrogación (?) antes de cada parámetro de consulta que tiene el formato de Parameter name=Parameter value. Por ejemplo, ? limit=10 indica que se mostrará un máximo de 10 registros de datos. |
Por ejemplo, para obtener un token IAM en la región CN-Hong Kong, obtenga el punto final de IAM (iam.ap-southeast-1.myhuaweicloud.com) para esta región y la ruta de recursos (/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:
1 |
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
Método |
Descripción |
---|---|
GET |
Solicita al servidor que devuelva los recursos especificados. |
PUT |
Solicita al servidor que actualice los recursos especificados. |
POST |
Solicita al servidor que agregue 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 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.
Parámetro |
Descripción |
Obligatorio |
Valor de ejemplo |
---|---|---|---|
Host |
Especifica el nombre de dominio del servidor y el número de puerto de los recursos que se solicitan. El valor se puede obtener de la URL de la API de servicio. El valor tiene el formato de nombre de Hostname:Port number. Si no se especifica el número de puerto, se utiliza el puerto predeterminado. El número de puerto predeterminado para https es 443. |
No This field is mandatory for AK/SK authentication. |
code.test.com o code.test.com:443 |
Content-Type |
Especifica el tipo (o formato) del cuerpo del mensaje. Se recomienda el valor predeterminado application/json. Otros valores de este campo se proporcionarán para APIs específicas si los hay. |
Sí |
application/json |
Content-Length |
Especifica la longitud del cuerpo de la solicitud. La unidad es byte. |
No |
3495 |
X-Project-Id |
Especifica el ID del proyecto. Obtenga el ID del proyecto siguiendo las instrucciones en Obtención de un ID de proyecto. |
No Este campo es obligatorio para las solicitudes que usan autenticación AK/SK en el escenario de nube dedicada (DeC) o multiproyecto. |
e9993fc787d94b6c886cbaa340f9c0f4 |
X-Auth-Token |
Especifica el token de usuario. Es una respuesta a la API para obtener un token de usuario (Esta es la única API que no requiere autenticación). Después de procesar la solicitud, el valor de X-Subject-Token en el encabezado de respuesta es el valor de token. |
No Este campo es obligatorio para la autenticación de tokens. |
Lo siguiente es parte de un token de ejemplo: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ |
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 detalles, consulte "Autentificación usando AK/SK" en 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 llamar 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 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 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), and xxxxxxxxxxxxxxxxxx con los valores reales. Obtener un nombre de proyecto de Regions y puntos de conexión.
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 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, 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.