Response

Updated on 2025-05-28 GMT+08:00

View PDF

Status Code

[Example]

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.

If status code 201 is returned for the calling of the API for obtaining a user token, the request is successful.

Response Header

[Example]

Similar to a request, a response also has a header, for example, Content-Type.

Figure 1 shows the response header for the API used to obtain a user token, where x-subject-token is the desired user token. This token can be used to authenticate the calling of other APIs.

Figure 1 Response header for the API used to obtain a user token

Response Body

[Example]

A response body is generally sent in structured format as specified in Content-Type. The response body transfers content except the response header.

The following shows part of the response body for the API of obtaining a user token.

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

If an error occurs during API calling, an error code and a 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 indicates an error code, and error_msg describes the error.

Parent topic: Calling APIs

Previous topic: Authentication

Next topic: API

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