파서 유형 조회

지정한 파서 유형(팩토리)의 상세 정보를 조회합니다. 전체 파서 유형 목록은 파서 유형 목록 조회 API로 확인할 수 있습니다.

필요 권한

게스트 이상의 계정으로 이용할 수 있습니다.

HTTP 요청

cURL 예시

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

요청 매개변수

경로 매개변수

정상 응답

아래는 정규표현식 파서 유형에 대한 조회 예시입니다.

{
  "factory": {
    "name": "regex",
    "display_name": "정규표현식",
    "display_group": "범용",
    "description": "정규표현식을 이용하여 로그를 파싱합니다.",
    "deprecated": false,
    "options": [
      {
        "type": "string",
        "subtype": null,
        "name": "regex",
        "required": true,
        "display_name": "정규표현식",
        "description": "필드 이름이 포함된 정규표현식",
        "default_value": null
      },
      {
        "type": "string",
        "subtype": null,
        "name": "field",
        "required": false,
        "display_name": "대상 필드",
        "description": "정규표현식을 적용할 필드, 미설정 시 기본값은 line",
        "default_value": null
      }
    ]
  }
}

• factory (맵): 파서 유형
  • name (문자열): 파서 유형 식별자
  • display_name (문자열): 파서 유형의 화면 표시 이름
  • display_group (문자열): 파서 유형의 화면 표시 그룹
  • description (문자열): 파서 유형에 대한 설명
  • deprecated (불리언): 파서 유형의 사용 중단 예정 여부
  • options (배열): 설정 명세 목록
    • type (문자열): 데이터 타입. string, integer, boolean 중 하나.
    • subtype (문자열): UI에서 인식하는 확장 컴포넌트 유형
    • name (문자열): 설정 키 이름
    • required (불리언): 필수 여부
    • display_name (문자열): 로케일이 적용된 화면 표시 이름
    • description (문자열): 로케일이 적용된 화면 표시 설명
    • default_value (문자열): 화면에 표시할 설정 기본값

오류 응답

파서 유형이 존재하지 않는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "factory-not-found",
  "error_msg": null
}