インターネット・Origin AS番号レポート(レポート > インターネット > 詳細レポート > Origin AS番号)のレポートデータを取得するAPIです。
ディレクトリパス
/api/report/internet/originasn
requestクエリパラメータの要素
キー | 必須 | 値 | 説明 | ||
---|---|---|---|---|---|
“report_datetime” | Y | {“defined_by”キー値ペア, “end_time”キー値ペア} または {“start_time”キー値ペア, “end_time”キー値ペア} |
期間 | ||
“defined_by” | “daily” “weekly” “monthly” “quarterly” “yearly” |
“end_time”キー値ペアと合わせて期間を指定 “start_time”キー値ペアを指定しない場合は必須 |
|||
“start_time” | YYYY-MM-DD hh:mmフォーマットの開始時刻 | “end_time”キー値ペアと合わせて期間を指定 “defined_by”キー値ペアを指定しない場合は必須 |
|||
“end_time” | Y | YYYY-MM-DD hh:mmフォーマットの終了時刻 | “defined_by”キー値ペアまたは”start_time”キー値ペアと合わせて期間を指定 | ||
“unit” | Y | “bps” “pps” |
計測単位を指定 | ||
“protocol” | Y | “ipv4” “ipv6” “both” |
IPバージョン | ||
“data_format” | Y | “graph_data” | |||
“display_data” | “yes” | レポートデータ付きのレスポンスを受け取る場合に”yes”を指定します。 |
応答メッセージのオブジェクト要素
キー | 値 | 説明 | |||
---|---|---|---|---|---|
“response” | {“status”キー値ペア, “result”キー値ペア} | クエリの応答本体 | |||
“status” | “succ” “fail” |
クエリの成功失敗 | |||
“result” | {“output_file”キー値ペア} または {“output_file”キー値ペア, “data”キー値ペア} |
クエリ成功時の結果データ | |||
“output_file” | ファイルロケーション | 結果データファイルのロケーション | |||
“data” | {“report”キー値ペア, “unit”キー値ペア, “aggregation_unit”キー値ペア, “datetime_start”キー値ペア, “datetime_end”キー値ペア, “ip version”キー値ペア, “data”キー値ペア} | 結果データ本体(クエリで”display_data”: “yes”が指定されたときのみ) | |||
“err” | {“msg”キー値ペア, “code”キー値ペア, “description”キー値ペア} | クエリ失敗時の理由 |
説明
- 指定IPバージョンまたはすべてのインターネットトラフィックについて,指定計測単位のOrigin AS番号レポートデータを取得します。
- レスポンスメッセージにレポートデータを含める場合は“report_data”:”yes”を指定します。指定しない場合,応答で指定されたファイルをダウンロードしてデータを取得します。
注意事項
- レポートデータの粒度は,指定した取得期間によって以下のように自動的に決まります。
取得期間 集計データの粒度 取得期間 ≤ 24時間 5分 24時間 < 取得期間 ≤ 7日 30分 7日 < 取得期間 ≤ 3か月 2時間 3か月 < 取得期間 1日
実行例
- リクエスト
http://api-user:api-passwd@172.16.2.90/api/report/internet/originasn?request={"report_datetime":{"defined_by":"weekly","end_time":"2016-12-12 00:00"},"unit":"bps","protocol":"both","data_format":"graph_data","display_data":"yes"}
- レスポンス
{ "response": { "status": "succ", "result": { "output_file": "/pdftmp/rpt_export_data_1482389300-d90958e7-be8c-4699-8b8e-56b3f7177936.json", "data": { "report": "Internet>Breakdown>Origin ASN", "unit": "bps", "aggregation_unit": "30 min", "datetime_start": "2016-12-05T00:00:00Z", "datetime_end": "2016-12-12T00:00:00Z", "ip version": "Both", "data": { "items": { "item1": [ "Internet Sum" ], "item2": [ "AMAZON-02" ], "item3": [ "APPLE-ENGINEERING" ], "item4": [ "FACEBOOK" ], "item5": [ "MICROSOFT-CORP-MSN-AS-BLOCK" ], "item6": [ "YAHOO-3" ] }, "value": { "2016-12-05T00:00:00Z": { "item1": [ 3815844352, 1618906368 ], "item2": [ 644851328, 191949824 ], "item3": [ 529735552, 117155224 ], : : (途中省略) : : "item2": [ 151641152, 40243728 ], "item3": [ 143755712, 53387400 ], "item4": [ 187509600, 4781182 ], "item5": [ 53549448, 20225218 ], "item6": [ 17160072, 1609265.62 ] } } } } } } }