예약된 쿼리 목록 조회

검색 조건과 일치하는 예약된 쿼리 목록을 조회합니다. 이 작업은 관리자 권한을 요구합니다.

HTTP 요청

cURL 예시

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

요청 매개변수

정상 응답

아래는 예약된 쿼리 목록 중 일부입니다.

{
  "total_count": 15,
  "scheduled_queries": [
    {
      "guid": "95e17283-1d08-44f0-bac7-b734813d2dcd",
      "name": "test",
      "description": "",
      "enabled": false,
      "node_types": null,
      "query": "json \"{}\"",
      "output_parameter": false,
      "trigger_type": "cron",
      "cron_schedule": "* * * * *",
      "preceding_guid": null,
      "preceding_name": null,
      "preceding_action": null,
      "running_state": null,
      "result_state": null,
      "elapsed_time": null,
      "last_run_time": null,
      "last_failure_time": null,
      "last_failure_reason": null,
      "created": "2023-09-18 16:12:44+0900",
      "updated": "2023-09-18 16:12:44+0900"
    }
  ]
}

• total_count (32비트 정수): 검색 조건과 일치하는 전체 예약된 쿼리의 갯수
• scheduled_queries (배열): 페이징된 예약된 쿼리 목록
  • guid (문자열): 예약된 쿼리의 GUID
  • name (문자열): 이름
  • description (문자열): 설명
  • enabled (불리언): 활성화 여부
  • node_types (배열): 실행 위치(control: 분석 노드, data: 수집 노드)
  • query (문자열): 쿼리문
  • output_parameter (불리언): 쿼리 매개변수 출력 제어 여부
  • trigger_type (문자열): 실행 방식(cron: 예약 실행, workflow: 다른 쿼리의 결과에 따라 실행)
  • cron_schedule (문자열): (trigger_type이 cron일 때) CRON 문법으로 작성된 실행 일정
  • preceding_guid (문자열): (trigger_type이 workflow일 때) 선행 예약된 쿼리의 GUID
  • preceding_name (문자열): (trigger_type이 workflow일 때) 선행 예약된 쿼리의 이름
  • preceding_action (문자열): (trigger_type이 workflow일 때) 선행 예약된 쿼리의 실행 결과(succeeded: 성공, failed: 실패, finished: 실행 완료)
  • elapsed_time (32비트 정수): 실행 시간(단위: 밀리초)
  • running_state (문자열): 실행 상태(running: 실행 중, stopping: 중지하는 중, finished: 완료, canceled: 취소됨)
  • result_state (문자열): 실행 결과(succeeded: 성공, failed: 실패, , canceled: 취소)
  • last_run_time (문자열): 최근 실행 시각 (yyyy-MM-dd HH:mm:ssZ 형식)
  • last_failure_time (문자열): 최근 실패 시각 (yyyy-MM-dd HH:mm:ssZ 형식)
  • last_failure_reason (문자열): 쿼리 실행에 실패한 원인
  • created (문자열): 생성일시 (yyyy-MM-dd HH:mm:ssZ 형식)
  • updated (문자열): 수정일시 (yyyy-MM-dd HH:mm:ssZ 형식)

오류 응답

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