Error Codes and Messages

CMI Protocol defines error codes and corresponding message that appear in the response messages and in the description column of the audit log viewer.

An error response, or <ERRORMsg>, includes three parts: code, message, and description as described in Error Codes and Messages.

Error Codes and Messages

Code

Message

Description

100

No error occurred

The CMI protocol operation was executed successfully.

101

Session Time out

The session has timed out after a configurable time interval.

401

Authentication Failed

User does not exist or the pair username/password does not match.

402

Bad Request

Request is not correct, such as the request's payload does not conform to a schema, or some attributes in the request's aeschema are missing, or are in wrong format.

403

Data Violation

Request cannot be fulfilled because it conflicts with the existing data, such as when the update data does not exist in the configuration store.

404

Operation Not Supported

The requesting operation is not supported.

406

Authorization Error

The requesting user is not authorized to access the data.

407

ConfigStore Runtime Error

Unexpected exception happened in the configuration store layer.

500

Internal Error

Unexpected exception happened on an unknown place.

Examples

<ERRORMsg code=100 message="successful">
<ERRORMsg code=500 message="internal error" desc="db is down, can not access it for the time being">