Edge統計の照会
    • PDF

    Edge統計の照会

    • PDF

    記事の要約

    概要

    Edge使用量の統計を照会します。

    リクエスト

    リクエスト URL

    GET
    https://edge.apigw.ntruss.com/api/v1/statistics/{profileId}/{edgeId}
    

    リクエストパラメータ

    パラメータ名要否タイプ制約事項説明
    profileIdYesStringProfile番号
    edgeIdYesIntegerEdge番号
    dateFromYesStringISO日付フォーマット
    yyyy-MM-dd'T'HH:mm:ss
    Min: 730日前
    照会開始日
    (UTC)
    dateToYesStringISO日付フォーマット
    yyyy-MM-dd'T'HH:mm:ss
    Max: 現在時刻
    照会終了日
    (UTC)

    レスポンス

    すべてのレスポンスは、HTTP Status Codeで成功または失敗を返します。

    HTTPステータスコードコードのメッセージ説明
    200Success照会成功
    401Unauthorized認証失敗
    500Internal Server Errorサーバエラー

    StatisticsSummary

    項目タイプ説明
    dateFromZonedDateTime統計照会の開始時間(UTC)
    dateToZonedDateTime統計照会の終了時間(UTC)
    intervalLong統計データの間隔(秒)
    hitsTotalHitsTotal全体 Request関連統計の要約
    hitsTotal.offload.valueDouble全体オフロードの平均
    hitsTotal.offload.minDouble全体統計のうちオフロード最低値
    hitsTotal.offload.maxDouble全体統計のうちオフロード最大値
    hitsTotal.edgeHits.valueLong全体 Edge Hit総計
    hitsTotal.edgeHits.minLong全体統計のうち Edge Hit最低値
    hitsTotal.edgeHits.maxLong全体統計のうち Edge Hit最大値
    hitsTotal.originShieldHits.valueLong全体 Origin Shield Hit総計
    hitsTotal.originShieldHits.minLong全体統計のうち Origin Shield Hit最低値
    hitsTotal.originShieldHits.maxLong全体統計のうち Origin Shield Hit最大値
    hitsTotal.originHits.valueLong全体 Origin Hit総計
    hitsTotal.originHits.minLong全体統計のうち Origin Hit最低値
    hitsTotal.originHits.maxLong全体統計のうち Origin Hit最大値
    hitsTotal.errorHits.valueLong全体 Error Hit総計
    hitsTotal.errorHits.minLong全体統計のうち Error Hit最低値
    hitsTotal.errorHits.maxLong全体統計のうち Error Hit最大値
    bytesTotal.offload.valueDouble全体オフロードトラフィック総計
    bytesTotal.offload.minDouble全体統計のうちオフロードトラフィック最低値
    bytesTotal.offload.maxDouble全体統計のうちオフロードトラフィック最大値
    bytesTotal.edgeBytes.valueLong全体 Edgeトラフィック(Byte)総計
    bytesTotal.edgeBytes.minLong全体統計のうち Edgeトラフィック(Byte)最低値
    bytesTotal.edgeBytes.maxLong全体統計のうち Edgeトラフィック(Byte)最大値
    bytesTotalBytesTotal全体トラフィック(Byte)関連統計の要約
    bytesTotal.originShieldBytes.valueLong全体 Origin Shieldトラフィック(Byte)総計
    bytesTotal.originShieldBytes.minLong全体統計のうち Origin Shieldトラフィック(Byte)最低値
    bytesTotal.originShieldBytes.maxLong全体統計のうち Origin Shieldトラフィック(Byte)最大値
    bytesTotal.originBytes.valueLong全体 Originトラフィック(Byte)総計
    bytesTotal.originBytes.minLong全体統計のうち Originトラフィック(Byte)最低値
    bytesTotal.originBytes.maxLong全体統計のうち Originトラフィック(Byte)最大値
    bytesTotal.errorHits.valueLong全体 Error Hit総計
    bytesTotal.errorHits.minLong全体統計のうち Error Hit最低値
    bytesTotal.errorHits.maxLong全体統計のうち Error Hit最大値
    responseSegmentsList<ResponseSegment>HTTPレスポンスコード別統計データ
    responseSegments[].responseCodeString
    2xx / 3xx / 4xx / 5xx
    HTTPレスポンスコード
    responseSegments[].edgeHitsLongEdgeレスポンスコード発生総計
    responseSegments[].originHitsLongOriginレスポンスコード発生総計
    trafficSegmentsList<TrafficSegments>Edge別統計データ
    trafficSegments[].edgeIdLongEdge番号
    trafficSegments[].edgeNameStringEdge名
    trafficSegments[].offloadHitsDoubleEdge Hitのオフロード平均
    trafficSegments[].edgeHitsLongインスタンスの Edge Hit発生総計
    trafficSegments[].originHitsLongインスタンスの Origin Hit発生総計
    trafficSegments[].offloadBytesDoubleEdgeトラフィック(Byte)のオフロード平均
    trafficSegments[].edgeBytesLongインスタンスの Edgeトラフィック(Byte)発生総計
    trafficSegments[].originShieldBytesLongインスタンスの Origin Shieldトラフィック(Byte)発生総計
    trafficSegments[].originBytesLongインスタンスの Originトラフィック(Byte)発生総計
    statisticsList<ChartValue>Timestamp基準で総合された統計
    statistics[].timeZonedDateTime統計収集時間帯(UTC)
    statistics[].offloadHitsDouble当該時間帯のオフロード平均
    statistics[].edgeHitsLong当該時間帯の Edge Hit発生総計
    statistics[].originShieldHitsLong当該時間帯の Origin Shield Hit発生総計
    statistics[].originHitsLong当該時間帯の Origin Hit発生総計
    statistics[].edgeSuccessCountLong当該時間帯の Edge 2xxレスポンス発生総計
    statistics[].edgeRedirectionCountLong当該時間帯の Edge 3xxレスポンス発生総計
    statistics[].edgeClientErrorCountLong当該時間帯の Edge 4xxレスポンス発生総計
    statistics[].edgeServerErrorCountLong当該時間帯の Edge 5xxレスポンス発生総計
    statistics[].originSuccessCountLong当該時間帯の Origin 2xxレスポンス発生総計
    statistics[].originRedirectionCountLong当該時間帯の Origin 3xxレスポンス発生総計
    statistics[].originClientErrorCountLong当該時間帯の Origin 4xxレスポンス発生総計
    statistics[].originServerErrorCountLong当該時間帯の Origin 5xxレスポンス発生総計
    statistics[].offloadBytesDouble当該時間帯のトラフィック(Byte)オフロード平均
    statistics[].edgeBpsDouble当該時間帯の Edgeトラフィック(Byte)発生総計
    statistics[].originShieldBpsDouble当該時間帯の Origin Shieldトラフィック(Byte)発生総計
    statistics[].originBpsDouble当該時間帯の 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サーバエラー発生

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.