퍼지 요청

Prev Next

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

퍼지 작업을 수행합니다.

요청

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

메서드 URI
POST /api/v1/purge

요청 헤더

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

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
edgeId Long Required 엣지 아이디
purgeType String Required 퍼지 유형
  • ALL | DIRECTORY | PATTERN | URL
    • ALL: 전체 퍼지
    • DIRECTORY: 디렉터리 단위 퍼지
    • PATTERN: 디렉터리 및 파일 확장자 단위 퍼지
    • URL: 개별 파일 단위 퍼지
purgeTarget Array Conditional 퍼지 대상 목록
  • 선택한 purgeType에 따라 입력
    • ALL: 필드 생략
    • DIRECTORY: /로 시작, /\*로 마침
      • <예시> /src/images/\*
    • PATTERN: /로 시작, *.abc 확장자로 마침
      • <예시> /static/\*.png, /static/images/*.css
    • URL: /로 시작, 와일드카드(*) 사용 불가
      • <예시> /src/css/main.css?version=2024
참고

엣지의 서비스 지역이 글로벌인 경우, 퍼지 유형별 작업 소요 시간이 상이합니다.

  • ALL, DIRECTORY, PATTERN 단위 퍼지 작업은 약 40분 정도 소요될 수 있습니다.
  • URL 단위 퍼지 작업은 빠르게 처리됩니다.

요청 예시

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

curl --location --request POST 'https://edge.apigw.ntruss.com/api/v1/purge' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "edgeId": 11197,
    "purgeType": "DIRECTORY",
    "purgeTarget": [
        "/src/images/*",
        "/static/thumbs/*"
    ]
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
code String - 응답 코드
message String - 응답 메시지
result Array - 퍼지 요청 아이디
  • 퍼지 이력 조회 시 필요

응답 상태 코드

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

응답 예시

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

{
    "code": "0000",
    "message": "Success",
    "result": [
        372****
    ]
}