requestCdnPlusPurge

개요

CDN+ 퍼지를 요청합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
cdnInstanceNo Yes String CDN인스턴스 번호
isWholeDomain Yes Boolean true 또는 false 전체 도메인 여부
전체 도메인에 대한 퍼지 요청일 경우 true, 특정 도메인에 대한 퍼지 요청일 경우 false 를 입력합니다.
domainIdList.N No List<String> 도메인 ID 리스트
특정 도메인에 대한 퍼지 요청일 경우 입력합니다.
ex) domainIdList.1=CD000000000000016682&domainIdList.2=CD000000000000016683
isWholePurge Yes Boolean true 또는 false 전체 퍼지 여부
전체 파일의 퍼지 요청일 경우 true, 특정 디렉토리 혹은 파일의 퍼지 요청일 경우 false 를 입력합니다.
targetFileList.N No List<String> 대상 파일 리스트
특정 파일의 퍼지 요청일 경우 입력합니다.
ex) targetFileList.1=alice.txt&targetFileList.2=bob.png
targetDirectoryName No String 대상 디렉토리명
특정 디렉토리의 퍼지 요청일 경우 입력합니다. 해당 디렉토리 하위의 모든 파일이 퍼지됩니다.
ex) targetDirectoryName=/contents/sample
responseFormatType No String JSON 또는 XML 응답 타입

응답

모든 응답은 HTTP Status Code으로 성공/실패를 반환합니다.

HTTP 상태 코드 코드 메시지 설명
200 Success 퍼지 성공
401 Unauthorized 인증 실패
500 Internal Server Error 서버 오류

속성

항목 필수 여부 타입 설명
cdnInstanceNo No String CDN 인스턴스 번호
purgeId No String 퍼지 ID
isWholePurge No Boolean 전체 퍼지 여부
isWholeDomain No Boolean 전체 도메인 퍼지 여부
cdnPlusServiceDomainList No List<CdnPlusServiceDomain> CDN+ 서비스 도메인 리스트
domainId No String 도메인 ID
serviceDomainTypeCode No String 서비스 도메인 구분코드
protocolTypeCode No String 프로토콜 구분코드
defaultDomainName No String 디폴트 도메인 이름
userDomainName No String 유저 도메인 이름
targetDirectoryName No String 대상 디렉터리명
targetFileList No List<String> 대상 파일 리스트
requestDate No String 요청날짜
purgeStatusName No String 퍼지 상태

예시

요청 예시

https://ncloud.apigw.ntruss.com/cdn/v2/requestCdnPlusPurge?cdnInstanceNo=711484&isWholePurge=true&isWholeDomain=true&responseFormatType=XML

응답 예시

<?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 코드 설명
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.