Create a report#

レポート(統計情報)の作成を要求します。

APIエンドポイント#

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

HTTPメソッドとURI#

POST

/v1/reports{?granularity, start_date, end_date, delivery_option,metrics, per_region, service_id}

APIが正しく処理された場合、Locationレスポンスヘッダーから、レポートを識別するreport_idを得ることができます。詳細な情報はレポートの取得APIにreport_idを指定することで得ることができます。通常数分程度を要します。

report_idはレポート作成完了後1時間で、自動的に削除されます。

通常利用を超える数のレポートを作成しようとすると、ステータスコード429を返す場合があります。

HTTPステータスコード#

正常時:202

エラー時:400, 429

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

名前 In Type デフォルト値
/必須指定
Description
X-Auth-Token header string 必須 ユーザー認証を行った際に取得するトークン
Content-Type header string 任意 リクエストボディで指定する情報がJSON形式の場合にはapplication/jsonを指定
granularity query string 必須 情報の粒度
- daily:1日刻みのレポートを作成
- hourly:1時間刻み(hh:00~hh:59)のレポートを作成
start_date query string 必須 開始日(UTC)
最長で過去60日以内の範囲で指定できます。
例) 20151201
end_date query string 任意 終了日(UTC)
省略時は今日が指定されます。start_dateよりも前の日付は指定できません。
- granularityがdailyの場合、start_dateから31日以内を指定する必要があります。
stard_dateが1/1の場合、2/1までを指定すると、31ヶのデータが返ります。
- granularityがhourlyの場合、start_dateから14日以内を指定する必要があります。
delivery_option query string 任意 どのプロトコルスキームで集約するかの設定
- http:HTTPアクセスに限定
- ssl:HTTPSアクセスに限定
- all:合算(default)
metrics query string 必須 レポートで出力したいメトリクスのカンマ区切り表現
- IncompleteDownloadCount:ダウンロードが完了しなかった回数
- 200Count: Status Code 200を応答した回数
- 206Count: Status Code 206を応答した回数
- 2XXCount: Status Code 2XXを応答した回数とダウンロード完了しなかった回数の合算
- 302Count: Status Code 302を応答した回数
- 304Count: Status Code 304を応答した回数
- 3XXCount: Status Code 3XXを応答した回数の合算
- 404Count: Status Code 404を応答した回数
- 4XXCount: Status Code 4XXを応答した回数の合算
- 5XXCount: Status Code 5XXを応答した回数の合算
- RequestCount: エンドユーザーからエッジサーバにリクエストした回数の合算
- TotalBytes: エッジサーバからエンドユーザーへのデータ転送量[MegaByte]
- IngressBytes: オリジンサーバからエッジサーバへのデータ転送量[Byte]
- IngressCount: エッジサーバがオリジンサーバへリクエストした回数
- IngressRequestBytes: エッジサーバからオリジンサーバへのデータ転送量[Byte]
- OffloadHitRatio: エッジサーバによりオリジンサーバのオフロードが行えた割合。キャッシュヒット率。
per_region query string 任意 地域毎に出力するかの設定
- true:地域毎に出力
granularityをdailyに指定する必要があります。
metricsのIngressBytes,IngressCount,IngressRequestBytes, OffloadHitRatioとの組み合わせは指定できません。
- false:合算(default)
service_id query string 任意 配信設定を表すservice_id
省略時は全体での取得です。granularityをdailyに指定する必要があります。
metricsのIngressBytes,IngressCount,IngressRequestBytes, OffloadHitRatioとの組み合わせは指定できません。

レスポンスボディ(正常系)の説明#

名前 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. - 内部エラー発生

レスポンス例#

成功時

   POST /v1/ reports?granularity=daily&start_date=20160812&end_date=20160814&delivery_option=all&metrics= 200Count,RequestCount&service_id=65a455b0-475a-42fd-b98e-75b396032bff&per_region=true
       
   HTTP/1.1 202 Accepted
   X-Message: Accepted
   Location: http://<Endpoint>/v1/reports/96b6c7a9-1f75-4b37-88de-9a6626a13f1c
   Content-Length: 0

Rate Limit時

   POST (略)
         
   HTTP/1.1 429
   X-Message: Rate limit exceeded
   Content-Length: 0