CrawlingInfo API

개요

CrawlingInfo API는 Fess 의 크롤링 정보(크롤링 세션)를 참조 및 관리하기 위한 API입니다. 크롤링 세션의 목록 조회, 개별 조회, 삭제 등을 조작할 수 있습니다.

기본 URL

/api/admin/crawlinginfo

엔드포인트 목록

메서드 경로 설명
GET /logs 크롤링 정보 목록 조회
GET /log/{id} 크롤링 정보 조회
DELETE /log/{id} 크롤링 정보 삭제
DELETE /all 크롤링 세션 일괄 삭제 (실행 중 제외)

크롤링 정보 목록 조회

요청

GET /api/admin/crawlinginfo/logs

파라미터

파라미터 타입 필수 설명
size Integer 아니오 페이지당 건수 (기본값: 20)
page Integer 아니오 페이지 번호 (1부터 시작, 기본값: 1)
sessionId String 아니오 세션 ID 필터 (부분 일치)

응답

{
  "response": {
    "status": 0,
    "logs": [
      {
        "id": "crawling_info_id_1",
        "sessionId": "20250129100000",
        "name": "Default Crawler",
        "expiredTime": "1738200000000",
        "createdTime": 1738108800000
      },
      {
        "id": "crawling_info_id_2",
        "sessionId": "20250128100000",
        "name": "Default Crawler",
        "expiredTime": "1738113600000",
        "createdTime": 1738022400000
      }
    ],
    "total": 10
  }
}

응답 필드

필드 설명
id 크롤링 정보 ID
sessionId 세션 ID
name 세션 이름
expiredTime 유효 기간 (에포크 밀리초; 문자열로 반환됨)
createdTime 작성 시각 (에포크 밀리초; 숫자로 반환됨)

참고

응답의 각 로그 오브젝트에는 내부적으로 사용되는 crudMode 필드 (CRUD 작업 모드를 나타내는 정수값으로, 읽기 작업 시 항상 0)가 포함됩니다. 클라이언트 측에서는 무시해도 됩니다.

크롤링 정보 조회

요청

GET /api/admin/crawlinginfo/log/{id}

응답

{
  "response": {
    "status": 0,
    "log": {
      "id": "crawling_info_id_1",
      "sessionId": "20250129100000",
      "name": "Default Crawler",
      "expiredTime": "1738200000000",
      "createdTime": 1738108800000
    }
  }
}

크롤링 정보 삭제

요청

DELETE /api/admin/crawlinginfo/log/{id}

응답

{
  "response": {
    "status": 0
  }
}

크롤링 세션 일괄 삭제

현재 실행 중인 세션을 제외한 모든 크롤링 세션(및 해당 파라미터 데이터)을 삭제합니다. 경과 시간에 의한 판정은 수행하지 않으며, 실행 중이지 않은 세션은 모두 삭제됩니다.

요청

DELETE /api/admin/crawlinginfo/all

응답

{
  "response": {
    "status": 0
  }
}

사용 예

크롤링 정보 목록 조회

curl -X GET "http://localhost:8080/api/admin/crawlinginfo/logs?size=50&page=1" \
     -H "Authorization: Bearer YOUR_TOKEN"

특정 세션으로 필터링

curl -X GET "http://localhost:8080/api/admin/crawlinginfo/logs?sessionId=20250129100000" \
     -H "Authorization: Bearer YOUR_TOKEN"

크롤링 정보 조회

curl -X GET "http://localhost:8080/api/admin/crawlinginfo/log/crawling_info_id_1" \
     -H "Authorization: Bearer YOUR_TOKEN"

크롤링 정보 삭제

curl -X DELETE "http://localhost:8080/api/admin/crawlinginfo/log/crawling_info_id_1" \
     -H "Authorization: Bearer YOUR_TOKEN"

세션 일괄 삭제

curl -X DELETE "http://localhost:8080/api/admin/crawlinginfo/all" \
     -H "Authorization: Bearer YOUR_TOKEN"

참고 정보