REST API HTTP Status Codes and Error Messages Reference
This section provides information about the status codes and error messages that can be received by a REST API client of Oracle Messaging Cloud Service.
Topics:
Generic Meanings of HTTP Response Status Codes
The following table lists HTTP response status codes and their meanings:
Response Status Code | Meaning |
---|---|
200 Ok |
Successful requests other than creations and deletions. |
201 Created |
Successful creation of a queue, topic, temporary queue, temporary topic, session, producer, consumer, listener, queue browser, or message. |
204 No Content |
Successful deletion of a queue, topic, session, producer, or listener. |
400 Bad Request |
The path info doesn't have the right format, or a parameter or request body value doesn't have the right format, or a required parameter is missing, or values have the right format but are invalid in some way (for example, |
403 Forbidden |
The invoker is not authorized to invoke the operation. |
404 Not Found |
The object referenced by the path does not exist. |
405 Method Not Allowed |
The method is not one of those allowed for the path. |
409 Conflict |
An attempt was made to create an object that already exists. |
500 Internal Server Error |
The execution of the service failed in some way. |
Response bodies for status codes greater than or equal to 400 are either empty or contain an error response in JSON or XML format. For more information, see Understanding Error Responses.
Error Keys, Status Codes and Error Messages
This section gives a list of the distinct error responses that can be generated by the REST API.
Topics:
The error responses are listed first by their associated HTTP status code. Within each status code, the error responses are listed by their key. The error key is the last component of the error code returned in the response. That is, each error code has the form:
urn:oracle:cloud:errorcode:messaging:error key
For example, the error with key methodNotAllowed
has error code urn:oracle:cloud:errorcode:messaging:methodNotAllowed.
For each error key, we give the associated error message followed by further explanation if the error message is not self-explanatory.
Errors with HTTP Status Code 400 (Bad Request)
This section provides information about errors with HTTP status code 400
.
Error Message | Description |
---|---|
badAntiCsrf
|
The anti-CSRF token is enabled, but the request either did not submit the token in header |
badContentType
|
The method and URL path must have content of a particular media type in its body, and the |
badParameter
|
The value submitted for a parameter is malformed (for example, it should be an integer but doesn't parse as an integer, or should specify a destination but doesn't start with |
badProperty
|
The value submitted for a message property via an |
badSelector
|
A message selector was found to be invalid. |
clientIdFailure
|
A client ID was submitted that is invalid or is already in use, either by a listener, another client, or by the current client. |
clientIdUnsettable
|
The client attempted to set a client ID on the connection after performing an operation that puts the connection in a state where its client ID is no longer settable. This includes creating a session and any other (successful) operation that requires the prior creation of a session. |
connectionParameterNotFound
|
The client attempted to create a session with a connection name that is not the name of an existing connection. |
destinationParameterNotFound
|
A queue or topic submitted in the request does not exist. This key is used when the destination is not the resource specified in the URL path, but rather when it is specified as, for example, a |
disallowedSubscriptionLookup
|
The method to list durable subscriptions and their properties specified a combination of parameters that is not one of the supported combinations. The error message will give a space-delimited list consisting of some collection of the strings |
durableSubscriberOnTemporaryTopic
|
An attempt was made to create a consumer on a temporary topic that uses a durable subscription. Durable subscriptions are not allowed on temporary topics. |
forbiddenContentType
|
A send request was made whose |
forbiddenParameter
|
A parameter was submitted that is not allowed with a given method and URL path. The error message gives both the query string parameter and the header name for the parameter. |
incompleteGroupProperties
|
One of the mandatory parameters was not set when sending messages using message groups. |
invalidPath
|
The URL path of a request is not a supported path or is malformed. Specific problems include the following:
|
localModeNonTopic
|
A request specified a local mode (whether messages sent to a destination via this connection should be received by consumers on this connection) with a destination that is not a topic (in which case a local mode is not appropriate). |
malformedAcceptHeader
|
The service was unable to process the |
malformedDestination
|
A destination specification did not have the proper syntax (for example, it did not start with one of the following forms):
|
malformedListener
|
The message push listener specification did not have the proper syntax. For examples of well-formed XML and the proper syntax to use, see Create a Listener. |
maxConnectionsReached
|
An operation has been attempted that would create a new JMS connection (sending a message, receiving a message, setting the client ID on an connection, and so on), and the service instance is already at the maximum number of concurrent connections it's allowed. |
maxDurableSubscriptionsReached
|
Self-explanatory. |
maxLocalConnectionsReached
|
The service instance has exceeded the number of connections it can create on a single virtual machine in the cloud. This usually means that the service instance has reached, or even gone beyond, the maximum number of allowed connections. |
maxMessagesOnTargetDestinationReached
|
Self-explanatory. |
maxMessageBytesOnTargetDestinationReached
|
Self-explanatory. |
maxQueuesReached
|
Self-explanatory. |
maxTempDestinationsOnConnectionReached
|
Self-explanatory. |
maxTopicsReached
|
Self-explanatory. |
messageHeadersTooLarge
|
The request's message-relevant headers exceeded the maximum size. |
messageBodyTooLarge
|
The request's body exceeded the maximum size. |
messageTotalTooLarge
|
A message whose headers and body were within the limitations exceeded the JMS broker's threshold for the size of the internal representation of a message. |
messagePushListenerVerificationBadResponse
|
An HTTP or HTTPS endpoint responded to a verification request with a response body that did not match the challenge token sent by Oracle Messaging Cloud Service. |
messagePushListenerVerificationConnectionFailed
|
Oracle Messaging Cloud Service was unable to connect to an HTTP or HTTPS endpoint to send a verification request. |
messagePushListenerVerificationErrorResponse
|
An HTTP or HTTPS endpoint responded to a verification request with a status code other than 200. |
messagePushListenerVerificationException
|
An exception occurred in attempting to read the response to a verification request. |
messagePushListenerVerificationNoToken
|
The listener XML specifies at least one HTTP or HTTPS URL to which to push messages, but no |
missingParameter
|
A parameter that is required for the method and URL path of the request was not supplied, either as a query string parameter or a header. The error specifies the query string parameter and header name for the missing parameter. |
multipleDestinations
|
A send via a producer was requested, but either the request specified no destination and the producer had no default destination or the request specified a destination and the producer had a default destination. |
noContentType
|
A request was made that must have a specific media type, but no |
noDestinationForConsumer
|
A request was made to create a consumer, but no destination was specified, and no existing durable subscription (from which a destination could be extracted) was specified. |
nonexistentNamespace
|
The namespace (specified by a service name and an identity domain name) specified for the request did not exist. |
nonexistentNamespaceComponents
|
The namespace specified for the request did not exist. |
nonexistentNamespaceUnknown
|
The namespace specified in the request URL did not exist. |
serviceInstanceChanged
|
The client request that created the current messaging context specified a service instance by using a URL path whose first component had the form service name of the instance-identity domain name of the instance but the current request has supplied a different first component on its URL path. The service instance may not be changed for a given messaging context. If a REST client wishes to access multiple service instances simultaneously, it must use multiple messaging contexts with different |
sessionParameterNotFound
|
This error is generated when a nonexistent session is specified as a query string parameter or a header, rather than via the URL path. |
subscriptionInUse
|
This error is generated in two circumstances:
|
subscriptionNonTopic
|
An attempt has been made to create a consumer with a durable subscription with a specified destination that is not a topic. This error is generated when it is possible to determine from the request alone that the destination is not a topic (for example, if the parameter specifying the consumer starts with / |
subscriptionNotFoundNoInfo
|
A durable subscription was not found, but no information about that durable subscription was available. |
subscriptionParameterNotFound
|
This error is generated when the nonexistent subscription is specified as a query string parameter or a header, rather than via the URL path. |
timeoutTooLarge
|
The value of the |
timeToLiveTooLarge
|
A requested time-to-live, either for a producer being created, a producer being modified, or a message being sent, is longer than the maximum allowed (2 weeks). |
Errors with HTTP Status Code 403 (Forbidden)
This section provides information about errors with HTTP status code 403
.
Error Message | Description |
---|---|
adminRequired
|
Self-explanatory. |
noRoles
|
The user has authenticated, but has neither of the roles (Messaging Administrator or Messaging Worker) required for any of the messaging operations. |
Errors with HTTP Status Code 404 (Not Found)
All errors in this category are returned when a resource specified on the URL path does not exist.
Error Message | Description |
---|---|
connectionNotFound
|
Self-explanatory. |
consumerNotFound
|
Self-explanatory. |
destinationNotFound
|
Self-explanatory. |
listenerNotFound
|
Self-explanatory. |
producerNotFound
|
Self-explanatory. |
queueBrowserNotFound
|
Self-explanatory. |
sessionNotFound
|
Self-explanatory. |
subscriptionNotFound
|
An attempt has been made to delete a nonexistent subscription via a session. |
subscriptionNotFoundFull
|
As attempt has been made to retrieve the properties of a nonexistent durable subscription. |
Errors with HTTP Status Code 405 (Method Not Allowed)
This section provides information about errors with HTTP status code 405
.
Error Message | Description |
---|---|
methodNotAllowed
|
Self-explanatory. |
Errors with HTTP Status Code 406 (Not Acceptable)
This section provides information about errors with HTTP status code 406
.
Error Message | Description |
---|---|
unacceptable
|
Self-explanatory. |
Errors with HTTP Status Code 409 (Conflict)
This section provides information about errors with HTTP status code 409
.
Error Message | Description |
---|---|
connectionAlreadyExists
|
Self-explanatory. |
consumerAlreadyExists
|
Self-explanatory. |
destinationAlreadyExists
|
Self-explanatory. |
listenerAlreadyExists
|
Self-explanatory. |
producerAlreadyExists
|
Self-explanatory. |
queueBrowserAlreadyExists
|
Self-explanatory. |
sessionAlreadyExists
|
Self-explanatory. |
subscriptionAlreadyExists
|
Self-explanatory. |
Errors with HTTP Status Code 500 (Internal Server Error)
This section provides information about errors with HTTP status code 500
.
Error Message | Description |
---|---|
failedGetConnectionProps
|
A failed attempt was made to get properties related to connections to the JMS broker. |
failedGetDestinationConnectionProps
|
A failed attempt was made to get properties related to connections to the JMS broker for a specific destination. |
failedGetDestinationProps
|
A failed attempt was made to get properties related to a specific destination. |
failedGetServiceProps
|
A failed attempt was made to get properties related to a specific service instance. |
maxConnectionCountUnavailable
|
An internal error has occurred in determining the number of connections that a service instance is allowed. |
messagePushListenersInterrupted
|
Self-explanatory. |
messagePushListenerVerificationRedirectionDisableFailed
|
A failed attempt was made to disable HTTP redirects for the message push listener verification request. |
operationFailed
|
A low-level failure occurred in attempting to carry out the latest request. |