Purge 요청 조회
- 인쇄
- PDF
Purge 요청 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
개요
퍼지 작업 요청에 대한 상세 정보를 조회합니다.
요청
요청 URL
GET
https://edge.apigw.ntruss.com/api/v1/purge/{purgeRequestId}
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| purgeRequestId | Yes | Long | 퍼지 요청 번호 |
응답
모든 응답은 HTTP Status Code로 성공 또는 실패를 반환합니다.
| HTTP 상태 코드 | 코드 메시지 | 설명 |
|---|---|---|
| 200 | Success | 조회 성공 |
| 401 | Unauthorized | 인증 실패 |
| 500 | Internal Server Error | 서버 오류 |
PurgeHistory
| 항목 | 타입 | 설명 |
|---|---|---|
| clientIp | String | 퍼지 요청자 IP |
| purgeId | Long | 퍼지 요청 번호 |
| instanceNo | Long | 엣지 계약 번호 |
| requestDateTime | ZonedDateTime | 퍼지 요청 일시 (UTC) |
| serviceDomain | String | 퍼지 대상 도메인 |
| status | PurgeResult | 퍼지 진행 상태 |
| targetDirectory | String | 퍼지 대상 디렉토리 목록 (쉼표로 직렬화된) |
| targetFileList | List<String> | 퍼지 대상 목록 |
| targetFileListString | String | 퍼지 대상 목록 (쉼표로 직렬화된) |
| purgeType | PurgeType | 퍼지 유형 |
| workerType | WorkerType | 퍼지 요청자 계정 타입 |
| ticketId | String | 퍼지 티켓 ID |
PurgeResult
| 값 | 설명 |
|---|---|
| READY | 퍼지 실행 대기 중 |
| RUNNING | 퍼지 실행중 |
| SUCCESS | 완료됨 |
| FAILURE | 퍼지 실패 |
PurgeType
| 값 | 설명 |
|---|---|
| ALL | 모든 콘텐츠 퍼지 |
| DIRECTORY | 디렉토리 단위 퍼지 |
| PATTERN | 확장자 단위 콘텐츠 퍼지 |
| URL | URL 로 지정한 콘텐츠 퍼지 |
WorkerType
| 값 | 설명 |
|---|---|
| ACCOUNT | 메인 계정으로 요청됨 |
| SUBACCOUNT | 서브 계정에서 요청됨 |
예시
요청 예시
https://edge.apigw.ntruss.com/api/v1/purge/9999
응답 예시
{
"clientIp":"127.0.0.1",
"purgeId":9999,
"instanceNo":999999,
"requestDateTime":"2022-11-24T07:54:13Z",
"serviceDomain":"sample.mycustomdomain.com",
"status":"READY",
"purgeType":"ALL",
"workerType":"ACCOUNT",
"ticketId":"PT-00000000000000000000"
}
오류 코드
| Error 코드 | 설명 |
|---|---|
| 0032 | 허용되지 않은 요청 |
| 0400 | 요청 데이터 형식 불일치 |
| 9999 | 서버 오류 발생 |
이 문서가 도움이 되었습니까?