On this page

Status Line
Response Header
Response Body

Show all

Help Center/ Cognitive Engagement Center/ User Access--Web Client Access (RESTful)/ Overview/ RESTful API Format/ Response Message

Response Message

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

View PDF

A response message consists of a status line, response header, and response body. Table 1 describes the response message format.

**Table 1** Response message format
HTTP/HTTPS Response Message
HTTP/HTTPS response line	HTTP-Version Status-Code Reason-Phrase NOTE: There is a space between HTTP-Version and Status-Code, and between Status-Code and Reason-Phrase. There is a carriage return after Reason-Phrase.
Response header	Content-Type:application/json;charset=UTF-8
Response header	...
Blank line	CRLF
Message body (optional)	Business request message (JSON description)

Status Line

HTTP-Version Status-Code Reason-Phrase CRLF

In the preceding information:

HTTP-Version: HTTP version number of the server.
Status-Code: response status code returned by the server.
Reason-Phrase: text description of a status code.
A status code consists of three digits. The first digit defines the response type and has five options.
- 1xx: Informational - The request has been received and can be further processed.
- 2xx: Success - The request has been successfully received, parsed, and accepted.
- 3xx: Redirection - Further operations must be performed for completing the request.
- 4xx: Client error - The request has syntax errors or cannot be implemented.
- 5xx: Server error - The server fails to fulfill a valid request.
Common status codes are as follows:
- 200 OK: The request has succeeded.
- 400 Bad Request: The client request has syntax errors and cannot be parsed by the server.
- 401 Unauthorized: The request is unauthorized.
- 403 Forbidden: The server receives the request but refuses to provide services.
- 404 Not Found: The requested resource does not exist.
- 500 Internal Host Error: An unexpected error occurs on the server.
- 503 Host Unavailable: The server cannot process the client request now and may be able to process the request later.
Most of the time, 200 OK is returned:

HTTP/1.1 200 OK (CRLF)

Response Header

A response header usually contains the following header fields:

Date: Mon, 12 Nov 2007 15:55:01 GMT
Indicates the response sending time.
Content-Length: xxx
Specifies the length of the entity text and is stored as bytes in decimal number.
Content-Type: application/json; charset=UTF-8
Specifies the media type of the entity text sent to the recipient.

Response Body

The response body is in JSON format. For details, see the definition of each API in the following sections.

Parent topic: RESTful API Format

Previous topic: Request Message

Next topic: Message Body Parameter Conventions

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.

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback

Log In and Submit Submit Cancel