モニタリングデータの照会

Prev Next

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

照会期間の CDNサービスモニタリングデータを照会します。

リクエスト

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

メソッド URI
GET | POST /cdn/v2/getGlobalCdnMonitoringData
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
cdnInstanceNoList.N Array Required CDNインスタンス番号リスト
startDate String Required 照会開始日時
  • yyyyMMddHH形式
  • 照会開始日時から1時間間隔の集計データを照会
endDate String Required 照会終了日時
  • yyyyMMddHH形式
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/cdn/v2/getGlobalCdnMonitoringData?cdnInstanceNoList.1=2851****
&startDate=2025071815&endDate=2025071817&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
getGlobalCdnMonitoringDataResponse Object - レスポンス結果
getGlobalCdnMonitoringDataResponse.startDate String - 照会開始日時
getGlobalCdnMonitoringDataResponse.endDate String - 照会終了日時
getGlobalCdnMonitoringDataResponse.aggregation Number - 集計周期(秒)
getGlobalCdnMonitoringDataResponse.volumeDataRecordList Array - 転送量データリスト
  • [timestamp, value]形式
getGlobalCdnMonitoringDataResponse.requestDataRecordList Array - リクエスト数データリスト
  • [timestamp, value]形式
getGlobalCdnMonitoringDataResponse.bandwidthDataRecordList Array - トラフィックデータリスト
  • [timestamp, value]形式
getGlobalCdnMonitoringDataResponse.offloadDataRecordList Array - ヒット率データリスト
  • [timestamp, value]形式
getGlobalCdnMonitoringDataResponse.twoxxEdgeHitsDataRecordList Array - 2xxレスポンス数リスト
  • [timestamp, value]形式
getGlobalCdnMonitoringDataResponse.threexxEdgeHitsDataRecordList Array - 3xxレスポンス数リスト
  • [timestamp, value]形式
getGlobalCdnMonitoringDataResponse.fourxxEdgeHitsDataRecordList Array - 4xxレスポンス数リスト
  • [timestamp, value]形式
getGlobalCdnMonitoringDataResponse.fivexxEdgeHitsDataRecordList Array - 5xxレスポンス数リスト
  • [timestamp, value]形式
getGlobalCdnMonitoringDataResponse.volumeDataUnit String - 転送量単位: bytes (有効値)
getGlobalCdnMonitoringDataResponse.requestDataUnit String - リクエスト数単位: count (有効値)
getGlobalCdnMonitoringDataResponse.bandwidthDataUnit String - トラフィック単位: Mbps (有効値)
getGlobalCdnMonitoringDataResponse.offloadDataUnit String - ヒット率単位: percent (有効値)
getGlobalCdnMonitoringDataResponse.xxxEdgeHitsDataUnit String - レスポンス数単位: count (有効値)
getGlobalCdnMonitoringDataResponse.pointStart Number - 照会開始日時(ミリ秒)
  • Unix Timestamp形式
getGlobalCdnMonitoringDataResponse.pointInterval Number - 集計周期(ミリ秒)
getGlobalCdnMonitoringDataResponse.maxBandwidth Number - 照会期間の最大トラフィック
getGlobalCdnMonitoringDataResponse.totalVolume Number - 照会期間の総転送量
getGlobalCdnMonitoringDataResponse.totalRequest Number - 照会期間の総リクエスト数
getGlobalCdnMonitoringDataResponse.maxOffload Number - 照会期間の最大ヒット率
getGlobalCdnMonitoringDataResponse.totalTwoxxEdgeHits Number - 照会期間内の総2xxレスポンス数
getGlobalCdnMonitoringDataResponse.totalThreexxEdgeHits Number - 照会期間の総3xxレスポンス数
getGlobalCdnMonitoringDataResponse.totalFourxxEdgeHits Number - 照会期間の総4xxレスポンス数
getGlobalCdnMonitoringDataResponse.totalFivexxEdgeHits Number - 照会期間の総5xxレスポンス数
getGlobalCdnMonitoringDataResponse.requestId String - リクエスト ID
  • UUID形式
getGlobalCdnMonitoringDataResponse.returnCode String - レスポンスコード
getGlobalCdnMonitoringDataResponse.returnMessage String - レスポンスメッセージ

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

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

レスポンス例

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

{
    "getGlobalCdnMonitoringDataResponse": {
        "startDate": "2025071815",
        "endDate": "2025071817",
        "aggregation": 3600,
        "volumeDataRecordList": [
            [
                1752818400000,
                0
            ],
            [
                1752822000000,
                1371687657
            ]
        ],
        "requestDataRecordList": [
            [
                1752818400000,
                0
            ],
            [
                1752822000000,
                6
            ]
        ],
        "bandwidthDataRecordList": [
            [
                1752818400000,
                0
            ],
            [
                1752822000000,
                2.9069850858052573
            ]
        ],
        "offloadDataRecordList": [
            [
                1752818400000,
                0
            ],
            [
                1752822000000,
                33.33333333333333
            ]
        ],
        "twoxxEdgeHitsDataRecordList": [
            [
                1752818400000,
                0
            ],
            [
                1752822000000,
                4
            ]
        ],
        "threexxEdgeHitsDataRecordList": [
            [
                1752818400000,
                0
            ],
            [
                1752822000000,
                0
            ]
        ],
        "fourxxEdgeHitsDataRecordList": [
            [
                1752818400000,
                0
            ],
            [
                1752822000000,
                2
            ]
        ],
        "fivexxEdgeHitsDataRecordList": [
            [
                1752818400000,
                0
            ],
            [
                1752822000000,
                0
            ]
        ],
        "volumeDataUnit": "bytes",
        "requestDataUnit": "count",
        "bandwidthDataUnit": "Mbps",
        "offloadDataUnit": "percent",
        "xxxEdgeHitsDataUnit": "count",
        "pointStart": 1752818400000,
        "pointInterval": 3600000,
        "maxBandwidth": 2.9069850858052573,
        "totalVolume": 1371687657,
        "totalRequest": 6,
        "maxOffload": 33.33333333333333,
        "totalTwoxxEdgeHits": 4,
        "totalThreexxEdgeHits": 0,
        "totalFourxxEdgeHits": 2,
        "totalFivexxEdgeHits": 0,
        "requestId": "963722f0-****-****-****-f11e9fc61b84",
        "returnCode": "0",
        "returnMessage": "success"
    }
}