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 Code.

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.

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

For security purposes, you are advised to store the token in ciphertext in the configuration file or environment variable.

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

(Optional) Response Body

The body of a response is often returned in structured format (such as JSON or XML) as specified in the Content-type header field. The response body transfers content except the response header.

The response body for the API of creating an IAM user is shown as follows. 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": "XXXXXX",
......

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 preceding information, error_code is an error code, and error_msg describes the error.