getCdnPlusMonitoringData
-
Print
-
PDF
getCdnPlusMonitoringData
-
Print
-
PDF
Overview
Searches the 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 "yyyyMMddHHmm." | Search start date and time |
| endDate | Yes | String | Format is "yyyyMMddHHmm." | 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/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 "yyyyMMddHHmm" |
| endDate | No | String | Search end date and time "yyyyMMddHHmm" |
| 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 | 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 |
| originBandwidthDataUnit | No | String | Source traffic unit (bps) |
| originBandwidthDataRecordList | No | List<List<Double>> | Traffic data list |
| xxxOriginHitsDataUnit | No | String | Edge request count unit (count) |
| twoxxOriginHitsDataRecordList | No | List<List<Long>> | Number of 2xx response codes |
| threexxOriginHitsDataRecordList | No | List<List<Long>> | Number of 3xx response codes |
| fourxxOriginHitsDataRecordList | No | List<List<Long>> | Number of 4xx response codes |
| fivexxOriginHitsDataRecordList | No | List<List<Long>> | Number of 5xx response codes |
| 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 |
| maxOriginBandwidth | No | Double | Maximum source traffic within the period |
| totalTwoxxOriginHits | No | Long | Total number of source's 2xx response codes within the period |
| totalThreexxOriginHits | No | Long | Total number of source's 3xx response codes within the period |
| totalFourxxOriginHits | No | Long | Total number of source's 4xx response codes within the period |
| totalFivexxOriginHits | No | Long | Total number of source's 5xx response codes within the period |
Examples
Request examples
https://ncloud.apigw.ntruss.com/cdn/v2/getCdnPlusMonitoringData?cdnInstanceNoList.1=1234&endDate=202203200100&startDate=202203200000&responseFormatType=XML
Response examples
<?xml version="1.0" encoding="UTF-8"?>
<getCdnPlusMonitoringDataResponse>
<requestId>b3cde407-7ef6-417b-8620-2b6519f81558</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<startDate>202203200000</startDate>
<endDate>202203200100</endDate>
<startDateEpoch>1647702000000</startDateEpoch>
<endDateEpoch>1647705600000</endDateEpoch>
<interval>300000</interval>
<bandwidthDataUnit>bps</bandwidthDataUnit>
<bandwidthDataRecordList>
<list>
<long>1647702000000</long>
<int>0</int>
</list>
<list>
<long>1647702300000</long>
<int>0</int>
</list>
<list>
<long>1647702600000</long>
<int>0</int>
</list>
<list>
<long>1647702900000</long>
<int>0</int>
</list>
<list>
<long>1647703200000</long>
<int>0</int>
</list>
<list>
<long>1647703500000</long>
<int>0</int>
</list>
<list>
<long>1647703800000</long>
<int>0</int>
</list>
<list>
<long>1647704100000</long>
<int>0</int>
</list>
<list>
<long>1647704400000</long>
<int>0</int>
</list>
<list>
<long>1647704700000</long>
<int>0</int>
</list>
<list>
<long>1647705000000</long>
<int>0</int>
</list>
<list>
<long>1647705300000</long>
<int>0</int>
</list>
<list>
<long>1647705600000</long>
<int>0</int>
</list>
</bandwidthDataRecordList>
<volumeDataUnit>byte</volumeDataUnit>
<volumeDataRecordList>
<list>
<long>1647702000000</long>
<int>0</int>
</list>
<list>
<long>1647702300000</long>
<int>0</int>
</list>
<list>
<long>1647702600000</long>
<int>0</int>
</list>
<list>
<long>1647702900000</long>
<int>0</int>
</list>
<list>
<long>1647703200000</long>
<int>0</int>
</list>
<list>
<long>1647703500000</long>
<int>0</int>
</list>
<list>
<long>1647703800000</long>
<int>0</int>
</list>
<list>
<long>1647704100000</long>
<int>0</int>
</list>
<list>
<long>1647704400000</long>
<int>0</int>
</list>
<list>
<long>1647704700000</long>
<int>0</int>
</list>
<list>
<long>1647705000000</long>
<int>0</int>
</list>
<list>
<long>1647705300000</long>
<int>0</int>
</list>
<list>
<long>1647705600000</long>
<int>0</int>
</list>
</volumeDataRecordList>
<requestDataUnit>count</requestDataUnit>
<requestDataRecordList>
<list>
<long>1647702000000</long>
<int>0</int>
</list>
<list>
<long>1647702300000</long>
<int>0</int>
</list>
<list>
<long>1647702600000</long>
<int>0</int>
</list>
<list>
<long>1647702900000</long>
<int>0</int>
</list>
<list>
<long>1647703200000</long>
<int>0</int>
</list>
<list>
<long>1647703500000</long>
<int>0</int>
</list>
<list>
<long>1647703800000</long>
<int>0</int>
</list>
<list>
<long>1647704100000</long>
<int>0</int>
</list>
<list>
<long>1647704400000</long>
<int>0</int>
</list>
<list>
<long>1647704700000</long>
<int>0</int>
</list>
<list>
<long>1647705000000</long>
<int>0</int>
</list>
<list>
<long>1647705300000</long>
<int>0</int>
</list>
<list>
<long>1647705600000</long>
<int>0</int>
</list>
</requestDataRecordList>
<offloadDataUnit>percentage</offloadDataUnit>
<offloadDataRecordList>
<list>
<long>1647702000000</long>
<int>0</int>
</list>
<list>
<long>1647702300000</long>
<int>0</int>
</list>
<list>
<long>1647702600000</long>
<int>0</int>
</list>
<list>
<long>1647702900000</long>
<int>0</int>
</list>
<list>
<long>1647703200000</long>
<int>0</int>
</list>
<list>
<long>1647703500000</long>
<int>0</int>
</list>
<list>
<long>1647703800000</long>
<int>0</int>
</list>
<list>
<long>1647704100000</long>
<int>0</int>
</list>
<list>
<long>1647704400000</long>
<int>0</int>
</list>
<list>
<long>1647704700000</long>
<int>0</int>
</list>
<list>
<long>1647705000000</long>
<int>0</int>
</list>
<list>
<long>1647705300000</long>
<int>0</int>
</list>
<list>
<long>1647705600000</long>
<int>0</int>
</list>
</offloadDataRecordList>
<xxxEdgeHitsDataUnit>count</xxxEdgeHitsDataUnit>
<twoxxEdgeHitsDataRecordList>
<list>
<long>1647702000000</long>
<int>0</int>
</list>
<list>
<long>1647702300000</long>
<int>0</int>
</list>
<list>
<long>1647702600000</long>
<int>0</int>
</list>
<list>
<long>1647702900000</long>
<int>0</int>
</list>
<list>
<long>1647703200000</long>
<int>0</int>
</list>
<list>
<long>1647703500000</long>
<int>0</int>
</list>
<list>
<long>1647703800000</long>
<int>0</int>
</list>
<list>
<long>1647704100000</long>
<int>0</int>
</list>
<list>
<long>1647704400000</long>
<int>0</int>
</list>
<list>
<long>1647704700000</long>
<int>0</int>
</list>
<list>
<long>1647705000000</long>
<int>0</int>
</list>
<list>
<long>1647705300000</long>
<int>0</int>
</list>
<list>
<long>1647705600000</long>
<int>0</int>
</list>
</twoxxEdgeHitsDataRecordList>
<threexxEdgeHitsDataRecordList>
<list>
<long>1647702000000</long>
<int>0</int>
</list>
<list>
<long>1647702300000</long>
<int>0</int>
</list>
<list>
<long>1647702600000</long>
<int>0</int>
</list>
<list>
<long>1647702900000</long>
<int>0</int>
</list>
<list>
<long>1647703200000</long>
<int>0</int>
</list>
<list>
<long>1647703500000</long>
<int>0</int>
</list>
<list>
<long>1647703800000</long>
<int>0</int>
</list>
<list>
<long>1647704100000</long>
<int>0</int>
</list>
<list>
<long>1647704400000</long>
<int>0</int>
</list>
<list>
<long>1647704700000</long>
<int>0</int>
</list>
<list>
<long>1647705000000</long>
<int>0</int>
</list>
<list>
<long>1647705300000</long>
<int>0</int>
</list>
<list>
<long>1647705600000</long>
<int>0</int>
</list>
</threexxEdgeHitsDataRecordList>
<fourxxEdgeHitsDataRecordList>
<list>
<long>1647702000000</long>
<int>0</int>
</list>
<list>
<long>1647702300000</long>
<int>0</int>
</list>
<list>
<long>1647702600000</long>
<int>0</int>
</list>
<list>
<long>1647702900000</long>
<int>0</int>
</list>
<list>
<long>1647703200000</long>
<int>0</int>
</list>
<list>
<long>1647703500000</long>
<int>0</int>
</list>
<list>
<long>1647703800000</long>
<int>0</int>
</list>
<list>
<long>1647704100000</long>
<int>0</int>
</list>
<list>
<long>1647704400000</long>
<int>0</int>
</list>
<list>
<long>1647704700000</long>
<int>0</int>
</list>
<list>
<long>1647705000000</long>
<int>0</int>
</list>
<list>
<long>1647705300000</long>
<int>0</int>
</list>
<list>
<long>1647705600000</long>
<int>0</int>
</list>
</fourxxEdgeHitsDataRecordList>
<fivexxEdgeHitsDataRecordList>
<list>
<long>1647702000000</long>
<int>0</int>
</list>
<list>
<long>1647702300000</long>
<int>0</int>
</list>
<list>
<long>1647702600000</long>
<int>0</int>
</list>
<list>
<long>1647702900000</long>
<int>0</int>
</list>
<list>
<long>1647703200000</long>
<int>0</int>
</list>
<list>
<long>1647703500000</long>
<int>0</int>
</list>
<list>
<long>1647703800000</long>
<int>0</int>
</list>
<list>
<long>1647704100000</long>
<int>0</int>
</list>
<list>
<long>1647704400000</long>
<int>0</int>
</list>
<list>
<long>1647704700000</long>
<int>0</int>
</list>
<list>
<long>1647705000000</long>
<int>0</int>
</list>
<list>
<long>1647705300000</long>
<int>0</int>
</list>
<list>
<long>1647705600000</long>
<int>0</int>
</list>
</fivexxEdgeHitsDataRecordList>
<originBandwidthDataUnit>bps</originBandwidthDataUnit>
<originBandwidthDataRecordList>
<list>
<long>1647702000000</long>
<int>0</int>
</list>
<list>
<long>1647702300000</long>
<int>0</int>
</list>
<list>
<long>1647702600000</long>
<int>0</int>
</list>
<list>
<long>1647702900000</long>
<int>0</int>
</list>
<list>
<long>1647703200000</long>
<int>0</int>
</list>
<list>
<long>1647703500000</long>
<int>0</int>
</list>
<list>
<long>1647703800000</long>
<int>0</int>
</list>
<list>
<long>1647704100000</long>
<int>0</int>
</list>
<list>
<long>1647704400000</long>
<int>0</int>
</list>
<list>
<long>1647704700000</long>
<int>0</int>
</list>
<list>
<long>1647705000000</long>
<int>0</int>
</list>
<list>
<long>1647705300000</long>
<int>0</int>
</list>
<list>
<long>1647705600000</long>
<int>0</int>
</list>
</originBandwidthDataRecordList>
<xxxOriginHitsDataUnit>count</xxxOriginHitsDataUnit>
<twoxxOriginHitsDataRecordList>
<list>
<long>1647702000000</long>
<int>0</int>
</list>
<list>
<long>1647702300000</long>
<int>0</int>
</list>
<list>
<long>1647702600000</long>
<int>0</int>
</list>
<list>
<long>1647702900000</long>
<int>0</int>
</list>
<list>
<long>1647703200000</long>
<int>0</int>
</list>
<list>
<long>1647703500000</long>
<int>0</int>
</list>
<list>
<long>1647703800000</long>
<int>0</int>
</list>
<list>
<long>1647704100000</long>
<int>0</int>
</list>
<list>
<long>1647704400000</long>
<int>0</int>
</list>
<list>
<long>1647704700000</long>
<int>0</int>
</list>
<list>
<long>1647705000000</long>
<int>0</int>
</list>
<list>
<long>1647705300000</long>
<int>0</int>
</list>
<list>
<long>1647705600000</long>
<int>0</int>
</list>
</twoxxOriginHitsDataRecordList>
<threexxOriginHitsDataRecordList>
<list>
<long>1647702000000</long>
<int>0</int>
</list>
<list>
<long>1647702300000</long>
<int>0</int>
</list>
<list>
<long>1647702600000</long>
<int>0</int>
</list>
<list>
<long>1647702900000</long>
<int>0</int>
</list>
<list>
<long>1647703200000</long>
<int>0</int>
</list>
<list>
<long>1647703500000</long>
<int>0</int>
</list>
<list>
<long>1647703800000</long>
<int>0</int>
</list>
<list>
<long>1647704100000</long>
<int>0</int>
</list>
<list>
<long>1647704400000</long>
<int>0</int>
</list>
<list>
<long>1647704700000</long>
<int>0</int>
</list>
<list>
<long>1647705000000</long>
<int>0</int>
</list>
<list>
<long>1647705300000</long>
<int>0</int>
</list>
<list>
<long>1647705600000</long>
<int>0</int>
</list>
</threexxOriginHitsDataRecordList>
<fourxxOriginHitsDataRecordList>
<list>
<long>1647702000000</long>
<int>0</int>
</list>
<list>
<long>1647702300000</long>
<int>0</int>
</list>
<list>
<long>1647702600000</long>
<int>0</int>
</list>
<list>
<long>1647702900000</long>
<int>0</int>
</list>
<list>
<long>1647703200000</long>
<int>0</int>
</list>
<list>
<long>1647703500000</long>
<int>0</int>
</list>
<list>
<long>1647703800000</long>
<int>0</int>
</list>
<list>
<long>1647704100000</long>
<int>0</int>
</list>
<list>
<long>1647704400000</long>
<int>0</int>
</list>
<list>
<long>1647704700000</long>
<int>0</int>
</list>
<list>
<long>1647705000000</long>
<int>0</int>
</list>
<list>
<long>1647705300000</long>
<int>0</int>
</list>
<list>
<long>1647705600000</long>
<int>0</int>
</list>
</fourxxOriginHitsDataRecordList>
<fivexxOriginHitsDataRecordList>
<list>
<long>1647702000000</long>
<int>0</int>
</list>
<list>
<long>1647702300000</long>
<int>0</int>
</list>
<list>
<long>1647702600000</long>
<int>0</int>
</list>
<list>
<long>1647702900000</long>
<int>0</int>
</list>
<list>
<long>1647703200000</long>
<int>0</int>
</list>
<list>
<long>1647703500000</long>
<int>0</int>
</list>
<list>
<long>1647703800000</long>
<int>0</int>
</list>
<list>
<long>1647704100000</long>
<int>0</int>
</list>
<list>
<long>1647704400000</long>
<int>0</int>
</list>
<list>
<long>1647704700000</long>
<int>0</int>
</list>
<list>
<long>1647705000000</long>
<int>0</int>
</list>
<list>
<long>1647705300000</long>
<int>0</int>
</list>
<list>
<long>1647705600000</long>
<int>0</int>
</list>
</fivexxOriginHitsDataRecordList>
<maxBandwidth>0.0</maxBandwidth>
<totalVolume>0</totalVolume>
<totalRequest>0</totalRequest>
<maxOffload>0.0</maxOffload>
<totalTwoxxEdgeHits>0</totalTwoxxEdgeHits>
<totalThreexxEdgeHits>0</totalThreexxEdgeHits>
<totalFourxxEdgeHits>0</totalFourxxEdgeHits>
<totalFivexxEdgeHits>0</totalFivexxEdgeHits>
<maxOriginBandwidth>0.0</maxOriginBandwidth>
<totalTwoxxOriginHits>0</totalTwoxxOriginHits>
<totalThreexxOriginHits>0</totalThreexxOriginHits>
<totalFourxxOriginHits>0</totalFourxxOriginHits>
<totalFivexxOriginHits>0</totalFivexxOriginHits>
</getCdnPlusMonitoringDataResponse>
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?