MENU
      getCdnPlusUsageData

        getCdnPlusUsageData


        Article summary

        Overview

        Searches the CDN+ usage data.

        Request

        Request parameter

        Parameter nameRequirement statusTypeRestrictionsDescription
        cdnInstanceNoList.NYesList<String>CDN instance number list
        cdnInstanceNoList.1=2323
        startDateYesStringFormat is "yyyyMMdd."Search start date and time
        endDateYesStringFormat is "yyyyMMdd."Search end date and time
        regionNoNoStringRegion number: When it's not filled out, the KR region is the default.
        responseFormatTypeNoStringJSON or XMLResponse type

        Response

        Every response returns success or failure with an HTTP status code.

        HTTP status codeCode messageDescription
        200SuccessSearch succeeded
        401UnauthorizedAuthentication failed
        500Internal Server ErrorServer error

        Property

        ItemRequirement statusTypeDescription
        startDateNoStringSearch start date and time "yyyyMMdd"
        endDateNoStringSearch end date and time "yyyyMMdd"
        startDateEpochNoLongSearch start date and time EpochTime
        endDateEpochNoLongSearch end date and time EpochTime
        intervalNoLongAggregation time information of response data
        Within 2 days: 5 minutes
        Over 2 days - within 1 week: 30 minutes
        Over 1 week - within 1 month: 2 hours
        Over 1 month - within 3 months: 6 hours
        bandwidthDataUnitNoStringTraffic unit (bps)
        bandwidthDataRecordListNoList<List<Double>>Traffic data list
        volumeDataUnitNoStringTransmission unit (byte)
        volumeDataRecordListNoList<List<Long>>Transmission data list
        requestDataUnitNoLongRequest count unit (count)
        requestDataRecordListNoList<List<Long>>Request count data list
        maxBandwidthNoDoubleMaximum edge traffic within the period
        totalVolumeNoLongTotal transmission within the period
        totalRequestNoLongTotal number of requests within the period

        Examples

        Request examples

        https://ncloud.apigw.ntruss.com/cdn/v2/getCdnPlusUsageData?cdnInstanceNoList.1=1234&endDate=20220325&startDate=20220320&responseFormatType=XML
        HTTP

        Response examples

        <?xml version="1.0" encoding="UTF-8"?>
        <getCdnPlusUsageDataResponse>
        <requestId>bfe70938-807b-4fa2-8f20-16085fd2743b</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <startDate>20220320</startDate>
        <endDate>20220325</endDate>
        <startDateEpoch>1647702000000</startDateEpoch>
        <endDateEpoch>1648134000000</endDateEpoch>
        <interval>86400000</interval>
        <bandwidthDataUnit>bps</bandwidthDataUnit>
        <bandwidthDataRecordList>
        <list>
        <long>1647702000000</long>
        <int>0</int>
        </list>
        <list>
        <long>1647788400000</long>
        <int>0</int>
        </list>
        <list>
        <long>1647874800000</long>
        <int>0</int>
        </list>
        <list>
        <long>1647961200000</long>
        <int>0</int>
        </list>
        <list>
        <long>1648047600000</long>
        <int>0</int>
        </list>
        <list>
        <long>1648134000000</long>
        <int>0</int>
        </list>
        </bandwidthDataRecordList>
        <volumeDataUnit>byte</volumeDataUnit>
        <volumeDataRecordList>
        <list>
        <long>1647702000000</long>
        <int>0</int>
        </list>
        <list>
        <long>1647788400000</long>
        <int>0</int>
        </list>
        <list>
        <long>1647874800000</long>
        <int>0</int>
        </list>
        <list>
        <long>1647961200000</long>
        <int>0</int>
        </list>
        <list>
        <long>1648047600000</long>
        <int>0</int>
        </list>
        <list>
        <long>1648134000000</long>
        <int>0</int>
        </list>
        </volumeDataRecordList>
        <requestDataUnit>count</requestDataUnit>
        <requestDataRecordList>
        <list>
        <long>1647702000000</long>
        <int>0</int>
        </list>
        <list>
        <long>1647788400000</long>
        <int>0</int>
        </list>
        <list>
        <long>1647874800000</long>
        <int>0</int>
        </list>
        <list>
        <long>1647961200000</long>
        <int>0</int>
        </list>
        <list>
        <long>1648047600000</long>
        <int>0</int>
        </list>
        <list>
        <long>1648134000000</long>
        <int>0</int>
        </list>
        </requestDataRecordList>
        <maxBandwidth>0.0</maxBandwidth>
        <totalVolume>0</totalVolume>
        <totalRequest>0</totalRequest>
        </getCdnPlusUsageDataResponse>
        XML

        Error codes

        Error codeDescription
        29200Invalid CDN rule.
        29201Can not operate this CDN service. Please check status.
        29202Invalid CDN purge request.
        29203Invalid CDN service domain type code.
        29204Invalid CDN instance.
        29205Unable to control the CDN service because this CDN service is for Live Transcoder.
        29211An error occurred while creating CDN service.
        29215This CDN service can not request purge with partial domains.
        29216Invalid CDN service domain.
        29209The certificate can not register for CDN.
        29217Please enter target file list or directory.
        29218Please select target service domains.
        29221Unable to control the CDN service because this CDN service is for Image Optimizer.
        29222Invalid image optimizer instance number.
        29223Cache Key Hostname can not be set Origin Hostname if there is only one service domain.
        29224Cache Key Hostname can not be set Origin Hostname if use CDN domain.

        Was this article helpful?

        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.