Returned Values

Status Code

After sending a request, you will receive a response, including 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.

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

Response Header

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

Figure Figure 1 shows the response header fields for the API that obtains a user token. The x-subject-token value is the desired user token. You can use the token to authenticate other API calls.

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 the 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. The following describes only part of the request body.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
    "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 a message to you. The following shows the format of an error response body:

1
2
3
4

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

In the preceding information, error_code is an error code, and error_msg describes the error.