getCdnPlusUsageData
- Print
- PDF
getCdnPlusUsageData
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
Searches the CDN+ usage data.
Request
Request parameter
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| cdnInstanceNoList.N | Yes | List<String> | CDN instance number list cdnInstanceNoList.1=2323 | |
| startDate | Yes | String | Format is "yyyyMMdd." | Search start date and time |
| endDate | Yes | String | Format is "yyyyMMdd." | Search end date and time |
| regionNo | No | String | Region number: When it's not filled out, the KR region is the default. | |
| responseFormatType | No | String | JSON or XML | Response type |
Response
Every response returns success or failure with an HTTP status code.
| HTTP status code | Code message | Description |
|---|---|---|
| 200 | Success | Search succeeded |
| 401 | Unauthorized | Authentication failed |
| 500 | Internal Server Error | Server error |
Property
| Item | Requirement status | Type | Description |
|---|---|---|---|
| startDate | No | String | Search start date and time "yyyyMMdd" |
| endDate | No | String | Search end date and time "yyyyMMdd" |
| startDateEpoch | No | Long | Search start date and time EpochTime |
| endDateEpoch | No | Long | Search end date and time EpochTime |
| interval | No | Long | Aggregation 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 |
| bandwidthDataUnit | No | String | Traffic unit (bps) |
| bandwidthDataRecordList | No | List<List<Double>> | Traffic data list |
| volumeDataUnit | No | String | Transmission unit (byte) |
| volumeDataRecordList | No | List<List<Long>> | Transmission data list |
| requestDataUnit | No | Long | Request count unit (count) |
| requestDataRecordList | No | List<List<Long>> | Request count data list |
| maxBandwidth | No | Double | Maximum edge traffic within the period |
| totalVolume | No | Long | Total transmission within the period |
| totalRequest | No | Long | Total 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
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>
Error codes
| Error code | Description |
|---|---|
| 29200 | Invalid CDN rule. |
| 29201 | Can not operate this CDN service. Please check status. |
| 29202 | Invalid CDN purge request. |
| 29203 | Invalid CDN service domain type code. |
| 29204 | Invalid CDN instance. |
| 29205 | Unable to control the CDN service because this CDN service is for Live Transcoder. |
| 29211 | An error occurred while creating CDN service. |
| 29215 | This CDN service can not request purge with partial domains. |
| 29216 | Invalid CDN service domain. |
| 29209 | The certificate can not register for CDN. |
| 29217 | Please enter target file list or directory. |
| 29218 | Please select target service domains. |
| 29221 | Unable to control the CDN service because this CDN service is for Image Optimizer. |
| 29222 | Invalid image optimizer instance number. |
| 29223 | Cache Key Hostname can not be set Origin Hostname if there is only one service domain. |
| 29224 | Cache Key Hostname can not be set Origin Hostname if use CDN domain. |
Was this article helpful?