Making an API Request

Request URI

A request URI is in the following format:

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

For example, to obtain an IAM token in the AP-Singapore region, obtain the endpoint of IAM (iam.ap-southeast-3.myhuaweicloud.com) for this region and the resource-path (/v3/auth/tokens) in the URI of the API used to obtain a user token. Then, construct the URI as follows:

https://iam.ap-southeast-3.myhuaweicloud.com/v3/auth/tokens

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 Method

The HTTP protocol defines the following request methods that can be used to send a request to the server.

For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:

POST https://iam.ap-southeast-3.myhuaweicloud.com/v3/auth/tokens

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 authentication information, add Content-Type, which specifies the request body type.

Table 3 lists common request headers.

For details about other headers, see the HTTP protocol.

The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:

POST https://iam.ap-southeast-3.myhuaweicloud.com/v3/auth/tokens  Content-Type: application/json

Request Body

The body of a request is often sent in a structured format as specified in the Content-Type header field. If the request body contains full-width 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.

In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxx (project ID, for example, ap-southeast-3) with the actual values. To learn how to obtain a project ID, see Regions and Endpoints.

scope specifies where a token takes effect. In the example, the token takes effect only on the resources specified by the project ID. You can set scope to an account or a project under an account. For more information about this API, see Obtaining a User Token Through Password Authentication.

POST https://iam.ap-southeast-3.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"  
            }  
        }  
    }  
}

If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to obtain a user token, x-subject-token is the desired user token. This token can then be used to authenticate the calling of other APIs.