Updated on 2022-06-09 GMT+08:00

Returned Result

Status Code

After sending a request, you will receive a response containing the status code, response header, and response body.

A status code is a group of digits ranging from 1xx to 5xx. It indicates the status of a response. For more information, see Status Codes.

If status code 201 is returned for the calling of the API for obtaining a user token, the request is successful.

Response Header

A response header corresponds to a request header, for example, Content-type.

Table 1 Response header

Parameter

Description

Content-Length

Length of the response body. The unit is byte.

Date

Time when a response is returned.

Content-Type

MIME type of the response body.

For the response header for the API of obtaining a user token, x-subject-token is the desired user token. See Figure 1. Then, you can use the token to authenticate the calling of other APIs.

Figure 1 Header of the response to the request for obtaining a user token

Response Body

A response body is generally returned in a structured format, corresponding to Content-Type in the response header, and is used to transfer content other than the response header.

The following shows part of the response body for the API to obtain a user token.

{ 
    "token": { 
        "expires_at": "2019-02-13T06:52:13.855000Z", 
        "methods": [ 
            "password" 
        ], 
        "catalog": [ 
            { 
                "endpoints": [ 
                    { 
                        "region_id": ap-southeast-1, 
......

If an error occurs during API calling, the system returns an error code and a message to you. The following shows the format of an error response body:

{ 
    "error_msg": "The format of message is error", 
    "error_code": "AS.0001" 
}

In the response body, error_code is an error code, and error_msg provides information about the error.