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 request. 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. Use the token to authenticate the calling of other APIs.

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

(Optional) Response Body

A response body is usually 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.

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

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

{
    "code": "SVCSTG.AOS.4001110",
    "extend": "The template already exists!",
    "message": "Bad request, name of template is already used.",
    "showdetail": false
}

In the preceding information, code indicates an error code. extend is the error message set according to the actual situation. message provides the default description of the error. When showdetail is set to true, extend will be displayed. When showdetail is set to false, message will be displayed.