퍼지 수행

Classic/VPC 환경에서 이용 가능합니다.

퍼지 작업을 수행합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET \| POST	/cdn/v2/requestGlobalCdnPurge

참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

Global CDN API에서 공통으로 사용하는 헤더에 대한 정보는 Global CDN 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`cdnInstanceNo`	String	Required	CDN 인스턴스 번호 인스턴스 조회 참조
`isWholeDomain`	Boolean	Required	전체 도메인 대상 퍼지 여부 `true` \| `false` `true`: 전체 도메인 `false`: 지정한 도메인
`isWholePurge`	Boolean	Required	전체 파일 대상 퍼지 여부 `true` \| `false` `true`: 전체 파일 `false`: 지정한 파일
`serviceDomainNameList.N`	Array	Conditional	서비스 도메인 목록 `isWholeDomain`이 `false`인 경우, 필수 입력 <예시> `serviceDomainNameList.1=sample.example.com&serviceDomainNameList.2=test.example.com`
`targetFileList.N`	Array	Conditional	퍼지 대상 목록 `isWholePurge`가 `false`인 경우, 필수 입력 <예시> `targetFileList.1=alice.txt&targetFileList.2=bob.png`
`responseFormatType`	String	Optional	응답 데이터의 형식 `xml` (기본값) \| `json`

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/cdn/v2/requestGlobalCdnPurge?cdnInstanceNo=2851****&isWholeDomain=true
&isWholePurge=false&targetFileList.1=file.txt&targetFileList.2=compressed.zip&responseFormatType=json' \
--header 'Content-Type: application/json' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`requestGlobalCdnPurgeResponse`	Object	-	응답 결과
`requestGlobalCdnPurgeResponse.totalRows`	Integer	-	응답 결과 수
`requestGlobalCdnPurgeResponse.globalCdnPurgeHistoryList`	Array	-	퍼지 이력 목록
`requestGlobalCdnPurgeResponse.requestId`	String	-	요청에 대한 아이디 UUID 형식
`requestGlobalCdnPurgeResponse.returnCode`	String	-	응답 코드
`requestGlobalCdnPurgeResponse.returnMessage`	String	-	응답 메시지

`globalCdnPurgeHistoryList`

globalCdnPurgeHistoryList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`cdnInstanceNo`	String	-	CDN 인스턴스 번호
`purgeId`	String	-	퍼지 요청 아이디
`isWholePurge`	Boolean	-	전체 파일 대상 퍼지 여부 `true` \| `false` `true`: 전체 파일 `false`: 지정한 파일
`isWholeDomain`	Boolean	-	전체 도메인 대상 퍼지 여부 `true` \| `false` `true`: 전체 도메인 `false`: 지정한 도메인
`globalCdnServiceDomainList`	Array	-	서비스 도메인 목록: globalCdnServiceDomainList
`targetFileList`	Array	-	퍼지 대상 목록
`isSuccess`	Boolean	-	퍼지 성공 여부 `true` \| `false` `true`: 성공 `false`: 실패

`globalCdnServiceDomainList`

globalCdnServiceDomainList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`serviceDomainTypeCode`	String	-	서비스 도메인 구분 `DEFAULT` \| `USER` `DEFAULT`: 네이버 클라우드 플랫폼에서 제공하는 CDN 도메인 `USER`: 사용자 보유 도메인
`protocolTypeCode`	String	-	서비스 프로토콜
`defaultDomainName`	String	-	네이버 클라우드 플랫폼 도메인 이름
`userDomainName`	String	-	사용자 도메인 이름

응답 상태 코드

Global CDN API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Global CDN 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "requestGlobalCdnPurgeResponse": {
        "totalRows": 1,
        "globalCdnPurgeHistoryList": [
            {
                "cdnInstanceNo": "2851****",
                "purgeId": "edup-Cgqm**************uM",
                "isWholePurge": false,
                "isWholeDomain": true,
                "globalCdnServiceDomainList": [
                    {
                        "serviceDomainTypeCode": "DEFAULT",
                        "protocolTypeCode": "HTTP",
                        "defaultDomainName": "wlrw*********.gcdn.ntruss.com",
                        "userDomainName": ""
                    }
                ],
                "targetFileList": [
                    "/file.txt",
                    "/compressed.zip"
                ],
                "isSuccess": true
            }
        ],
        "requestId": "8eb274f2-****-****-****-50e2d1930727",
        "returnCode": "0",
        "returnMessage": "success"
    }
}