API共通のレスポンスヘッダー
Response Headers
Content-Length
ヘッダーを除いたリクエスト長(Byte)
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Content-Type
コンテントタイプ
- application/json：レスポンスボディがJSON形式の場合
Date
レスポンスの日時
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
X-Message
ステータスの補足情報
- Success: 成功しました
- No services to return: 配信設定なし(空のリスト)
- No Content: 返せる内容がありません
- Accepted: 要求は受け付けられました
- Bad Request: 要求が正しくありません
- Invalid entry for xxx: xxxの値が正しくありません
- Invalid Json: Jsonフォーマットが正しくありません
- Quota exceeded: 作成可能な上限を超えています
- Service is in progress: 他の処理が進行中です
- Service is undeployed: 配信設定が無効状態です
- Parameter required: パラメーターが必要です
- Rate limit exceeded: 要求が多すぎるため、しばらく経ってから実行してください
- Internal Server Error: 内部エラーです
- Service Unavailable: 一時的に利用できません
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
X-Error
エラー時の詳細情報
- Invalid JSON input / <エラー内容>
JSON形式のデータに誤りがあります。詳細は<エラー内容>を参照してください
- Internal Server Error(数字3桁)
その他の内部エラーです。数字3桁部分は、問合せに使用する場合があります。
- Service Unavailable (数字3桁)
その他の一時的なエラーです。数字3桁部分は、問合せに使用する場合があります。
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
X-Error-Instance-ID
エラーが発生したコマンドの情報。問合せに使用する場合があります
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
X-Status
ステータス情報
配信設定の場合：
- create_in_progress – 作成処理中
- deployed – 配信完了し、利用可能
- undeployed – 配信停止中
- update_in_progress – 更新処理中
- delete_in_progress – 削除処理中
- failed – 処理が失敗しました。X-Errorを参照ください
レポートの場合：
- create_in_progress – 作成処理中
- deployed – レポート作成完了し、利用可能
- failed – 処理が失敗しました。X-Errorを参照ください
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
X-Access-Log-Status
ステータス情報
- deployed – 配信完了し、利用可能
- undeployed – 配信停止中
- failed – 処理が失敗しました。X-Access-Log-Status-Detailedを参照して下さい。
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
X-Access-URL
配信FQDN。独自ドメインまたは付与ドメイン
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
X-Protocol
配信プロトコルスキーム。httpまたはhttps
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Location
service_id, report_idを含むURL
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
X-Access-Log-Container
アクセスログの格納先を示すオブジェクトストレージのコンテナ
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
X-Access-Log-Object-Prefix
アクセスログのオブジェクト名のプレフィックス
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
X-Access-Log-Key-Container
アクセスログの暗号化に使用するための公開鍵が格納された、オブジェクトストレージのコンテナ
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
X-Access-Log-Key-Object
アクセスログの暗号化に使用するための公開鍵のオブジェクト名
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
X-Access-Log-Detailed-Status
アクセスログでエラーがあった場合の補足情報
- Access error to the container. – コンテナへのアクセス異常
- Access error to the public key. – 公開鍵格納コンテナおよび公開鍵オブジェクトへのアクセス異常
- Illegal public key. – 公開鍵オブジェクトが不正
- Internal server error. – 内部エラー発生
| Data Type | Cardinality |
|---|---|
| String | 1..1 |