getGlobalCdnUsageData
- Print
- PDF
getGlobalCdnUsageData
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
Searches the Global 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 "yyyyMMddHH" |
| endDate | No | String | Search end date and time "yyyyMMddHH" |
| aggregation | No | Long | Aggregation time information of response data (sec) |
| 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 |
| pointStart | No | Long | Search start time |
| pointInterval | No | Long | Aggregation time information of response data (millisec) |
| 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/getGlobalCdnUsageData?cdnInstanceNoList.1=1234&endDate=2022032600&startDate=2022032000&responseFormatType=XML
Response examples
<getGlobalCdnUsageDataResponse>
<requestId>e6b23362-b742-4640-b536-a1b30d3b2f04</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<startDate>2022032000</startDate>
<endDate>2022032600</endDate>
<aggregation>86400</aggregation>
<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>5373083</int>
</list>
<list>
<long>1648220400000</long>
<int>0</int>
</list>
</volumeDataRecordList>
<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>25</int>
</list>
<list>
<long>1648220400000</long>
<int>0</int>
</list>
</requestDataRecordList>
<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>
<double>0.0030166777777777777</double>
</list>
<list>
<long>1648220400000</long>
<int>0</int>
</list>
</bandwidthDataRecordList>
<volumeDataUnit>bytes</volumeDataUnit>
<requestDataUnit>count</requestDataUnit>
<bandwidthDataUnit>bps</bandwidthDataUnit>
<pointStart>1647702000000</pointStart>
<pointInterval>86400000</pointInterval>
<maxBandwidth>0.006033355555555555</maxBandwidth>
<totalVolume>5373083</totalVolume>
<totalRequest>25</totalRequest>
</getGlobalCdnUsageDataResponse>
Error codes
| Error Code | Description |
|---|---|
| 29100 | Invalid Global CDN rule format. |
| 29101 | Can not operate this Global CDN service. Please check status. |
| 29102 | Invalid Global CDN purge request. |
| 29103 | Invalid Global CDN service domain type code. |
| 29104 | Please enter Forward Host Header. |
| 29105 | Invalid Origin server. |
| 29106 | Invalid Origin server ports. |
| 29107 | Invalid Origin File Storage. |
| 29108 | Please enter Referrer Domain. |
| 29109 | Invalid service name. |
| 29110 | Please enter service domain. |
| 29111 | Invalid service domain. |
| 29112 | Invalid Global CDN instance. |
| 29113 | Only HTTP protocol is allowed when Origin is File Storage. |
| 29114 | This domain can not set as origin. |
| 29115 | For HTTPS protocol, only CDN domain can be set. |
| 29116 | An error occurred in purge request. |
| 29117 | Invalid origin path. |
| 29118 | Invalid referrer domain. |
| 29119 | Invalid rule for access log. |
| 29120 | Invalid Forward Host Header. |
| 29121 | Referrer Domains can be added up to 50. |
| 29122 | Can not request purge for the CDN service. Please check status. |
| 29123 | The purge function can only be used after about 3 hours after the creation request is made. |
| 29124 | There is an error in the service domain name entered during the purge request. |
Was this article helpful?