Making an API Request

Request URI

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

A request URI is in the following format: {URI-scheme}://{Endpoint}/{resource-path}?{query-string}

The following table describes the parameters.

For example, if you want to create an IAM user, use the endpoint of any region because IAM is a global service. Obtain the endpoint of the AP-Singapore region (iam.ap-southeast-3.myhuaweicloud.com) and find resource-path (/v3.0/OS-USER/users) in the URI of the API for creating an IAM user. Then, construct them as follows:

https://iam.ap-southeast-3.myhuaweicloud.com/v3.0/OS-USER/users

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

For example, in the URI of the API for creating an IAM user, the request method is POST. An example request is as follows:

POST https://iam.ap-southeast-3.myhuaweicloud.com/v3.0/OS-USER/users

Request Header

You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.

Common request header fields are as follows:

• Content-Type: specifies the request body type or format. This field is mandatory and its default value is application/json. Other values of this field are provided for specific APIs, if any.
• Authorization: provides signature authentication information. This field is optional. When AK/SK authentication is enabled, this field is automatically specified for signing the request with SDK. For more information, see AK/SK-based Authentication.
• X-Sdk-Date: specifies the time when a request is sent. This field is optional. When AK/SK authentication is enabled, this field is automatically specified for signing the request with SDK. For more information, see AK/SK-based Authentication.
• X-Auth-Token: specifies a user token. This field is mandatory only when token-based API authentication is used. The user token is a response to the API used to obtain a user token. Only this API does not require authentication.
• X-Project-ID: specifies a subproject ID. This parameter is optional. It is used in multi-project scenarios. The X-Project-ID field is mandatory in the request header for accessing resources in a sub-project through AK/SK-based authentication.
• X-Domain-ID: specifies the account ID, which is optional. When you call APIs of global services using AK/SK-based authentication, X-Domain-ID needs to be configured in the request header.

The following shows an example request of the API for creating an IAM user when AK/SK authentication is used:

POST https://iam.ap-southeast-3.myhuaweicloud.com/v3.0/OS-USER/users
Content-Type: application/json
X-Sdk-Date: 20240416T095341Z 
Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

Request Body

A request body is often sent in a structured format defined by the request header field Content-Type and transfers information except the request header.

Request bodies vary with APIs. Some APIs do not require a request body, such as the APIs using GET and DELETE methods.

For the API used to create an IAM user as an administrator, you can find the request parameters and their descriptions in the API request. The following provides an example request with a body included. Replace the bold fields with the actual values.

• accountid indicates the ID of the account to which the IAM user belongs.
• username indicates the username of the IAM user to be created.
• email indicates the email address of the IAM user.
• ********** indicates the login password of the IAM user.

POST https://iam.ap-southeast-3.myhuaweicloud.com/v3.0/OS-USER/users
Content-Type: application/json
X-Sdk-Date: 20240416T095341Z 
Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** 
 
{ 
     "user": { 
         "domain_id": "accountid", 
         "name": "username", 
         "password": "**********", 
         "email": "email", 
         "description": "IAM User Description" 
     } 
 }

If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding.