Updated on 2022-12-05 GMT+08:00

Responses

Status Codes

After sending a request, you will receive a response, including a 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 request. For more information, see Status Codes.

If status code 201 is returned for calling the API used to obtain a user token, the request is successful.

Response Headers

Similar to a request, a response also has a header, for example, Content-type.

Figure 1 shows the response header fields for the API used to obtain a user token. The X-Subject-Token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.

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

Response Body

A response body conveys information other than the response header and is generally sent in a structured format (for example, JSON or XML) defined by the Content-type field.

The following is a part of the response body for the API used to obtain a user token. 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": "az-01",
......

If an error occurs during API calling, the system returns an error code and 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.