API Errors

Common Errors Returned by All Services

The following table lists the common errors returned by all the services for Oracle Cloud Infrastructure.

HTTP Status Code Error Code Description Retry
400 CannotParseRequest The request is incorrectly formatted. No.
400 InvalidParameter A parameter is invalid or incorrectly formatted. No.
400 LimitExceeded Fulfilling this request exceeds the Oracle-defined limit for this tenancy for this resource type. No.
400 MissingParameter A required parameter is missing. No.
400 QuotaExceeded Fulfilling this request exceeds the administrator-defined quota for this compartment for this resource. No.
400 RelatedResourceNot AuthorizedOrNotFound

A resource specified in the body of the request was not found, or you do not have authorization to access that resource.

No.
401 NotAuthenticated

The required authentication information was not provided or was incorrect.

No.
403 NotAllowed This operation must be directed at the home region. No.
403 NotAuthorized You do not have authorization to update one or more of the fields included in this request. No.
403 SignUpRequired This operation requires opt-in before it may be called. No.
404 InvalidParameter A dynamic path component is invalid or is syntactically valid but is not allowed. No.
404 NotAuthorizedOrNotFound A resource specified via the URI (path or query parameters) of the request was not found, or you do not have authorization to access that resource. For more information, see HTML Status Code 404. No.
404 NotFound There is no operation supported at the URI path and HTTP method you specified in the request. No.
404 NamespaceNotFound You do not have authorization to perform this request, or the requested resource could not be found. No.
405 MethodNotAllowed The target resource does not support the HTTP method. No.
409 Conflict The requested state for the resource conflicts with its current state. This state is not transient. No.
409 IncorrectState The requested state for the resource conflicts with its current state but given some amount of time it will be in the correct state. Yes, with backoff. Refer to the error description for any required actions before you retry.
409 InvalidatedRetryToken The provided retry token was used in an earlier request that resulted in a system update, but a subsequent operation invalidated the token. This can happen, for example, in cases where an entity created with the same token has since been deleted. If the system state change that is associated with this request should be performed again, retry it using a different token. No.
409 NotAuthorizedOrResourceAlreadyExists You do not have authorization to perform this request, or the resource you are attempting to create already exists. This error code is returned only from create operations, where it is returned instead of the more general NotAuthorizedOrNotFound error code. No.
412 NoEtagMatch The ETag specified in the request does not match the ETag for the resource. No.
413 PayloadTooLarge The request entity is larger than limits defined by server. No.
422 UnprocessableEntity Payload is syntactically correct but semantically invalid. No.
429 TooManyRequests You have issued too many requests to the Oracle Cloud Infrastructure APIs in too short of an amount of time. Yes, with backoff.
431 RequestHeaderFieldsTooLarge The request's HTTP headers are too long. The request may be resubmitted after reducing the size of the request headers. No.
500 InternalServerError An internal server error occurred. Yes, with backoff.
501 MethodNotImplemented The HTTP request target does not recognize the HTTP method. No.
503 ExternalServerUnreachable A connection with an external system needed to fulfill the request could not be established. Yes, with backoff.
503 ExternalServerTimeout A connection with an external system needed to fulfill the request timed out before a response was received. Yes, with backoff.
503 ExternalServerInvalidResponse A connection with an external system needed to fulfill the request resulted in an unacceptable response. Yes, with backoff.
503 ServiceUnavailable The service is currently unavailable. Yes, with backoff.

API Error Details and Troubleshooting

This section contains detailed information and troubleshooting suggestions for HTTP Status error codes.

HTTP Status 400 Error Codes

RelatedResourceNotAuthorizedOrNotFound

Description

A resource specified in the body of the request was not found, or you do not have authorization to access that resource.

Troubleshooting

  • Authorization error: Verify that the user making the request is in a group that has the permissions to work with resources in a compartment. To understand more about permissions, see Policy Reference.
  • Compartment or resource not found: Verify that the compartment or resource exists and is referenced correctly.

InvalidParameter

Description

A parameter value is invalid or incorrectly formatted.

Troubleshooting

  • Refer to the REST API documentation for the operation and check parameters in the request for typos or incorrect formats and correct the request.

MissingParameter

Description

A required parameter is missing

Troubleshooting

  • The request is missing a required parameter for this API. Refer to the REST API documentation for the operation and correct the request.

QuotaExceeded

Description

Fulfilling this request exceeds the administrator-defined quota for this compartment for this resource.

Troubleshooting

  • The administrator-defined quota for this compartment for this resource would be exceeded by fulfilling this request. Check the resource quota and request an increase for the quota or clean up unused resources if necessary. To understand more about quotas, see: Compartment Quotas.

LimitExceeded

Description

Fulfilling this request exceeds the Oracle-defined limit for this tenancy for this resource type.

Troubleshooting

  • The Oracle-defined limit for this tenancy for this resource type would be exceeded by fulfilling this request. Check the tenancy level limit for this resource and request a limit increase on the tenancy or clean up unused resources and re-send the request. To understand more about your OCI service limits and how to request a limit increase, see Service Limits.

CannotParseRequest

Description

The request is incorrectly formatted.

Troubleshooting

  • The request for most operations that take a body should be formatted as JSON. See the REST API documentation for the operation to confirm if the operation takes JSON, and if so confirm you are passing valid JSON in the request body.

InvalidStorageTier

Description

The request is using an invalid Storage Tier.

Troubleshooting

  • The storageTier parameter provided is not correct. Refer to the REST API documentation for the operation and correct the request.

HTTP Status 401 Error Codes

NotAuthenticated

Description

The required authentication information was not provided or was incorrect.

Troubleshooting

There are several things that can trigger this error code:

  • Missing or incorrect authentication information.
    • Verify that all of the required information (tenant OCID, user OCID, fingerprint, and private key) is provided and accurate
    • Verify your private_key_path is pointing to your private key and not the corresponding public key
    • Verify the public/private key pairs you are using are in the correct format
    • Verify the user account is part of a group with the appropriate permissions to perform the actions in the plan you are executing
    • Verify your tenancy has been subscribed to the region you are targeting in your plan
    • Verify that the public key corresponding to the fingerprint has been uploaded for the user you are making the request as. For more information, see Required Keys and OCIDs.
  • Clock skew. This status code is returned if the client's clock is skewed more than five (5) minutes from the server's clock. For more information, see Maximum Allowed Client Clock Skew.
  • API request signature error. This status code is returned if a required piece of information is missing or is malformed in the Authorization header. For more information, see Request Signatures.

HTTP Status 403 Error Codes

SignUpRequired

Description

This operation requires opt-in before it can be called.

Troubleshooting

  • Make sure that the user is signed up for this feature. If not, please contact support and sign up for this service.

NotAllowed

Description

This operation must be directed at the home region.

Troubleshooting

  • This operation must be directed at the home region. Update the source code to provide the correct region information.

NotAuthorized

Description

You do not have authorization to update one or more of the fields included in this request.

Troubleshooting

  • Check the request and remove any unauthorized fields. To understand more about permissions, see Policy Reference.

HTTP Status 404 Error Codes

NamespaceNotFound

Description

A resource specified via the URI (path or query parameters) of the request was not found, or you do not have authorization to access that resource.

Troubleshooting

  • The resource is not found or the caller is not authorized to perform requested operation on the resource, for a resource specified via the request URI for GET (list or single entity get), UPDATE, and DELETE operations. Check that the requested resource actually exists and that you have access to it. To understand more about permissions, see Policy Reference.

NotFound

Description

There is no operation supported at the URI path and HTTP method you specified in the request.

Troubleshooting

  • Either the static path components do not exist or you are unauthorized to access them. Check the request and update the static path component.

NotAuthorizedOrNotFound

Description

A resource specified via the URI (path or query parameters) of the request was not found, or you do not have authorization to access that resource.

Troubleshooting

  • The resource is not found or the caller is not authorized to perform requested operation on the resource, for a resource specified via the request URI for GET (list or single entity get), UPDATE, and DELETE operations. Check that the requested resource actually exists and that you have access to it. To understand more about permissions, see Policy Reference.

InvalidParameter

Description

A parameter specified in the path is invalid or is syntactically valid but is not allowed.

Troubleshooting

  • Check the parameters in the request for typos or incorrect formats. Refer to the REST API documentation for the operation and correct the request.

HTTP Status 405 Error Codes

MethodNotAllowed

Description

The target resource does not support the HTTP method used.

Troubleshooting

  • The HTTP method in the request (for example, PUT, POST, DELETE, or GET) is not allowed by the target resource. Check if the intended HTTP method is specified correctly, and check the REST API documentation for the operation to confirm you are using the correct HTTP method.

HTTP Status 409 Error Codes

NotAuthorizedOrResourceAlreadyExists

Description

You do not have authorization to perform this request, or the resource you are attempting to create already exists. This error code is returned only from create operations, where it is returned instead of the more general NotAuthorizedOrNotFound error code.

Troubleshooting

  • If the request is to create a resource, check that the resource does not already exist and that the calling user is authorized to create this type of resource in this compartment.
  • Verify that the user is in a group that has the permissions to work with resources in a compartment. To understand more about permissions, see Policy Reference.

InvalidatedRetryToken

Description

The provided retry token was used in an earlier request that resulted in a system update, but a subsequent operation invalidated the token. This can happen in cases where an entity created with the same token has since been deleted. If the system state change that is associated with this request needs to be performed again, use a different token.

Troubleshooting

  • Check the source code and verify that the retry token is used correctly.

IncorrectState

Description

The requested state for the resource conflicts with its current state but given some amount of time it will be in the correct state.

Troubleshooting

  • Check resource dependencies. A resource cannot be deleted if it is still used by other resources.
  • Try the request again later or update the code to wait for the right state to be reached before performing this action. Some operations require the resource to be in a certain state (for example, running).

Conflict

Description

The requested state for the resource conflicts with its current state. This state is not transient.

Troubleshooting

  • Check the requested resource state and try again.

HTTP Status 412 Error Codes

NoEtagMatch

Description

The ETag specified in the if-match field of the request does not match the ETag for the resource.

Troubleshooting

Correct ETag in the request if this is not expected. For more information on ETags, see the Etag documentation.

HTTP Status 413 Error Codes

PayloadTooLarge

Description

The request entity is larger than limits defined by server.

Troubleshooting

Try sending a smaller request.

HTTP Status 422 Error Codes

UnprocessableEntity

Description

The payload is syntactically correct but semantically invalid.

Troubleshooting

The service is unable to process the request. Check the request and reformat if necessary.

HTTP Status 429 Error Codes

TooManyRequests

Description

You have issued too many requests to the Oracle Cloud Infrastructure APIs too quickly.

Troubleshooting

This is caused by too many requests within a small amount of time. If the service has throttling mechanisms, too many requests within a short period of time will result in some requests being rejected. Try adding some delays between requests to avoid this error.

HTTP Status 431 Error Codes

RequestHeaderFieldsTooLarge

Description

The HTTP headers in the request are too long.

Troubleshooting

The request may be resubmitted after reducing the size of the request headers.

HTTP Status 500 Error Codes

InternalServerError

Description

An internal server error occurred.

Troubleshooting

The service failed to process the request for unknown reasons. This is usually an issue on the service side, possibly due to a temporary service outage or a bug.

  • Retry sending the same request. It may go through if the service has recovered from the temporary outage.
  • If the retry still fails, contact OCI technical support and include the opc-request-id from the HTTP request or response that failed in your message.

HTTP Status 501 Error Codes

MethodNotImplemented

Description

The HTTP request target does not recognize the HTTP method.

Troubleshooting

The HTTP method in the request is not implemented on the service. Refer to the REST API documentation for the operation and update the request to use the right HTTP method for the operation.

HTTP Status 503 Error Codes

ServiceUnavailable

Description

The service is currently unavailable.

Troubleshooting

The service is currently unavailable. Retry sending the same request after some time. It may go through if the service has recovered from the temporary unavailability. If the retry still fails, contact OCI technical support and include the opc-request-id from the HTTP request or response which failed.