Retrieve a report#

report_idで指定するレポート(統計情報)を取得します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://cdn.gls.cloud.global.fujitsu.com
東日本リージョン3の場合 https://cdn.gls.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v1/reports/{report_id}

レポートが作成完了している場合はJSON形式でレポートを取得することができます。レポート作成処理中の場合は204 No Contentが返され、X-Statusレスポンスヘッダーがcreate_in_progressとなりますので、しばらくしてから再実行してください。

要求に対してエラーが生じている場合は、X-Statusレスポンスヘッダーがfailedなので、X-Errorのレスポンスヘッダーも参照してください。

レポートを作成の結果、内容が0件の場合、X-Statusレスポンスヘッダーがdeployed、ステータスコードは204です。

HTTPステータスコード#

正常時：200, 204

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定		 Description
X-Auth-Token header string 必須 ユーザー認証を行った際に取得するトークン
Content-Type header string 任意 リクエストボディで指定する情報がJSON形式の場合にはapplication/jsonを指定
report_id path string 必須 取得するレポートのreport_id

レスポンスボディ（正常系）の説明#

名前 Type Description
Content-Length string ヘッダーを除いたリクエスト長(Byte)
Content-Type string コンテントタイプ
- application/json：レスポンスボディがJSON形式の場合
Date string レスポンスの日時
X-Message string ステータスの補足情報
- 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: 一時的に利用できません
X-Error string エラー時の詳細情報
- Invalid JSON input / <エラー内容>
JSON形式のデータに誤りがあります。詳細は<エラー内容>を参照してください。
- Internal Server Error(数字3桁)
その他の内部エラーです。数字3桁部分は、問合せに使用する場合があります。
- Service Unavailable (数字3桁)
その他の一時的なエラーです。数字3桁部分は、問合せに使用する場合があります。
X-Error-Instance-ID string エラーが発生したコマンドの情報
問合せに使用する場合があります。
X-Status string ステータス情報
配信設定の場合：
- create_in_progress - 作成処理中
- deployed - 配信完了し、利用可能
- undeployed - 配信停止中
- update_in_progress - 更新処理中
- delete_in_progress - 削除処理中
- failed - 処理が失敗しました。X-Errorを参照してください。
レポートの場合：
- create_in_progress - 作成処理中
- deployed - レポート作成完了し、利用可能
- failed - 処理が失敗しました。X-Errorを参照してください。
X-Access-Log-Status string ステータス情報
- deployed - 配信完了し、利用可能
- undeployed - 配信停止中
- failed - 処理が失敗しました。X-Access-Log-Status-Detailedを参照してください。
X-Access-URL string 配信FQDN
独自ドメインまたは付与ドメインです。
X-Protocol string 配信プロトコルスキーム
httpまたはhttpsです。
Location string service_id, report_idを含むURL
X-Access-Log-Container string アクセスログの格納先を示すオブジェクトストレージのコンテナ
X-Access-Log-Object-Prefix string アクセスログのオブジェクト名のプレフィックス
X-Access-Log-Key-Container string アクセスログの暗号化に使用するための公開鍵が格納された、オブジェクトストレージのコンテナ
X-Access-Log-Key-Object string アクセスログの暗号化に使用するための公開鍵のオブジェクト名
X-Access-Log-Detailed-Status string アクセスログでエラーがあった場合の補足情報
- Access error to the container. - コンテナへのアクセス異常
- Access error to the public key. - 公開鍵格納コンテナおよび公開鍵オブジェクトへのアクセス異常
- Illegal public key. - 公開鍵オブジェクトが不正
- Internal server error. - 内部エラー発生
headers string rowsが示すレポートデータの説明情報
index string レポートデータの列番号を示すインデックス(0始まり)
name string レポートデータの各列の説明
rows string 全レポートデータの配列表現
(array) string あるTimeで示す時点とそのレポートデータを表す1行
metadata string レポートの作成時に指定したパラメーター
granularity string レポートの作成時に指定したパラメーター
start_date string レポートの作成時に指定したパラメーター
end_date string レポートの作成時に指定したパラメーター
delivery_option string レポートの作成時に指定したパラメーター
metrics string レポートの作成時に指定したパラメーター
time_created string レポートを作成した日時
service_id string 配信設定を表すservice_id
per_region string 地域毎の出力

レスポンス例#

正常取得の場合 

   GET /v1/ reports/bdf5d40b-9fc4-47d4-b569-59edf3d1f91d
       
   HTTP/1.1 200 OK
   X-Message: Success
   X-Status: deployed
   Content-Type: application/json
   Content-Length: 563
   {
         "headers": [
           {
             "index": 0,
             "name": "Time"
           },
           {
             "index": 1,
             "name": "Region"
           },
           {
             "index": 2,
             "name": "200Count"
           },
           {
             "index": 3,
             "name": "RequestCount"
           }
         ],
         "metadata": {
           "delivery_option": "all",
           "end_date": "20160814",
           "granularity": "daily",
           "metrics": [
             "200Count",
             "RequestCount"
           ],
           "per_region": "true",
           "service_id": "65a455b0-475a-42fd-b98e-75b396032bff",
           "start_date": "20160812",
           "time_created": "2016/08/23 06:22"
         },
         "rows": [
           [
             "2016/08/12 00:00",
             "North America",
             "2",
             "2"
           ],
           [
             "2016/08/12 00:00",
             "Japan",
             "1",
             "1"
           ],
           [
             "2016/08/13 00:00",
             "North America",
             "1",
             "1"
           ]
         ]
   }

レポートが0件の場合 

   GET /v1/cdn/reports/419be4be-a30b-4af8-97db-900260ae6ad3
       
   HTTP/1.1 204 No Content
   X-Message: No Content
   X-Status: deployed