HTTP Status code
This document defines the HTTP status code specification of the REST API.
Status code definition
| Code | describe | explicate |
|---|---|---|
| 200 | OK | Success! |
| 400 | Bad request | The request is invalid. The corresponding description will explain the reason. |
| 401 | Not verified | No verification information or verification failed. |
| 403 | Rejected | The request was understood but not accepted. The corresponding description will explain the reason. |
| 404 | not found | The resource does not exist. The requested user does not exist. The requested format is not supported. |
| 405 | The request method is inappropriate | The interface does not support the request for this method. |
| 410 | Offline | The requested resource is offline. Please refer to the relevant announcement. |
| 429 | Too many requests | The request exceeded the frequency limit. The corresponding description will explain the specific reason. |
| 500 | Internal service error | An internal error occurred on the server. Please contact us to solve the problem as soon as possible. |
| 502 | Invalid proxy | The service server is offline or being upgraded. Please try again later. |
| 503 | Temporary service failure | The server could not respond to the request. Please try again later. |
| 504 | Agent timeout | The server is running, but cannot respond to the request. Please try again later. |
Specifications to be followed
- 2200 must indicate success. Do not use the 200 status code for exceptions.
- For business logic errors, use 4xx for special error codes; otherwise, use 400.
- For internal server errors, if no specific error code is available, use 500.
- When business exceptions occur, the returned content uses JSON format to define error information.
