스트림 쿼리 목록 조회

스트림 쿼리 목록을 조회합니다. 이 작업은 관리자 권한을 요구합니다.

필요 권한

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

HTTP 요청

cURL 예시

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

요청 매개변수

정상 응답

{
  "total_count": 2,
  "stream_queries": [
    {
      "guid": "6dc1c563-d01c-3047-9573-cc6c24374925",
      "name": "example-code-1108",
      "description": "스트림 쿼리 예제",
      "source_type": "table",
      "sources": ["TABLE1", "TABLE2"],
      "interval": 60,
      "query_string": "rename RESULT_CODE as RESULT_CODE | eval bucket = string(LOG_TIME, \"yyyyMMddHHmm\") | stats count by bucket,_host,RESULT_CODE,SVC_NAME,TO_SVC_NAME,CALLING_INTERFACE | rename SVC_NAME as group_field1 | rename TO_SVC_NAME as group_field2 | rename CALLING_INTERFACE as group_field3 | eval _time=date(bucket,\"yyyyMMddHHmm\") | fields _time,bucket,_host,group_field1,group_field2,group_field3,RESULT_CODE,count | import example-code-1108",
      "is_enabled": true,
      "is_async": false
    },
    {
      "guid": "3fbedcfa-70f4-354e-a22c-d82007004657",
      "name": "example-code-1111",
      "description": "스트림 쿼리 예제",
      "source_type": "table",
      "sources": ["TABLE1"],
      "interval": 60,
      "query_string": "rename RESULT_CODE as RESULT_CODE | eval bucket = string(LOG_TIME, \"yyyyMMddHHmm\") | stats count by bucket,_host,RESULT_CODE,TO_SVC_NAME,CALLING_CONTENTS,CEK_EXTENSION_ID | rename TO_SVC_NAME as group_field1 | rename CALLING_CONTENTS as group_field2 | rename CEK_EXTENSION_ID as group_field3 | eval _time=date(bucket,\"yyyyMMddHHmm\") | fields _time,bucket,_host,group_field1,group_field2,group_field3,RESULT_CODE,count | import example-code-1111",
      "is_enabled": true,
      "is_async": false
    }
  ]
}

• total_count (32비트 정수): 전체 스트림 쿼리 수
• stream_queries (배열): 페이징된 스트림 쿼리 목록
  • guid (문자열): 스트림 쿼리 GUID
  • name (문자열): 이름
  • description (문자열): 설명
  • source_type (문자열): 소스 타입 (table, logger, stream 중 하나)
  • sources (배열): 소스 목록
  • interval (32비트 정수): 새로고침 주기(초)
  • query_string (문자열): 쿼리문
  • is_enabled (불리언): 활성화 여부
  • is_async (불리언): 비동기 모드 여부

오류 응답

필수 매개변수가 누락된 경우

HTTP 상태코드 400 응답

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

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