Response

Updated on 2024-04-03 GMT+08:00

View PDF

Status Code

After sending a request, you can receive a response, including 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 response. For more information, see Status Codes.

For example, if status code 201 is returned after you call the API for obtaining a user token, the request is successful.

Response Header

Like 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. The x-subject-token field carries a user token. You can use this token to authenticate the calling of other APIs.

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

Response Body

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

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

   
    
      
      {
    "token": {
        "expires_at": "2022-09-10T06:52:13.855000Z",
        "methods": [
            "password"
        ],
        "catalog": [
            {
                "endpoints": [
                    {
                        "region_id": "cn-north-04",
......

     

   
  

If an error occurs during API calling, an error code and an error message will be displayed. The following is an example of an error response body.

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

error_code specifies an error code, and error_msg describes the error.

Parent topic: Calling APIs

Previous topic: Authentication

Next topic: APIs of Enterprise Edition VPN

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.

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