Overview
Gets CDN+ purge history.
Request
Request parameters
| Parameter | Required | Type | Limitations | Description |
|---|---|---|---|---|
| cdnInstanceNo | Y | String | CDN instance number | |
| purgeIdList | N | List<String> | List of purge IDs Used to inquire the result of a specific purge ID. ex) purgeIdList.1=PT000000000000002152&purgeIdList.2=PT000000000000002166 |
|
| responseFormatType | N | String | JSON or XML | Response type |
Response
The API returns an HTTP status code indicating success or failure.
| HTTP status code | Code message | Description |
|---|---|---|
| 200 | Success | Succeeded |
| 401 | Unauthorized | Authentication failed |
| 500 | Internal Server Error | Server error |
Properties
| Property | Required | Type | Description |
|---|---|---|---|
| cdnInstanceNo | N | String | CDN instance number |
| purgeId | N | String | Purge ID |
| isWholePurge | N | Boolean | Indicates whether to purge all content. |
| isWholeDomain | N | Boolean | Indicates whether to purge all domains. |
| cdnPlusServiceDomainList | N | List<CdnPlusServiceDomain> | List of CDN+ service domains |
| domainId | N | String | Domain ID |
| serviceDomainTypeCode | N | String | Service domain type code |
| protocolTypeCode | N | String | Protocol type code |
| defaultDomainName | N | String | Default domain name |
| userDomainName | N | String | User domain name |
| targetDirectoryName | N | String | Target directory name |
| targetFileList | N | List<String> | List of files to purge |
| requestDate | N | String | Request date |
| purgeStatusName | N | String | Purge status |
Examples
Request example
https://ncloud.apigw.ntruss.com/cdn/v2/getCdnPlusPurgeHistoryList?cdnInstanceNo=711484&responseFormatType=XML
Response example
<?xml version="1.0" encoding="UTF-8"?>
<getCdnPlusPurgeHistoryListResponse>
<requestId>44131fba-83d5-4a77-aa5b-d6eb61d7042e</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>4</totalRows>
<cdnPlusPurgeHistoryList>
<cdnPlusPurgeHistory>
<cdnInstanceNo>711484</cdnInstanceNo>
<purgeId>PT000000000000002166</purgeId>
<isWholePurge>false</isWholePurge>
<isWholeDomain>true</isWholeDomain>
<cdnPlusServiceDomainList>
<cdnPlusServiceDomain>
<domainId>CD000000000000008054</domainId>
<serviceDomainTypeCode>DEFAULT</serviceDomainTypeCode>
<protocolTypeCode>HTTP</protocolTypeCode>
<defaultDomainName>sjktsyeuckvp711484.cdn.ntruss.com</defaultDomainName>
<userDomainName></userDomainName>
</cdnPlusServiceDomain>
</cdnPlusServiceDomainList>
<targetDirectoryName></targetDirectoryName>
<targetFileList>
<string>/sample_img.jpg</string>
</targetFileList>
<requestDate>2018-04-27T19:45:25+0900</requestDate>
<purgeStatusName>success</purgeStatusName>
</cdnPlusPurgeHistory>
<cdnPlusPurgeHistory>
<cdnInstanceNo>711484</cdnInstanceNo>
<purgeId>PT000000000000002152</purgeId>
<isWholePurge>false</isWholePurge>
<isWholeDomain>true</isWholeDomain>
<cdnPlusServiceDomainList>
<cdnPlusServiceDomain>
<domainId>CD000000000000008054</domainId>
<serviceDomainTypeCode>DEFAULT</serviceDomainTypeCode>
<protocolTypeCode>HTTP</protocolTypeCode>
<defaultDomainName>sjktsyeuckvp711484.cdn.ntruss.com</defaultDomainName>
<userDomainName></userDomainName>
</cdnPlusServiceDomain>
</cdnPlusServiceDomainList>
<targetDirectoryName></targetDirectoryName>
<targetFileList>
<string>/common.min.js</string>
<string>/jindo.js</string>
</targetFileList>
<requestDate>2018-04-27T17:05:45+0900</requestDate>
<purgeStatusName>success</purgeStatusName>
</cdnPlusPurgeHistory>
<cdnPlusPurgeHistory>
<cdnInstanceNo>711484</cdnInstanceNo>
<purgeId>PT000000000000002151</purgeId>
<isWholePurge>false</isWholePurge>
<isWholeDomain>true</isWholeDomain>
<cdnPlusServiceDomainList>
<cdnPlusServiceDomain>
<domainId>CD000000000000008054</domainId>
<serviceDomainTypeCode>DEFAULT</serviceDomainTypeCode>
<protocolTypeCode>HTTP</protocolTypeCode>
<defaultDomainName>sjktsyeuckvp711484.cdn.ntruss.com</defaultDomainName>
<userDomainName></userDomainName>
</cdnPlusServiceDomain>
</cdnPlusServiceDomainList>
<targetDirectoryName></targetDirectoryName>
<targetFileList>
<string>/common.min.js</string>
<string>/jindo.js</string>
<string>/main.css</string>
<string>/sample_mv.mp4</string>
<string>/sample_img.jpg</string>
</targetFileList>
<requestDate>2018-04-27T16:59:59+0900</requestDate>
<purgeStatusName>success</purgeStatusName>
</cdnPlusPurgeHistory>
<cdnPlusPurgeHistory>
<cdnInstanceNo>711484</cdnInstanceNo>
<purgeId>PT000000000000002088</purgeId>
<isWholePurge>false</isWholePurge>
<isWholeDomain>true</isWholeDomain>
<cdnPlusServiceDomainList>
<cdnPlusServiceDomain>
<domainId>CD000000000000008054</domainId>
<serviceDomainTypeCode>DEFAULT</serviceDomainTypeCode>
<protocolTypeCode>HTTP</protocolTypeCode>
<defaultDomainName>sjktsyeuckvp711484.cdn.ntruss.com</defaultDomainName>
<userDomainName></userDomainName>
</cdnPlusServiceDomain>
</cdnPlusServiceDomainList>
<targetDirectoryName></targetDirectoryName>
<targetFileList>
<string>/sample_img.jpg</string>
</targetFileList>
<requestDate>2018-04-22T16:13:24+0900</requestDate>
<purgeStatusName>success</purgeStatusName>
</cdnPlusPurgeHistory>
</cdnPlusPurgeHistoryList>
</getCdnPlusPurgeHistoryListResponse>
Error codes
| Error code | Description |
|---|---|
| 29200 | Invalid CDN rule. |
| 29201 | Cannot 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 cannot request purge with partial domains. |
| 29216 | Invalid CDN service domain. |
| 29209 | The certificate cannot 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 cannot be set Origin Hostname if there is only one service domain. |
| 29224 | Cache Key Hostname cannot be set Origin Hostname if use CDN domain. |