Edge統計の照会
- 印刷する
- PDF
Edge統計の照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
概要
Edge使用量の統計を照会します。
リクエスト
リクエスト URL
GET
https://edge.apigw.ntruss.com/api/v1/statistics/{profileId}/{edgeId}
リクエストパラメータ
パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
profileId | Yes | String | Profile番号 | |
edgeId | Yes | Integer | Edge番号 | |
dateFrom | Yes | String | ISO日付フォーマット yyyy-MM-dd'T'HH:mm:ss Min: 730日前 | 照会開始日 (UTC) |
dateTo | Yes | String | ISO日付フォーマット yyyy-MM-dd'T'HH:mm:ss Max: 現在時刻 | 照会終了日 (UTC) |
レスポンス
すべてのレスポンスは、HTTP Status Codeで成功または失敗を返します。
HTTPステータスコード | コードのメッセージ | 説明 |
---|---|---|
200 | Success | 照会成功 |
401 | Unauthorized | 認証失敗 |
500 | Internal Server Error | サーバエラー |
StatisticsSummary
項目 | タイプ | 説明 |
---|---|---|
dateFrom | ZonedDateTime | 統計照会の開始時間(UTC) |
dateTo | ZonedDateTime | 統計照会の終了時間(UTC) |
interval | Long | 統計データの間隔(秒) |
hitsTotal | HitsTotal | 全体 Request関連統計の要約 |
hitsTotal.offload.value | Double | 全体オフロードの平均 |
hitsTotal.offload.min | Double | 全体統計のうちオフロード最低値 |
hitsTotal.offload.max | Double | 全体統計のうちオフロード最大値 |
hitsTotal.edgeHits.value | Long | 全体 Edge Hit総計 |
hitsTotal.edgeHits.min | Long | 全体統計のうち Edge Hit最低値 |
hitsTotal.edgeHits.max | Long | 全体統計のうち Edge Hit最大値 |
hitsTotal.originShieldHits.value | Long | 全体 Origin Shield Hit総計 |
hitsTotal.originShieldHits.min | Long | 全体統計のうち Origin Shield Hit最低値 |
hitsTotal.originShieldHits.max | Long | 全体統計のうち Origin Shield Hit最大値 |
hitsTotal.originHits.value | Long | 全体 Origin Hit総計 |
hitsTotal.originHits.min | Long | 全体統計のうち Origin Hit最低値 |
hitsTotal.originHits.max | Long | 全体統計のうち Origin Hit最大値 |
hitsTotal.errorHits.value | Long | 全体 Error Hit総計 |
hitsTotal.errorHits.min | Long | 全体統計のうち Error Hit最低値 |
hitsTotal.errorHits.max | Long | 全体統計のうち Error Hit最大値 |
bytesTotal.offload.value | Double | 全体オフロードトラフィック総計 |
bytesTotal.offload.min | Double | 全体統計のうちオフロードトラフィック最低値 |
bytesTotal.offload.max | Double | 全体統計のうちオフロードトラフィック最大値 |
bytesTotal.edgeBytes.value | Long | 全体 Edgeトラフィック(Byte)総計 |
bytesTotal.edgeBytes.min | Long | 全体統計のうち Edgeトラフィック(Byte)最低値 |
bytesTotal.edgeBytes.max | Long | 全体統計のうち Edgeトラフィック(Byte)最大値 |
bytesTotal | BytesTotal | 全体トラフィック(Byte)関連統計の要約 |
bytesTotal.originShieldBytes.value | Long | 全体 Origin Shieldトラフィック(Byte)総計 |
bytesTotal.originShieldBytes.min | Long | 全体統計のうち Origin Shieldトラフィック(Byte)最低値 |
bytesTotal.originShieldBytes.max | Long | 全体統計のうち Origin Shieldトラフィック(Byte)最大値 |
bytesTotal.originBytes.value | Long | 全体 Originトラフィック(Byte)総計 |
bytesTotal.originBytes.min | Long | 全体統計のうち Originトラフィック(Byte)最低値 |
bytesTotal.originBytes.max | Long | 全体統計のうち Originトラフィック(Byte)最大値 |
bytesTotal.errorHits.value | Long | 全体 Error Hit総計 |
bytesTotal.errorHits.min | Long | 全体統計のうち Error Hit最低値 |
bytesTotal.errorHits.max | Long | 全体統計のうち Error Hit最大値 |
responseSegments | List<ResponseSegment> | HTTPレスポンスコード別統計データ |
responseSegments[].responseCode | String 2xx / 3xx / 4xx / 5xx | HTTPレスポンスコード |
responseSegments[].edgeHits | Long | Edgeレスポンスコード発生総計 |
responseSegments[].originHits | Long | Originレスポンスコード発生総計 |
trafficSegments | List<TrafficSegments> | Edge別統計データ |
trafficSegments[].edgeId | Long | Edge番号 |
trafficSegments[].edgeName | String | Edge名 |
trafficSegments[].offloadHits | Double | Edge Hitのオフロード平均 |
trafficSegments[].edgeHits | Long | インスタンスの Edge Hit発生総計 |
trafficSegments[].originHits | Long | インスタンスの Origin Hit発生総計 |
trafficSegments[].offloadBytes | Double | Edgeトラフィック(Byte)のオフロード平均 |
trafficSegments[].edgeBytes | Long | インスタンスの Edgeトラフィック(Byte)発生総計 |
trafficSegments[].originShieldBytes | Long | インスタンスの Origin Shieldトラフィック(Byte)発生総計 |
trafficSegments[].originBytes | Long | インスタンスの Originトラフィック(Byte)発生総計 |
statistics | List<ChartValue> | Timestamp基準で総合された統計 |
statistics[].time | ZonedDateTime | 統計収集時間帯(UTC) |
statistics[].offloadHits | Double | 当該時間帯のオフロード平均 |
statistics[].edgeHits | Long | 当該時間帯の Edge Hit発生総計 |
statistics[].originShieldHits | Long | 当該時間帯の Origin Shield Hit発生総計 |
statistics[].originHits | Long | 当該時間帯の Origin Hit発生総計 |
statistics[].edgeSuccessCount | Long | 当該時間帯の Edge 2xxレスポンス発生総計 |
statistics[].edgeRedirectionCount | Long | 当該時間帯の Edge 3xxレスポンス発生総計 |
statistics[].edgeClientErrorCount | Long | 当該時間帯の Edge 4xxレスポンス発生総計 |
statistics[].edgeServerErrorCount | Long | 当該時間帯の Edge 5xxレスポンス発生総計 |
statistics[].originSuccessCount | Long | 当該時間帯の Origin 2xxレスポンス発生総計 |
statistics[].originRedirectionCount | Long | 当該時間帯の Origin 3xxレスポンス発生総計 |
statistics[].originClientErrorCount | Long | 当該時間帯の Origin 4xxレスポンス発生総計 |
statistics[].originServerErrorCount | Long | 当該時間帯の Origin 5xxレスポンス発生総計 |
statistics[].offloadBytes | Double | 当該時間帯のトラフィック(Byte)オフロード平均 |
statistics[].edgeBps | Double | 当該時間帯の Edgeトラフィック(Byte)発生総計 |
statistics[].originShieldBps | Double | 当該時間帯の Origin Shieldトラフィック(Byte)発生総計 |
statistics[].originBps | Double | 当該時間帯の Originトラフィック(Byte)発生総計 |
例
リクエスト例
https://edge.apigw.ntruss.com/api/v1/statistics/123/456?dateFrom=2022-11-14T09:25:12.340Z&dateTo=2022-11-16T09:25:12.340Z
レスポンス例
{
"code":"0000",
"message":"Success",
"result":{
"dateFrom":"2022-11-14T00:00:00Z",
"dateTo":"2022-11-16T09:25:16.137098912Z",
"interval":3600,
"hitsTotal":{
"offload":{
"value":0.0,
"min":0.0,
"max":0.0
},
"edgeHits":{
"value":0,
"min":0,
"max":0
},
"originShieldHits":{
"value":0,
"min":0,
"max":0
},
"originHits":{
"value":0,
"min":0,
"max":0
},
"errorHits":{
"value":0,
"min":0,
"max":0
}
},
"bytesTotal":{
"offload":{
"value":0.0,
"min":0.0,
"max":0.0
},
"edgeBytes":{
"value":0,
"min":0,
"max":0
},
"originShieldBytes":{
"value":0,
"min":0,
"max":0
},
"originBytes":{
"value":0,
"min":0,
"max":0
},
"errorHits":{
"value":0,
"min":0,
"max":0
}
},
"responseSegments":[
{
"responseCode":"2xx",
"edgeHits":0,
"originHits":0
},
{
"responseCode":"3xx",
"edgeHits":0,
"originHits":0
},
{
"responseCode":"4xx",
"edgeHits":0,
"originHits":0
},
{
"responseCode":"5xx",
"edgeHits":0,
"originHits":0
}
],
"trafficSegments":[
{
"edgeId":469,
"edgeName":"choi-edge-001",
"offloadHits":0.0,
"edgeHits":0,
"originHits":0,
"offloadBytes":0.0,
"edgeBytes":0,
"originShieldBytes":0,
"originBytes":0
}
],
"statistics":[
{
"time":"2022-11-14T00:00:00Z",
"offloadHits":0.0,
"edgeHits":0,
"originShieldHits":0,
"originHits":0,
"edgeSuccessCount":0,
"edgeRedirectionCount":0,
"edgeClientErrorCount":0,
"edgeServerErrorCount":0,
"originSuccessCount":0,
"originRedirectionCount":0,
"originClientErrorCount":0,
"originServerErrorCount":0,
"offloadBytes":0.0,
"edgeBps":0.0,
"originShieldBps":0.0,
"originBps":0.0
},
...(中略)...
{
"time":"2022-11-16T08:00:00Z",
"offloadHits":0.0,
"edgeHits":0,
"originShieldHits":0,
"originHits":0,
"edgeSuccessCount":0,
"edgeRedirectionCount":0,
"edgeClientErrorCount":0,
"edgeServerErrorCount":0,
"originSuccessCount":0,
"originRedirectionCount":0,
"originClientErrorCount":0,
"originServerErrorCount":0,
"offloadBytes":0.0,
"edgeBps":0.0,
"originShieldBps":0.0,
"originBps":0.0
}
]
}
}
エラーコード
エラーコード | 説明 |
---|---|
0032 | 許可されていないリクエスト |
0400 | リクエストデータ形式の不一致 |
0401 | 終了日は開始日より後ろにすること |
0402 | 統計日付の範囲超過 |
9999 | サーバエラー発生 |
この記事は役に立ちましたか?