Share via

Service Management Status and Error Codes

  • Article

REST API operations for the Service Management API return standard HTTP status codes, as defined in the HTTP/1.1 Status Code Definitions.

API operations may also return additional error information that is defined by the management service. This additional error information is returned in the response body.

The body of the error response follows the basic format shown here.

<?xml version="1.0" encoding="utf-8"?>
<Error>
  <Code>string-code</Code>
  <Message>detailed-error-message</Message>
</Error>

The following table describes common errors that may be returned by the management service.

Error code HTTP status code User message

MissingOrIncorrectVersionHeader

Bad Request (400)

The versioning header is not specified or was specified incorrectly.

InvalidXmlRequest

Bad Request (400)

The request body’s XML was invalid or not correctly specified.

MissingOrInvalidRequiredQueryParameter

Bad Request (400)

A required query parameter was not specified for this request or was specified incorrectly.

InvalidHttpVerb

Bad Request (400)

The HTTP verb specified was not recognized by the server or isn’t valid for this resource.

AuthenticationFailed

Forbidden (403)

The server failed to authenticate the request. Verify that the certificate is valid and is associated with this subscription.

ResourceNotFound

Not Found (404)

The specified resource does not exist.

InternalError

Internal Server Error (500)

The server encountered an internal error. Please retry the request.

OperationTimedOut

Internal Server Error (500)

The operation could not be completed within the permitted time.

ServerBusy

Service Unavailable (503)

The server (or an internal component) is currently unavailable to receive requests. Please retry your request.

SubscriptionDisabled

Forbidden (403)

The subscription is in a disabled state.

BadRequest

Bad Request (400)

A parameter was incorrect.

ConflictError

Conflict (409)

A conflict occurred to prevent the operation from completing.

TemporaryRedirect

Temporary Redirect (307)

The requested object is not available. A temporary URI for the new location of the object can be obtained from the Location field in the response. The original request can be repeated on the new URI.