このページは、お客様の言語ではご利用いただけません。Huawei Cloudは、より多くの言語バージョンを追加するために懸命に取り組んでいます。ご協力ありがとうございました。

Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
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
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
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
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
Software Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
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
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Updated on 2023-06-06 GMT+08:00

Making an API Request

This section describes the structure of a REST API, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained token can then be used to authenticate the calling of other APIs.

Figure 1 Example request

Request URI

A request URI is in the following format:

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

Although a request URI is included in a request header, most programming languages or frameworks require the request URI to be transmitted separately.

Table 1 URI parameters

Parameter

Description

URI-scheme

Protocol used to transmit requests. All APIs use HTTPS.

Endpoint

Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from Regions and Endpoints.

resource-path

Resource path, that is, the API access path. Obtain the path from the URI of an API. For example, the resource-path of the CBS API used to obtain the list of questions is /v1/{project_id}/qabots/{qabot_id}/suggestions. {project_id} indicates the project ID, which can be obtained by referring to Obtaining a Project ID. {qabot_id} indicates the Q&A bot ID, which can be obtained from the QABot console of CBS.

query-String

Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, ? limit=10 indicates that a maximum of 10 data records will be displayed. This parameter is not used.

For example, to obtain the list of questions in the CN-Hong Kong region, obtain the endpoint (cbs-ext.ap-southeast-1.myhuaweicloud.com) of this region and the resource-path (/v1/{project_id}/qabots/{qabot_id}/suggestions) in the URI of the API used to obtain the list of questions. Then, construct the URI as follows:

https://cbs-ext.ap-southeast-1.myhuaweicloud.com/v1/{project_id}/qabots/{qabot_id}/suggestions
Figure 2 Example URI

To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme value of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.

Request Methods

The HTTP protocol defines the following request methods that can be used to send a request to the server:
Table 2 HTTPS methods

Method

Description

GET

requests the server to return specified resources.

PUT

requests the server to update specified resources.

POST

requests the server to add resources or perform special operations.

DELETE

requests the server to delete specified resources, for example, an object.

HEAD

same as GET except that the server must return only the response header.

PATCH

requests the server to update partial content of a specified resource.

If the resource does not exist, a new resource will be created.

In the case of the API used to obtain the list of questions, the request method is POST. The request is as follows:

POST https://cbs-ext.ap-southeast-1.myhuaweicloud.com/v1/{project_id}/qabots/{qabot_id}/suggestions

Request Header

You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. Table 3 describes common request headers. For details about the request authentication information, see Authentication.

Table 3 Common request header fields

Parameter

Description

Mandatory

Example

Content-type

MIME type of the body in the request.

Yes

application/json

Content-Length

Length of the request body. The unit is byte.

This parameter is optional for POST or PUT requests, but not required for GET requests.

3495

X-Auth-Token

User token. It is used to obtain the permission to call APIs. For details about how to obtain the value, see Token Authentication.

Yes

MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

X-Language

Request language type.

No. The default value is zh-cn.

en-us

In addition to supporting token-based authentication, public cloud APIs also support authentication using access key ID/secret access key (AK/SK). During AK/SK-based authentication, an SDK is used to sign the request, and the Authorization (signature information) and X-Sdk-Date (time when the request is sent) header fields are automatically added to the request.

For more details, see AK/SK-based Authentication.

The API used to obtain the list of questions does not require authentication. Therefore, Content-Type and X-Auth-Token fields needs to be added to requests for calling the API. An example of such requests is as follows:

POST https://cbs-ext.ap-southeast-1.myhuaweicloud.com/v1/{project_id}/qabots/{qabot_id}/suggestions
Content-Type: application/json
X-Auth-Token: MIIaBgYJKoZIhvcNAQcC...

Request Body

A request body is generally sent in a structured format (for example, JSON or XML). It corresponds to Content-type in the request header and is used to transfer content other than the request header. If the request body contains Chinese characters, these characters must be coded in UTF-8.

The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.

For the API of obtaining the list of questions, obtain the request parameters and parameter description in the API request. The following provides an example request with a body included.

POST https://cbs-ext.ap-southeast-1.myhuaweicloud.com/v1/{project_id}/qabots/{qabot_id}/suggestions
Content-Type: application/json
X-Auth-Token: MIIaBgYJKoZIhvcNAQcC...
{
    "question":" Cloud desktop",
    "top":2
}

If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. For the API of obtaining the list of questions, obtain the request parameters and parameter descriptions from the response message.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more