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 after calling the Obtaining a User Token API, the request is successful.

Response Header

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

Figure 1 shows the request header fields returned after calling the Obtaining a User Token API. x-subject-token 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 is part of the response body for the Obtaining a User Token API. 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",
......

1
2
3
4
5
6
7
8

{
	
	"error":{
		"code":401,
		"message": "The username or password is wrong.",
		"title": "Unauthorized"
	}
}

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