API共通のエラー情報
■認証エラーの場合
HTTP ステータス
ステータス
リクエストのステータスを返却する。
- 401：
- 認証エラー
| Data Type | Cardinality |
|---|---|
| Int | 1..1 |
Response Elements
なし
Example of Response
HTTP/1.1 401 Unauthorized
Date: Fri, 06 Jun 2014 11:00:38 GMT
■アクセス拒否の場合
HTTP ステータス
ステータス
リクエストのステータスを返却する。
- 403:
- アクセス拒否
| Data Type | Cardinality |
|---|---|
| Int | 1..1 |
Response Elements
AccessDeniedException
エラーレスポンスのエンベロープ。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | None | Message |
Message
エラーメッセージ。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| 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>
■認証エラー／アクセス拒否以外
HTTP ステータス
ステータス
リクエストのステータスを返却する。
以下のうちのどれか。
- 400:
- リクエストのXML形式が正しくない
- 500:
- サーバー内部エラー
- 5xx:
- AZダウンした際のエラー
利用者から送ったクエリがAZダウンのタイミングにより異なり、様々な挙動となります。
その為、HTTP ステータスコードは（5xx）を返却することで、利用者にリトライを促します。
| Data Type | Cardinality |
|---|---|
| Int | 1..1 |
Response Elements
ErrorResponse
エラーレスポンスのエンベロープ。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | None | Error
RequestId |
Error
エラー情報のエンベロープ。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | ErrorResponse | Type
Code Message |
Type
SenderまたはReceiver。
エラー原因が送信側か受信側にあるかを示します。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 1..1 | Error | None |
Code
エラーコード。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 1..1 | Error | None |
Message
エラーメッセージ(英語)。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 1..1 | Error | None |
RequestId
リクエストを一意に識別するID。
問題が発生した場合の問い合わせの際にトラブルシューティングを行うために必要となります。
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| 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>