Making an API 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 the request header, most programming languages or frameworks require the request URI to be transmitted separately.

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

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 headers include:

• 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 (if any) will be provided for specific APIs.
• Authorization: specifies signature authentication information. This field is optional. When AK/SK authentication is enabled, this field is automatically specified when SDK is used to sign the request. 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 when SDK is used to sign the request. For more information, see "AK/SK-based Authentication".
• X-Auth-Token: specifies a user token only for token-based API authentication. The user token is a response to the API used to . This API is the only one that does not require authentication.
• X-Project-ID: specifies subproject ID. This field is optional and can be used in multi-project scenarios. This 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.

Request Body

The body of a request is often sent in a structured format (JSON or XML) as specified in the Content-type header field. The request body transfers content except the request header. If the request body contains Chinese characters, these characters must be coded in UTF-8. Specify the character encoding mode in Content-type, for example, Content-Type: application/json; charset=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 , the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included.

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

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" 
      } 
  }

The content required by an API request is ready. You can use curl, Postman, or write code to send the request to call the API.