getGlobalCdnMonitoringData
- Print
- PDF
getGlobalCdnMonitoringData
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
Searches the Global CDN monitoring 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 "yyyyMMddHH" | Search start date and time |
| endDate | Yes | String | Format is "yyyyMMddHH" | Search end date and time |
| responseFormatType | No | String | JSON or XML | Response type |
Response
Every response returns success/failure with a 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 | Edge traffic unit (bps) |
| bandwidthDataRecordList | No | List<List<Double>> | Traffic data list |
| volumeDataUnit | No | String | Edge transmission unit (byte) |
| volumeDataRecordList | No | List<List<Long>> | Transmission data list |
| requestDataUnit | No | Long | Edge request unit (count) |
| requestDataRecordList | No | List<List<Long>> | Request count data list |
| offloadDataUnit | No | String | Hit rate unit (%) |
| offloadDataRecordList | No | List<List<Double>> | Hit rate data list |
| xxxEdgeHitsDataUnit | No | String | Unit of numbers by edge response code (count) |
| twoxxEdgeHitsDataRecordList | No | List<List<Long>> | Number of 2xx response codes |
| threexxEdgeHitsDataRecordList | No | List<List<Long>> | Number of 3xx response codes |
| fourxxEdgeHitsDataRecordList | No | List<List<Long>> | Number of 4xx response codes |
| fivexxEdgeHitsDataRecordList | No | List<List<Long>> | Number of 5xx response codes |
| 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 |
| maxOffload | No | Double | Maximum hit rate within the period (% |
| totalTwoxxEdgeHits | No | Long | Total number of edge's 2xx response codes within the period |
| totalThreexxEdgeHits | No | Long | Total number of edge's 3xx response codes within the period |
| totalFourxxEdgeHits | No | Long | Total number of edge's 4xx response codes within the period |
| totalFivexxEdgeHits | No | Long | Total number of edge's 5xx response codes within the period |
Examples
Request examples
https://ncloud.apigw.ntruss.com/cdn/v2/getGlobalCdnMonitoringData?cdnInstanceNoList.1=1234&endDate=2022032600&startDate=2022032000&responseFormatType=XML
Response examples
<getGlobalCdnMonitoringDataResponse>
<requestId>73cf4bd3-f724-4a29-b69c-5785420a425b</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<startDate>2022032000</startDate>
<endDate>2022032600</endDate>
<aggregation>3600</aggregation>
<volumeDataRecordList>
<list>
<long>1648195200000</long>
<int>23751</int>
</list>
<list>
<long>1648198800000</long>
<int>5349332</int>
</list>
</volumeDataRecordList>
<requestDataRecordList>
<list>
<long>1648195200000</long>
<int>12</int>
</list>
<list>
<long>1648198800000</long>
<int>13</int>
</list>
</requestDataRecordList>
<bandwidthDataRecordList>
<list>
<long>1648195200000</long>
<double>1.9933333333333334E-5</double>
</list>
<list>
<long>1648198800000</long>
<double>0.006013422222222222</double>
</list>
</bandwidthDataRecordList>
<offloadDataRecordList>
<list>
<long>1648195200000</long>
<int>0</int>
</list>
<list>
<long>1648198800000</long>
<double>23.076923076923077</double>
</list>
</offloadDataRecordList>
<twoxxEdgeHitsDataRecordList>
<list>
<long>1648195200000</long>
<int>0</int>
</list>
<list>
<long>1648198800000</long>
<int>3</int>
</list>
</twoxxEdgeHitsDataRecordList>
<threexxEdgeHitsDataRecordList>
<list>
<long>1648195200000</long>
<int>0</int>
</list>
<list>
<long>1648198800000</long>
<int>3</int>
</list>
</threexxEdgeHitsDataRecordList>
<fourxxEdgeHitsDataRecordList>
<list>
<long>1648195200000</long>
<int>12</int>
</list>
<list>
<long>1648198800000</long>
<int>7</int>
</list>
</fourxxEdgeHitsDataRecordList>
<fivexxEdgeHitsDataRecordList>
<list>
<long>1648195200000</long>
<int>0</int>
</list>
<list>
<long>1648198800000</long>
<int>0</int>
</list>
</fivexxEdgeHitsDataRecordList>
<volumeDataUnit>bytes</volumeDataUnit>
<requestDataUnit>count</requestDataUnit>
<bandwidthDataUnit>bps</bandwidthDataUnit>
<offloadDataUnit>percent</offloadDataUnit>
<xxxEdgeHitsDataUnit>count</xxxEdgeHitsDataUnit>
<pointStart>1647702000000</pointStart>
<pointInterval>3600000</pointInterval>
<maxBandwidth>0.006013422222222222</maxBandwidth>
<totalVolume>5373083</totalVolume>
<totalRequest>25</totalRequest>
<maxOffload>23.076923076923077</maxOffload>
<totalTwoxxEdgeHits>3</totalTwoxxEdgeHits>
<totalThreexxEdgeHits>3</totalThreexxEdgeHits>
<totalFourxxEdgeHits>19</totalFourxxEdgeHits>
<totalFivexxEdgeHits>0</totalFivexxEdgeHits>
</getGlobalCdnMonitoringDataResponse>
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?