Status Code Overview
Clients should first evaluate the HTTP status code and then read code in the response body.
Success Responses
| HTTP Status | Business Code | Description |
|---|---|---|
| 200 | SUCCESS | The request succeeded and returned a result |
| 202 | COMMAND_ACCEPTED | The command was accepted. The device execution result must be checked through command status |
Error Responses
| HTTP Status | Business Code | Description |
|---|---|---|
| 400 | INVALID_REQUEST | Request parameters, body, or headers are invalid |
| 401 | AUTH_REQUIRED | Missing Authorization request header |
| 401 | AUTH_INVALID | Authentication information is invalid |
| 401 | AUTH_EXPIRED | The access token has expired |
| 403 | AUTH_SCOPE_DENIED | The current client does not have the permission required by this endpoint |
| 404 | DEVICE_NOT_FOUND | The device does not exist, or the current client is not allowed to access it |
| 404 | COMMAND_NOT_FOUND | The command does not exist, or the current client is not allowed to access it |
| 409 | IDEMPOTENCY_CONFLICT | The same Idempotency-Key was used with a different request body |
| 422 | COMMAND_REJECTED | The command format is valid but was rejected for business reasons |
| 429 | RATE_LIMITED | The request hit a rate limit |
| 500 | INTERNAL_ERROR | Internal server error |