Help Center/ Service Tickets/ API Reference/ Calling APIs/ Returned Result
Updated on 2023-12-18 GMT+08:00
View PDF
Share

Returned Result

Status Code

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

For example, 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. You can use this token to authenticate the calling of other APIs.

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

(Optional) Response Body

This part is optional. A response body is generally returned in a structured format (for example, JSON or XML), corresponding to Content-Type in the response header, and is used to transfer content other than the response header.

The following is a part of the response body for the API used to obtain a user token.

 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, an error code and a message will be displayed. The following shows an error response body.

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

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

Parent topic: Calling APIs