Skip to main content
Response codes and error bodies are defined per endpoint. Select a status tab in the response example card to read its documented message above the example body. Copy copies only the example body. The Response section shows the schema for the status selected there; Try it shows the actual response after you send a request.

​
Documented error responses

The examples below quote the API definitions exactly. They describe the linked operation; another endpoint may declare different codes, descriptions, or response schemas.

​
400: Bad Request

Bad Request. The API gateway did not process the request because of invalid value of filter parameters. Source: GET /api/v1/brands.

​
401: Unauthorized

Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused. Source: GET /api/v1/brands.

​
403: Forbidden

Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project. Source: GET /api/v1/brands.

​
404: Not Found

Not Found. The API gateway did not process the request because the requested resource could not be found. Source: GET /api/v1/brands/id/{id}.

​
405: Method not allowed

Method not allowed. The API request can’t be performed due to a wrong edge node’s admin status. Source: GET /api/v1/devices/id/{id}/config/bootstrap.

​
409: Conflict

Conflict. The API gateway did not process the request because this hardware brand record will conflict with an already existing hardware brand record. Source: POST /api/v1/brands.

​
412: Precondition failed

Precondition failed. Some of preconditions haven’t been met to start request processing. Source: GET /api/v1/cluster.

​
500: Internal Server Error

Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes. Source: GET /api/v1/brands.

​
504: Gateway Timeout

Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request. Source: GET /api/v1/brands.

​
Default response

An unexpected error response. Source: GET /api/v1/brands.

​
Error response format

For the explicit error responses in Query brands, the definition uses ZsrvResponse. Its error-related fields are:

​
Error code values

error[].ec references ZsrvErrorCode. These are the enum values declared in the Edge nodes OpenAPI definition:
  • zMsgErrorNone
  • zMsgSucess
  • NotFound
  • AlreadyExists
  • VersionMismatch
  • RangeError
  • LargeResult
  • IncompleteData
  • InvalidData
  • FunctionUnsupported
  • NoMemory
  • SendFailure
  • Timeout
  • BadReqBody
  • BadReqParam
  • InvalidFieldFormat
  • UrlNotFound
  • ApiVersionNotSupported
  • Unauthorized
  • Forbidden
  • Conflict
  • NotModified
  • DependencyConflict
  • JsonFmtError
  • ProtoFmtError
  • CertError
  • DataBaseConnection
  • DBError
  • zMsgAccepted
  • zMsgCreated
  • PreConditionFailed
  • InternalServerError

​
Default error body

The same operation’s default response uses a different schema, googlerpcStatus, with these fields: Use the response schema on the endpoint you are calling to determine its documented fields.