로그 스키마 어시스트 필드 목록 조회

로그 스키마를 작성할 때 참조할 수 있도록, 키워드로 기존 로그 스키마의 필드명(field_name) 또는 표시명(display_name)을 검색합니다.

필요 권한

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

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/log-schema-assist/fields?locale=ko&type=field_name&keywords=ip"

요청 매개변수

정상 응답

{
  "total_count": 2,
  "schema_names": {
    "session": { "en": "Session", "ko": "세션" }
  },
  "schema_fields": [
    {
      "schema_code": "session",
      "name": "src_ip",
      "display_name": "출발지IP",
      "type": "IP",
      "ordinal": 2
    },
    {
      "schema_code": "session",
      "name": "dst_ip",
      "display_name": "목적지IP",
      "type": "IP",
      "ordinal": 4
    }
  ]
}

• total_count (32비트 정수): 검색 조건과 일치하는 전체 건수
• schema_names (맵): 스키마 코드별 로케일 이름
• schema_fields (배열): 로그 스키마 필드 목록
  • schema_code (문자열): 스키마 코드
  • name (문자열): 필드 이름
  • display_name (문자열): 화면 표시 이름
  • type (문자열): 필드 유형. DATE, STRING, IP, PORT, SHORT, INT, LONG, COUNTRY, FLOAT, DOUBLE, BOOL, MD5, SHA1, URL, SHA256, DOMAIN 중 하나.
  • ordinal (32비트 정수, 선택적): 필드 표시 순서

오류 응답

keywords, locale, type이 누락된 경우

HTTP 상태 코드 400 응답

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

type이 허용 값이 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "invalid-type: wrong-value"
}

지원하지 않는 언어를 지정한 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "unsupported-locale: ru"
}

limit 값이 정수가 아닌 경우

HTTP 상태 코드 400 응답

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

limit 값이 음수인 경우

HTTP 상태 코드 400 응답

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

권한이 없는 경우

HTTP 상태 코드 500 응답

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