예약된 쿼리 일괄 실행

지정된 여러 개의 예약된 쿼리를 실행합니다. 이 작업은 관리자 권한을 요구합니다. 이 작업은 일부 동작 실패를 허용합니다. 실행하지 못한 예약된 쿼리가 있으면 failures 매개변수에 해당 예약된 쿼리의 식별자와 실패 원인을 반환합니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -d guids="GUID1,GUID2,GUIDN" \
     -X POST https://HOSTNAME/api/sonar/scheduled-queries/run

요청 매개변수

• skip: 실행 중인 예약 쿼리가 있으면 실행하지 않습니다.
• restart: 실행 중인 예약 쿼리를 중지시키고 다시 실행합니다.

정상 응답

모두 성공

{
  "succeeded": 1,
  "failures": []
}

• succeeded (32비트 정수): 실행에 성공한 예약된 쿼리의 갯수, 이미 실행 되어있는 예약된 쿼리중 policy가 skip이어서 실행하지 않는 경우에는 포함되지 않습니다.
• failures (배열): 실행에 실패 한 예약된 쿼리의 오류
  • id (문자열): 예약된 쿼리의 GUID
  • reason (문자열): 오류 내용

일부 성공

실행 예시

curl -k -H "Authorization: Bearer API_KEY" \
     -d guids="0ff16aa8-dbc1-458a-9769-342de5cf9219,65c6c0d3-b8a4-49b3-b4ea-ddd0e321c221,b7007eb2-c1df-4d4d-84f1-5d0af91db25d" \
     -X POST https://HOSTNAME/api/sonar/scheduled-queries/run

응답 예시

{
  "succeeded": 2,
  "failures": [
    {
      "id": "0ff16aa8-dbc1-458a-9769-342de5cf9219",
      "reason": "scheduled-query-not-found"
    }
  ]
}

오류 응답

필수 매개변수가 존재하지 않는 경우

HTTP 상태코드 400 응답

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

식별자가 GUID 형식이 아닌 경우

HTTP 상태코드 400 응답

{
  "error_code": "invalid-param-type",
  "error_msg": "guids should be guid type."
}

예약된 쿼리가 존재하지 않는 경우

HTTP 상태코드 200 응답

{
  "succeeded": 0,
  "failures": [
    {
      "id": "0fb16ff8-dbc1-458a-9769-342de5cf9219",
      "reason": "scheduled-query-not-found"
    }
  ]
}

관리자 권한이 아닌 경우

HTTP 상태코드 500 응답

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