Response

Updated on 2023-04-23 GMT+08:00

View PDF

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 details, 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

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. This token can then be used to authenticate requests for calling other APIs.

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

Response Body

A response body is often returned in structured format. It corresponds to content-type header field and passes content except the response header.

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

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

If an error occurs during API calling, an error code and the corresponding error message will be displayed. The following shows 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.

Parent topic: Calling APIs

Previous topic: Authentication

Next topic: APIs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot