使用量の照会

Prev Next

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

照会期間の CDNサービス使用量を照会します。

リクエスト

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

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

ガイドは 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/getGlobalCdnUsageData?cdnInstanceNoList.1=2851****&startDate=2025071623&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "getGlobalCdnUsageDataResponse": {
        "startDate": "2025071623",
        "endDate": "2025071817",
        "aggregation": 86400,
        "volumeDataRecordList": [
            [
                1752674400000,
                0
            ],
            [
                1752760800000,
                1371687657
            ]
        ],
        "requestDataRecordList": [
            [
                1752674400000,
                0
            ],
            [
                1752760800000,
                6
            ]
        ],
        "bandwidthDataRecordList": [
            [
                1752674400000,
                0
            ],
            [
                1752760800000,
                0.12112437857521904
            ]
        ],
        "volumeDataUnit": "bytes",
        "requestDataUnit": "count",
        "bandwidthDataUnit": "Mbps",
        "pointStart": 1752674400000,
        "pointInterval": 86400000,
        "maxBandwidth": 0.12112437857521904,
        "totalVolume": 1371687657,
        "totalRequest": 6,
        "requestId": "1078eac6-****-****-****-8debf82391a8",
        "returnCode": "0",
        "returnMessage": "success"
    }
}