Common API error codes
- Authentication error
HTTP status
Status
The following error codes can be returned for the request.
- 401:
- Authentication error
| Data type | Cardinality |
|---|---|
| Int | 1..1 |
Response elements
n/a
Example of response
HTTP/1.1 401 Unauthorized
Date: Fri, 06 Jun 2014 11:00:38 GMT
- Access denied
HTTP status
Status
The following error codes can be returned for the request.
- 403:
- Access denied
| Data type | Cardinality |
|---|---|
| Int | 1..1 |
Response elements
AccessDeniedException
Envelope of error response.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| - | 1..1 | None | Message |
Message
Error message.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | AccessDeniedException | None |
Example of response
HTTP/1.1 403 Forbidden
Date: Fri, 06 Jun 2014 11:00:38 GMT
Content-Length: . . .
Content-Type: application/xml
x-fj-request-id: d96bd874-9bf2-11e1-8ee7-c98a0037a2b6
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AccessDeniedException>
<Message>Access Denied</Message>
</AccessDeniedException>
- Errors other than authentication error/access denied
HTTP status
Status
The following error codes can be returned for the request.
One of the following values will be returned:
- 400:
- XML format of request is incorrect
- 500:
- Internal server error
- 5xx:
- Error when an availability zone has been downed
The query sent by the user varies depending on when the availability zone goes down, resulting in various behaviors.
Therefore, (5xx) returned by the HTTP status code prompts the user to retry.
| Data type | Cardinality |
|---|---|
| Int | 1..1 |
Response elements
ErrorResponse
Envelope of error response.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| - | 1..1 | None | Error RequestId |
Error
Envelope of error information.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| - | 1..1 | ErrorResponse | Type Code Message |
Type
Sender or Receiver.
Indicates whether the error was caused by the sender or the receiver.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | Error | None |
Code
Error code.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | Error | None |
Message
Error message (English).
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | Error | None |
RequestId
ID that uniquely identifies the request.
This is required when contacting support staff to troubleshoot an issue.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| xsd:string | 1..1 | ErrorResponse | None |
Example of response
HTTP/1.1 400 Bad Request
Date: Fri, 06 Jun 2014 11:00:38 GMT
Content-Length: . . .
Content-Type: application/xml
x-fj-request-id: 2844de70-360d-488d-bd63-0cd88fd94be1
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
< ErrorResponse xmlns="http://docs.cloudcommunity.global.fujitsu.com/dns/api/v1.0/">
<Error>
<Type>Sender</Type>
<Code>InvalidInput</Code>
<Message>The specified Action is not valid</Message>
</Error>
<RequestId>2844de70-360d-488d-bd63-0cd88fd94be1</RequestId>
</ErrorResponse>