파서 목록 조회

검색 조건과 일치하는 파서 목록을 조회합니다.

필요 권한

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

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/parsers

요청 매개변수

정상 응답

{
  "total_count": 27,
  "parsers": [
    {
      "code": "fortigate",
      "name": "포티게이트",
      "description": "WELF 형식으로 된 포티게이트 로그를 파싱합니다.",
      "factory_name": "fortigate",
      "factory_display_name": "포티게이트",
      "builtin": true,
      "configs": {
        "ver": "2"
      },
      "created": "2022-09-01 00:31:14+0900",
      "updated": "2022-09-01 00:31:14+0900"
    }
  ]
}

• total_count (32비트 정수): 검색 조건과 일치하는 전체 건수
• parsers (배열): 파서 목록
  • code (문자열): 파서 식별자. parse 명령어에서 파서 호출 시 참조됨.
  • name (문자열): 파서 화면 표시 이름
  • description (문자열): 파서에 대한 설명
  • factory_name (문자열): 파서 유형 식별자
  • factory_display_name (문자열): 파서 유형 화면 표시 이름
  • builtin (불리언): 패키지 내장 파서 여부
  • schema_code (문자열): 정규화 스키마의 이름. 정규화 파서의 경우에만 출력됨.
  • schema_name (문자열): 정규화 스키마의 화면 표시 이름. 정규화 파서의 경우에만 출력됨.
  • configs (맵): 파서 유형별 설정 명세에 정의된 설정 키/값 목록
  • created (문자열): 생성일시. yyyy-MM-dd HH:mm:ssZ 형식.
  • updated (문자열): 수정일시. yyyy-MM-dd HH:mm:ssZ 형식.

오류 응답

잘못된 파서 유형을 지정한 경우

{
  "error_code": "invalid-argument",
  "error_msg": "type should be 'parser' or 'normalizer': unknown"
}

offset, limit 값이 정수가 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' parameter should be int type"
}

offset, limit 값이 음수인 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' must be greater than or equal to 0."
}