レポートの作成(POST /v1/reports)

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

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

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

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

主なステータスコードとX-Message ヘッダーの値を示します。

ステータスコード X-Message 202 Accepted:要求は受け付けられました 400 Invalid entry for granularity/start_date/end_date/delivery_option/metrics/service_id:値が正しくありません 400 Invalid entry for service_id/per_region combination:指定できない組み合わせです 429 Rate limit exceeded:要求が多すぎるため、しばらく経ってから実行してください

Request Headers

を参照。

Request Parameter

granularity

情報の粒度

  • daily:1日刻みのレポートを作成
  • hourly:1時間刻み(hh:00～hh:59)のレポートを作成

Data Type Cardinality String 1..1

start_date

開始日(UTC)。最長で過去60日以内の範囲で指定できます。

例) 20151201

Data Type Cardinality String 1..1

end_date

終了日(UTC)。省略時は今日が指定されます。

start_dateよりも前の日付は指定できません。

granularityがdailyの場合、start_dateから31日以内を指定する必要があります(stard_dateが1/1の場合、2/1までを指定すると、31ヶのデータが返ります)。

granularityがhourlyの場合、start_dateから14日以内を指定する必要があります。

Data Type Cardinality String 0..1

delivery_option

どのプロトコルスキームで集約するかの設定

  • http:HTTPアクセスに限定
  • ssl:HTTPSアクセスに限定
  • all:合算(default)

Data Type Cardinality String 0..1

metrics

レポートで出力したいメトリクスのカンマ区切り表現

  • 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: エッジサーバによりオリジンサーバのオフロードが行えた割合。キャッシュヒット率。

Data Type Cardinality String 1..1

per_region

地域毎に出力するかの設定

  • true:地域毎に出力

    granularityをdailyに指定する必要があります。

    metricsのIngressBytes,IngressCount,IngressRequestBytes, OffloadHitRatioとの組み合わせは指定できません。

  • false:合算(default)

Data Type Cardinality String 0..1

service_id

配信設定を表すservice_id。省略時は全体での取得となります。

granularityをdailyに指定する必要があります。

metricsのIngressBytes,IngressCount,IngressRequestBytes, OffloadHitRatioとの組み合わせは指定できません。

Data Type Cardinality String 0..1

Request Elements

特にありません。

Response Headers

を参照。

Location

report_idを含むURL

Data Type Cardinality String 1..1

Response Elements

特にありません。

Example of Response

【成功時】 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