수집 모델 조회

지정한 수집 모델의 상세 정보와 정규화 규칙 목록을 조회합니다. 전체 목록은 수집 모델 목록 조회 API로 확인할 수 있습니다.

필요 권한

관리자 이상의 계정으로 이용할 수 있습니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/logger-models/cd09ae6f-fbc3-11ed-9320-02d178f999a6

요청 매개변수

경로 매개변수

정상 응답

{
  "logger_model": {
    "guid": "cd09ae6f-fbc3-11ed-9320-02d178f999a6",
    "name": "WTMP",
    "description": null,
    "logger_factory_name": "wtmp",
    "logger_factory_display_name": "WTMP",
    "parser_code": null,
    "parser_name": null,
    "app_code": null,
    "app_built_in": null,
    "rule_count": 1,
    "overlay": true,
    "common_stream_query": "eval _time = client_time",
    "rules": [
      {
        "guid": "cd0cdd74-fbc3-11ed-9320-02d178f999a6",
        "name": "WTMP - 인증",
        "log_schema_code": "auth",
        "log_schema_name": "인증",
        "parser_code": null,
        "parser_name": null,
        "stream_query": "search event_name == \"blacklist\"",
        "extended_stream_query": "lookup geoip src_ip output country as src_country",
        "stream_interval": 60,
        "app_code": null,
        "app_built_in": null
      }
    ],
    "created": "2023-10-01 09:18:27+0900",
    "updated": "2023-10-01 09:18:27+0900"
  }
}

• logger_model (맵): 수집 모델. 모델이 존재하지 않으면 null입니다.
  • guid (문자열): 수집 모델 GUID
  • name (문자열): 수집 모델 이름
  • description (문자열): 수집 모델 설명
  • logger_factory_name (문자열): 수집 유형 식별자
  • logger_factory_display_name (문자열): 수집 유형 표시 이름
  • parser_code (문자열): 파서 식별자
  • parser_name (문자열): 파서 이름
  • app_code (문자열): 앱 식별자
  • app_built_in (불리언): 앱 내장 객체 여부
  • rule_count (32비트 정수): 정규화 규칙 수
  • overlay (불리언): 오버레이 적용 여부
  • common_stream_query (문자열): 공통 스트림 쿼리. 정규화 규칙이 있을 때만 포함됩니다.
  • rules (객체 배열): 정규화 규칙 목록. 정규화 규칙이 있을 때만 포함됩니다.
    • guid (문자열): 정규화 규칙 GUID
    • name (문자열): 정규화 규칙 이름
    • log_schema_code (문자열): 로그 스키마 식별자
    • log_schema_name (문자열): 로그 스키마 이름
    • parser_code (문자열): 파서 식별자
    • parser_name (문자열): 파서 이름
    • filter (문자열, 선택적): 필터 조건. 값이 있을 때만 포함됩니다.
    • stream_query (문자열): 기본 스트림 쿼리
    • extended_stream_query (문자열): 확장 스트림 쿼리
    • stream_interval (32비트 정수): 스트림 쿼리 새로 고침 주기(초)
    • app_code (문자열): 앱 식별자
    • app_built_in (불리언): 앱 내장 객체 여부
  • created (문자열): 생성일시 (yyyy-MM-dd HH:mm:ssZ 형식)
  • updated (문자열): 수정일시 (yyyy-MM-dd HH:mm:ssZ 형식)

오류 응답

guid가 누락된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "null-argument",
  "error_msg": "guid should be not null"
}

guid가 GUID 형식이 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}

수집 모델이 존재하지 않는 경우

HTTP 상태 코드 200 응답

{
  "logger_model": null
}

권한이 없는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}