Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Cómputo
Elastic Cloud Server
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Redes
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Gestión y gobernanza
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
Cloud Operations Center
Resource Governance Center
Migración
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Análisis
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
IoT
IoT Device Access
Otros
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Seguridad y cumplimiento
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Servicios multimedia
Media Processing Center
Video On Demand
Live
SparkRTC
Almacenamiento
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Contenedores
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Bases de datos
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Aplicaciones empresariales
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Data Lake Factory
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Distribución de contenido y cómputo de borde
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Soluciones
SAP Cloud
High Performance Computing
Servicios para desarrolladores
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
Cloud Application Engine
aPaaS MacroVerse
KooPhone
KooDrive

Hacer una solicitud de API

Actualización más reciente 2022-11-07 GMT+08:00

Esta sección describe la estructura de una solicitud de API de REST y utiliza la API de Identity and Access Management (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.

  • 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 endpoint varía entre los servicios en diferentes regiones. Se puede obtener de Regiones y endpoint. Por ejemplo, el endpoint de IAM en la región AP-Bangkok region is iam.ap-southeast-2.myhwclouds.com
  • resource-path: ruta de acceso de una API para realizar una operación especificada. Obtenga la ruta de acceso desde el URI de una API. Por ejemplo, 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 incluya un signo de interrogación (?) antes de cada parámetro de consulta que tenga el formato de "Nombre de parámetro=Valor de parámetro". 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 AP-Bangkok, obtenga el endpoint de IAM (iam.ap-southeast-2.myhwclouds.com) para esta región y el resource-path (/v3/auth/tokens) en URI de la API utilizada para obtener un token de usuario. A continuación, construya el URI de la siguiente manera:

https://iam.ap-southeast-2.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 resource-path y un método de solicitud. El URI-scheme de todas las API es HTTPS, y los endpoints de todas las API de 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 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-2.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. Otros valores de este campo se proporcionarán para APIs específicas si los hay.
  • 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 usada para obtener un token de usuario. 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 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.

  • X-Project-ID: especifica un ID de subproyecto. Este parámetro solo es obligatorio en escenarios de varios proyectos.
  • X-Domain-ID: especifica un ID de cuenta.

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-2.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, 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 username, domainname, ******** (la contraseña de acceso) y xxxxxxxxxxxxxxxxxx (ID del proyecto) por los valores reales. Para obtener información sobre cómo obtener un ID de proyecto, consulte Regiones y endpoint.

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 Obtener un token de usuario.

POST https://iam.ap-southeast-2.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 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 usada 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.

Utilizamos cookies para mejorar nuestro sitio y tu experiencia. Al continuar navegando en nuestro sitio, tú aceptas nuestra política de cookies. Descubre más

Comentarios

Comentarios

Comentarios

0/500

Seleccionar contenido

Enviar el contenido seleccionado con los comentarios