스트림 쿼리 목록 조회

검색 조건과 일치하는 스트림 쿼리 목록을 조회합니다. 특정 스트림 쿼리의 상세 정보는 스트림 쿼리 조회 API로 확인할 수 있습니다.

필요 권한

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

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/stream-queries?offset=0&limit=20"

요청 매개변수

쿼리 매개변수

정상 응답

{
  "total_count": 1,
  "stream_queries": [
    {
      "id": 1,
      "guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "http-error-stream",
      "description": "HTTP 오류 실시간 집계",
      "source_type": "table",
      "sources": ["iis", "apache"],
      "interval": 60,
      "query_string": "stats count by status | import http-error-stream",
      "enabled": true,
      "async": false,
      "owner": "root"
    }
  ]
}

• total_count (64비트 정수): 검색 조건과 일치하는 전체 스트림 쿼리 개수
• stream_queries (배열): 검색 조건과 일치하는 스트림 쿼리 목록
  • id (64비트 정수): 스트림 쿼리 식별자
  • guid (문자열): 스트림 쿼리 GUID
  • name (문자열): 스트림 쿼리 이름
  • description (문자열): 스트림 쿼리 설명
  • source_type (문자열): 실시간 입력 유형. table, logger, stream 중 하나
  • sources (배열): 입력 데이터 원본 목록
  • interval (32비트 정수): 새로고침 주기(초)
  • query_string (문자열): 쿼리문
  • enabled (불리언): 활성화 여부
  • async (불리언): 비동기 모드 여부
  • owner (문자열): 스트림 쿼리 소유자 계정

오류 응답

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."
}

권한이 없는 경우

HTTP 상태 코드 500 응답

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