エッジ統計の照会

Prev Next

Classic/VPC環境で利用できます。

エッジの使用量統計情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/statistics/{profileId}/{edgeId}

リクエストヘッダ

Global Edge APIで共通して使用されるヘッダの詳細は、Global Edgeのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
profileId Long Required プロファイル ID
edgeId Long Required エッジ ID

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
dateFrom String Required 照会開始日時
  • ISO 8601形式(UTCを使用)
  • 730日前まで入力可能
dateTo String Required 照会終了日時
  • ISO 8601形式(UTCを使用)
  • 現在時刻まで入力可能

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://edge.apigw.ntruss.com/api/v1/statistics/4210/11207?dateFrom=2025-07-17T07%3A00%3A00Z&dateTo=2025-07-17T08%3A00%3A00Z' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.dateFrom String - 照会開始日時
  • ISO 8601形式(UTCを使用)
result.dateTo String - 照会終了日時
  • ISO 8601形式(UTCを使用)
result.interval Long - 集計周期(秒)
result.hitsTotal Object - レスポンス数ベースの統計
result.hitsTotal.offload Object - オフロード統計
result.hitsTotal.offload.value Double - オフロード平均
result.hitsTotal.offload.min Double - オフロード最小値
result.hitsTotal.offload.max Double - オフロード最大値
result.hitsTotal.offload.minDate String - オフロード最小値記録日時
  • ISO 8601形式(UTCを使用)
result.hitsTotal.offload.maxDate String - オフロード最大値記録日時
  • ISO 8601形式(UTCを使用)
result.hitsTotal.edgeHits Object - エッジレスポンス数の統計
result.hitsTotal.edgeHits.value Long - エッジレスポンス数の合計
result.hitsTotal.edgeHits.min Long - エッジレスポンス数の最小値
result.hitsTotal.edgeHits.max Long - エッジレスポンス数の最大値
result.hitsTotal.edgeHits.minDate String - エッジレスポンス数最小値の記録日時
  • ISO 8601形式(UTCを使用)
result.hitsTotal.edgeHits.maxDate String - エッジレスポンス数最大値の記録日時
  • ISO 8601形式(UTCを使用)
result.hitsTotal.originShieldHits Object - オリジンシールドレスポンス数の統計
result.hitsTotal.originShieldHits.value Long - オリジンシールドレスポンス数の合計
result.hitsTotal.originShieldHits.min Long - オリジンシールドレスポンス数の最小値
result.hitsTotal.originShieldHits.max Long - オリジンシールドレスポンス数の最大値
result.hitsTotal.originShieldHits.minDate String - オリジンシールドレスポンス数最小値の記録日時
  • ISO 8601形式(UTCを使用)
result.hitsTotal.originShieldHits.maxDate String - オリジンシールドレスポンス数最大値の記録日時
  • ISO 8601形式(UTCを使用)
result.hitsTotal.originHits Object - オリジンレスポンス数の統計
result.hitsTotal.originHits.value Long - オリジンレスポンス数の合計
result.hitsTotal.originHits.min Long - オリジンレスポンス数の最小値
result.hitsTotal.originHits.max Long - オリジンレスポンス数の最大値
result.hitsTotal.originHits.minDate String - オリジンレスポンス数最小値の記録日時
  • ISO 8601形式(UTCを使用)
result.hitsTotal.originHits.maxDate String - オリジンレスポンス数最大値の記録日時
  • ISO 8601形式(UTCを使用)
result.hitsTotal.errorHits Object - エラーレスポンス数の統計
result.hitsTotal.errorHits.value Long - エラーレスポンス数の合計
result.hitsTotal.errorHits.min Long - エラーレスポンス数の最小値
result.hitsTotal.errorHits.max Long - エラーレスポンス数の最大値
result.hitsTotal.errorHits.minDate String - エラーレスポンス数最小値の記録日時
  • ISO 8601形式(UTCを使用)
result.hitsTotal.errorHits.maxDate String - エラーレスポンス数最大値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal Object - トラフィックに基づいた全体の統計
result.bytesTotal.offload Object - オフロードトラフィックの統計
result.bytesTotal.offload.value Double - オフロードトラフィックの平均
result.bytesTotal.offload.min Double - オフロードトラフィックの最小値
result.bytesTotal.offload.max Double - オフロードトラフィックの最大値
result.bytesTotal.offload.minDate String - オフロードトラフィック最小値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.offload.maxDate String - オフロードトラフィック最大値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.edgeBytes Object - エッジトラフィックの統計(Bytes)
result.bytesTotal.edgeBytes.value Long - エッジトラフィックの合計
result.bytesTotal.edgeBytes.min Long - エッジトラフィックの最小値
result.bytesTotal.edgeBytes.max Long - エッジトラフィックの最大値
result.bytesTotal.edgeBytes.minDate String - エッジトラフィック最小値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.edgeBytes.maxDate String - エッジトラフィック最大値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.originShieldBytes Object - オリジンシールドトラフィックの統計(Bytes)
result.bytesTotal.originShieldBytes.value Long - オリジンシールドトラフィックの合計
result.bytesTotal.originShieldBytes.min Long - オリジンシールドトラフィックの最小値
result.bytesTotal.originShieldBytes.max Long - オリジンシールドトラフィックの最大値
result.bytesTotal.originShieldBytes.minDate String - オリジンシールドトラフィック最小値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.originShieldBytes.maxDate String - オリジンシールドトラフィック最大値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.originBytes Object - オリジントラフィックの統計(Bytes)
result.bytesTotal.originBytes.value Long - オリジントラフィックの合計
result.bytesTotal.originBytes.min Long - オリジントラフィックの最小値
result.bytesTotal.originBytes.max Long - オリジントラフィックの最大値
result.bytesTotal.originBytes.minDate String - オリジントラフィック最小値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.originBytes.maxDate String - オリジントラフィック最大値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.edgeBps Object - エッジトラフィックの統計(bps)
result.bytesTotal.edgeBps.value Double - エッジトラフィックの平均
result.bytesTotal.edgeBps.min Double - エッジトラフィックの最小値
result.bytesTotal.edgeBps.max Double - エッジトラフィックの最大値
result.bytesTotal.edgeBps.minDate String - エッジトラフィック最小値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.edgeBps.maxDate String - エッジトラフィック最大値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.originShieldBps Object - オリジンシールドトラフィックの統計(bps)
result.bytesTotal.originShieldBps.value Double - オリジンシールドトラフィックの平均
result.bytesTotal.originShieldBps.min Double - オリジンシールドトラフィックの最小値
result.bytesTotal.originShieldBps.max Double - オリジンシールドトラフィックの最大値
result.bytesTotal.originShieldBps.minDate String - オリジンシールドトラフィック最小値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.originShieldBps.maxDate String - オリジンシールドトラフィック最大値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.originBps Object - オリジントラフィックの統計(bps)
result.bytesTotal.originBps.value Double - オリジントラフィックの平均
result.bytesTotal.originBps.min Double - オリジントラフィックの最小値
result.bytesTotal.originBps.max Double - オリジントラフィックの最大値
result.bytesTotal.originBps.minDate String - オリジントラフィック最小値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.originBps.maxDate String - オリジントラフィック最大値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.errorHits Object - エラーレスポンス数の統計
result.bytesTotal.errorHits.value Long - エラーレスポンス数の合計
result.bytesTotal.errorHits.min Long - エラーレスポンス数の最小値
result.bytesTotal.errorHits.max Long - エラーレスポンス数の最大値
result.bytesTotal.errorHits.minDate String - エラーレスポンス数最小値の記録日時
  • ISO 8601形式(UTCを使用)
result.bytesTotal.errorHits.maxDate String - エラーレスポンス数最大値の記録日時
  • ISO 8601形式(UTCを使用)
result.responseSegments Array - HTTPレスポンスコード別統計: responseSegments
result.trafficSegments Array - エッジ別統計: trafficSegments
result.statistics Array - 時間別統計: statistics

responseSegments

responseSegmentsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
responseCode String - HTTPレスポンスコード
edgeHits Long - エッジレスポンス数の合計
originHits Long - オリジンレスポンス数の合計

trafficSegments

trafficSegmentsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
edgeId Long - エッジ ID
edgeName String - エッジ名
offloadHits Double - エッジレスポンス数オフロードの平均
edgeHits Long - エッジレスポンス数の合計
originHits Long - オリジンレスポンス数の合計
offloadBytes Double - エッジトラフィックオフロードの平均
edgeBytes Long - エッジトラフィックの合計(Bytes)
originShieldBytes Long - オリジンシールドトラフィックの合計(Bytes)
originBytes Long - オリジントラフィックの合計(Bytes)

statistics

statisticsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
time String - 集計時間
  • ISO 8601形式(UTCを使用)
offloadHits Double - この時間のオフロードの平均
edgeHits Long - この時間のエッジレスポンス数の合計
originShieldHits Long - この時間のオリジンシールドレスポンス数の合計
originHits Long - この時間のオリジンレスポンス数の合計
edgeSuccessCount Long - この時間のエッジ2xxレスポンス数の合計
edgeRedirectionCount Long - この時間のエッジ3xxレスポンス数の合計
edgeClientErrorCount Long - この時間のエッジ4xxレスポンス数の合計
edgeServerErrorCount Long - この時間のエッジ5xxレスポンス数の合計
originSuccessCount Long - この時間のオリジン2xxレスポンス数の合計
originRedirectionCount Long - この時間のオリジン3xxレスポンス数の合計
originClientErrorCount Long - この時間のオリジン4xxレスポンス数の合計
originServerErrorCount Long - この時間のオリジン5xxレスポンス数の合計
offloadBytes Double - この時間のトラフィックオフロードの平均
edgeBytes Long - この時間のエッジトラフィックの合計
originShieldBytes Long - この時間のオリジンシールドトラフィックの合計
originBytes Long - この時間のオリジントラフィックの合計
edgeBps Double - この時間のエッジトラフィック(bps)
originShieldBps Double - この時間のオリジンシールドトラフィック(bps)
originBps Double - この時間のオリジントラフィック(bps)

レスポンスステータスコード

Global Edge APIで共通して使用されるレスポンスステータスコードの詳細は、Global Edgeのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": "0000",
    "message": "Success",
    "result": {
        "dateFrom": "2025-07-17T07:00:00Z",
        "dateTo": "2025-07-17T07:23:38.714693345Z",
        "interval": 300,
        "hitsTotal": {
            "offload": {
                "value": 3.142857142857143,
                "min": 0,
                "max": 44,
                "minDate": "2025-07-17T07:10:00Z",
                "maxDate": "2025-07-17T07:15:00Z"
            },
            "edgeHits": {
                "value": 13,
                "min": 0,
                "max": 13,
                "minDate": "2025-07-17T07:10:00Z",
                "maxDate": "2025-07-17T07:15:00Z"
            },
            "originShieldHits": {
                "value": 0,
                "min": 0,
                "max": 0,
                "minDate": "2025-07-17T07:10:00Z",
                "maxDate": "2025-07-17T07:10:00Z"
            },
            "originHits": {
                "value": 2,
                "min": 0,
                "max": 2,
                "minDate": "2025-07-17T07:10:00Z",
                "maxDate": "2025-07-17T07:15:00Z"
            },
            "errorHits": {
                "value": 34,
                "min": 0,
                "max": 14,
                "minDate": "2025-07-17T07:10:00Z",
                "maxDate": "2025-07-17T07:15:00Z"
            }
        },
        "bytesTotal": {
            "offload": {
                "value": 7.142857142857143,
                "min": 0,
                "max": 100,
                "minDate": "2025-07-17T07:10:00Z",
                "maxDate": "2025-07-17T07:05:00Z"
            },
            "edgeBytes": {
                "value": 48163,
                "min": 0,
                "max": 45631,
                "minDate": "2025-07-17T07:10:00Z",
                "maxDate": "2025-07-17T07:15:00Z"
            },
            "originShieldBytes": {
                "value": 0,
                "min": 0,
                "max": 0,
                "minDate": "2025-07-17T07:10:00Z",
                "maxDate": "2025-07-17T07:10:00Z"
            },
            "originBytes": {
                "value": 18522,
                "min": 0,
                "max": 18522,
                "minDate": "2025-07-17T07:10:00Z",
                "maxDate": "2025-07-17T07:15:00Z"
            },
            "edgeBps": {
                "value": 91.73905,
                "min": 0,
                "max": 1216.8267,
                "minDate": "2025-07-17T07:10:00Z",
                "maxDate": "2025-07-17T07:15:00Z"
            },
            "originShieldBps": {
                "value": 0,
                "min": 0,
                "max": 0,
                "minDate": "2025-07-17T07:10:00Z",
                "maxDate": "2025-07-17T07:10:00Z"
            },
            "originBps": {
                "value": 35.28,
                "min": 0,
                "max": 493.92,
                "minDate": "2025-07-17T07:10:00Z",
                "maxDate": "2025-07-17T07:15:00Z"
            },
            "errorHits": {
                "value": 34,
                "min": 0,
                "max": 14,
                "minDate": "2025-07-17T07:10:00Z",
                "maxDate": "2025-07-17T07:15:00Z"
            }
        },
        "responseSegments": [
            {
                "responseCode": "2xx",
                "edgeHits": 13,
                "originHits": 2
            },
            {
                "responseCode": "3xx",
                "edgeHits": 0,
                "originHits": 0
            },
            {
                "responseCode": "4xx",
                "edgeHits": 20,
                "originHits": 14
            },
            {
                "responseCode": "5xx",
                "edgeHits": 0,
                "originHits": 0
            }
        ],
        "trafficSegments": [
            {
                "edgeId": 11207,
                "edgeName": "edge001",
                "offloadHits": 3.142857142857143,
                "edgeHits": 13,
                "originHits": 2,
                "offloadBytes": 7.142857142857143,
                "edgeBytes": 48163,
                "originShieldBytes": 0,
                "originBytes": 18522
            }
        ],
        "statistics": [
            {
                "time": "2025-07-17T07:00:00Z",
                "offloadHits": 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,
                "edgeBytes": 0,
                "originShieldBytes": 0,
                "originBytes": 0,
                "edgeBps": 0,
                "originShieldBps": 0,
                "originBps": 0
            },
            ...
        ]
    }
}