requestCdnPlusPurge

Prev Next

Overview

Requests CDN+ purge.

Request

Request parameters

Parameter Required Type Limitations Description
cdnInstanceNo Y String CDN instance number
isWholeDomain Y Boolean true or false Indicates whether to purge all domains.
Enter true for purge requests for the entire domain, false for purge requests for the specific domain.
domainIdList.N N List<String> List of domain IDs
Enter for purge requests for a specific domain.
ex) domainIdList.1=CD000000000000016682&domainIdList.2=CD000000000000016683
isWholePurge Y Boolean true or false Indicates whether to purge all content.
Enter true for purge requests for all files or false for purge requests for specific directories or files.
targetFileList.N N List<String> List of files to purge
Enter for purge request of a specific file.
ex) targetFileList.1=alice.txt&targetFileList.2=bob.png
targetDirectoryName N String Name of the directory to purge
Enter for purge requests from a specific directory. All files under that directory will be purged.
ex) targetDirectoryName=/contents/sample
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 Purge 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/requestCdnPlusPurge?cdnInstanceNo=711484&isWholePurge=true&isWholeDomain=true&responseFormatType=XML

Response example

<?xml version="1.0" encoding="UTF-8"?>
<requestCdnPlusPurgeResponse>
  <requestId>337bd4f2-5bdf-4707-98f5-216c3ee79395</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cdnPlusPurgeHistoryList>
    <cdnPlusPurgeHistory>
      <cdnInstanceNo>711484</cdnInstanceNo>
      <purgeId>PT000000000000015497</purgeId>
      <isWholePurge>true</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/>
      <requestDate>2018-12-09T02:00:18+0900</requestDate>
      <purgeStatusName>ready</purgeStatusName>
    </cdnPlusPurgeHistory>
  </cdnPlusPurgeHistoryList>
</requestCdnPlusPurgeResponse>

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.