Error Codes (Web Sites Service REST API)
Applies To: Windows Azure Pack
REST API operations for the Service Management API return standard HTTP status codes, as defined in the HTTP/1.1 Status Code Definitions at http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.
In addition to standard HTTP status codes, the Service Management API returns extended error codes and error messages. The extended codes do not replace the standard HTTP status codes, but provide additional, actionable information that can be used in conjunction with the standard HTTP status codes. For example, an HTTP 404 error can occur for numerous reasons; therefore, the additional information in the extended message can assist with problem resolution.
The following example request and response shows the format of the extended error information in the response body.
Example
A user issues an HTTP GET request in the following format against a site named Fabrikam, which does not exist.
https://management.core.windows.net/\<Subscription-ID>/services/WebSpaces/<WebSpaceName>/sites/Fabrikam
The following example shows the response.
HTTP/1.1 404 Not Found
Content-Length: 391
Content-Type: application/xml; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Date: Thu, 17 Jan 2013 21:01:03 GMT
<Error xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Code>NotFound</Code>
<Message>Cannot find site Fabrikam.</Message>
<ExtendedCode>04009</ExtendedCode>
<MessageTemplate>Cannot find site {0}.</MessageTemplate>
<Parameters xmlns:a="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a:string>Fabrikam</a:string>
</Parameters>
</Error>
The following table describes the key elements in the extended message.
Element name |
Description |
---|---|
Code |
The text string of the relevant standard HTML status code without spaces. |
Message |
The text of the extended error message that is provided to the user. |
ExtendedCode |
An extended error code, which is a numeric value that is unique to this error type. For a list of extended codes, see the tables in the following section "Extended Error Codes". |
MessageTemplate |
A template of the actual message that is presented to the user, with place holders that are filled with information from the Parameters element. |
Parameters |
A container for strings that fill the place holders in the message template. These strings contain information that is unique to the user's scenario. |
Extended Error Codes
The following tables list the extended error codes.
Generic - 01xxx
Extended error code |
Error type |
Error message or error message template |
---|---|---|
01001 |
AccessDenied |
Access is denied. |
01002 |
CommandResourceNotPresent |
Command resource object is not present in the request body. |
01003 |
InvalidName |
Invalid name {0}. |
01004 |
UnknownCommandVerb |
Cannot understand command verb {0}. |
01005 |
IsInReadOnlyMode |
The service is currently in read only mode. |
01006 |
ParameterIsNotSpecified |
The {0} parameter is not specified. |
01007 |
InvalidParameterValue |
Parameter {0} has invalid value. |
01008 |
InvalidRequest |
{0} object is not present in the request body. |
01009 |
IncorrectDateTimeRange |
The from value in the query string is bigger than or equal to the to value. |
01010 |
RequiredParameterMissing |
Required parameter {0} is missing. |
01011 |
ResourceNameCannotChange |
Name of the web quota cannot change. |
01012 |
FailedToConvertParameterValue |
The value of the query string parameter cannot be converted to Boolean. |
01013 |
ParameterNameAlreadyExists |
Parameter with name {0} already exists in the request. |
01014 |
ParameterNameIsEmpty |
Parameter name cannot be empty. |
01015 |
NotReady |
Not ready |
01016 |
Ready |
Ready |
01017 |
UpdateForFieldNotAllowed |
Update is not allowed for the {0} field. |
01018 |
NotSupportedCommand |
Web Service does not support Command {0}. Only supported command(s) is {1}. |
01019 |
InvalidData |
Invalid data ({0}). |
01020 |
GenericConflict |
There was a conflict. {0} |
01021 |
InternalServerError |
Internal server error occurred. {0} |
Webspace - 03xxx
Extended error code |
Error type |
Error message or error message template |
---|---|---|
03001 |
NumberOfSitesLimit |
Number of sites exceeds the maximum allowed. |
03002 |
NumberOfWorkersLimit |
NumberOfWorkers exceeds the maximum allowed. |
03003 |
NoStorageVolumeAvailable |
There is not enough space on the disk. |
03004 |
WebSpaceAlreadyExists |
WebSpace with name {0} already exists for subscription {1}. |
03005 |
WebSpaceNotFound |
Cannot find webspace {0} for subscription {1} |
03006 |
WebSpaceContainsResources |
Web space contains resources. |
03007 |
FileStorageLimit |
The file storage capacity exceeds the limit. |
03008 |
WebSpaceDeleteError |
Failed to delete web space {0}: {1} |
03009 |
NoWorkersAvailable |
Not enough available Standard Instance servers to satisfy this request. |
03010 |
WebSpaceCreateError |
Failed to create web space {0} on storage volume {1}: {2} |
Site - 04xxx
Extended error code |
Error type |
Error message or error message template |
---|---|---|
04001 |
DirectoryAlreadyExists |
Directory already exists for site {0}. |
04002 |
DirectoryDeleteError |
Failed to delete directory {0}. |
04003 |
InvalidHostName |
Invalid host name {0}. |
04004 |
InvalidNumberOfWorkers |
NumberOfWorkers value must be more than zero. |
04005 |
HostNameAlreadyExists |
Hostname '{0}' already exists. |
04006 |
InvalidCustomHostNameValidation |
No CNAME pointing from {0} to a site in a default DNS zone (or too many). |
04007 |
InvalidCustomHostNameValidationNoBaseHostName |
There are no hostnames which could be used for validation. |
04008 |
SiteAlreadyExists |
Site with name {0} already exists. |
04009 |
SiteNotFound |
Cannot find site {0}. |
04010 |
InvalidExternalUriHeader |
The external URL \{0}\ specified on request header \{1}\ is invalid. |
04011 |
FileDeleteError |
Failed to delete file {0}. |
04012 |
NumberOfWorkersPerSiteLimit |
Number of workers for this site exceeds the maximum allowed. |
04013 |
TraceWebSiteStorageVolume |
WebSiteManager.CreateWebSite: Creating Site using storageVolume {0}. |
Repository - 05xxx
Extended error code |
Error type |
Error message or error message template |
---|---|---|
05001 |
RepositoryDeleteError |
Cannot delete repository with name {0}. |
05002 |
RepositoryDevSiteAlreadyExists |
Development site already exists in the repository for site {0}. |
05003 |
RepositoryDevSiteNotExist |
Development site does not exist in the repository for site {0}. |
05004 |
RepositorySiteAlreadyExists |
Site {0} already has repository created for it. |
05005 |
RepositorySiteNotExist |
Repository does not exist for site {0}. |
05006 |
TraceFailedToCreateDevSite |
Failed to create a development site. |
Publishing - 06xxx
Extended error code |
Error type |
Error message or error message template |
---|---|---|
06001 |
AuthenticatedFailed |
User {0} has been rejected. |
06002 |
AuthenticatedPassed |
User {0} has been successfully authenticated. |
06003 |
AuthorizationFailed |
User {0} has been rejected. |
06004 |
AuthorizationPassed |
User {0} has been authorized. |
06005 |
PublishingCredentialsNotTrimmed |
Publishing credentials have to be trimmed from white characters. |
06006 |
PublishingPasswordIsEmpty |
Publishing password cannot be empty. |
06007 |
PublishingPasswordNotSpecified |
Publishing password must be specified. |
06008 |
PublishingUserNameAlreadyExists |
Publishing username {0} is already used. Specify a different publishing username. |
06009 |
PublishingUserNameIsEmpty |
Publishing user name cannot be empty. |
GeoMaster Error Codes
GeoMaster - Generic - 51xxx
Extended error code |
Error type |
Error message or error message template |
---|---|---|
51001 |
ErrorAdding |
An error occurred when adding the {0} entry: {1} |
51002 |
ErrorDeleting |
An error occurred when deleting the {0} entry: {1} |
51003 |
ErrorUpdating |
An error occurred when updating the {0} entry: {1} |
51004 |
CannotFindEntity |
Cannot find {0} with name {1}. |
GeoMaster - Subscription - 52xxx
Extended Error Code |
Error Type |
Error Message or Error Message Template |
---|---|---|
52001 |
SubscriptionConflict |
Subscription with specified name already exists. |
52002 |
SubscriptionNonEmpty |
Subscripton Name cannot be null or empty. |
52003 |
SubscriptionNotFound |
Subscription {0} not found. |
52004 |
SubscriptionSuspended |
Subscription {0} is Suspended. |
52005 |
NonEmptySubscription |
Subscription contains WebSpaces. |
GeoMaster - Webspace - 53xxx
Extended error code |
Error type |
Error message or error message template |
---|---|---|
53001 |
WebSpaceConflict |
WebSpace with specified name already exists. |
53002 |
WebSpaceNonEmpty |
WebSpace Name cannot be null or empty. |
53003 |
NonEmptyWebSpace |
WebSpace contains web sites. |
53004 |
ErrorPickingStamp |
An Error occurred when picking Stamp for WebSpace {0}. |
GeoMaster - Site - 54xxx
Extended error code |
Error type |
Error message or error message template |
---|---|---|
54001 |
WebSiteConflict |
Web site with given name {0} already exists in the specified Subscription and Webspace. |
54002 |
WebSiteNonEmpty |
WebSiteName cannot be null or empty. |
54003 |
HostNameConflict |
Specified Host Name {0} is already taken by another site. |