쿼리
로그프레소 쿼리를 실행하여 완료될 때까지 대기한 후 쿼리 결과를 조회합니다. 장시간 소요되는 쿼리의 경우 클라이언트 설정에 따라 타임아웃이 발생할 수 있으므로 커서 생성 API를 사용하는 것을 권장합니다. HTTP 연결을 끊는 경우 실행하던 쿼리는 즉시 취소됩니다.
HTTP 요청
GET /api/sonar/query
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
"https://HOSTNAME/api/sonar/query?q=system+tables"
요청 매개변수
키 | 필수 | 타입 | 설명 | 비고 |
---|---|---|---|---|
q | O | 문자열 | 로그프레소 쿼리 문자열 | |
offset | X | 64비트 정수 | 건너뛸 갯수 | 최소 0 . 기본값 0 |
limit | X | 64비트 정수 | 최대 갯수 | 최소 0 . 미지정 시 전체 조회 |
fields | X | 문자열 | 출력 필드 이름 목록 | 쉼표(, )로 구분 |
format | X | 문자열 | 출력 형식 | html , xml , csv , json 중 하나 |
정상 응답
아래는 system tables | fields table
쿼리의 응답 예시입니다. Accept
헤더에 text/html
이 주어진 경우에는 HTML 형식으로 출력하고, 그 외의 경우에는 개행으로 구분된 JSON 형식으로 출력합니다.
{"table":"sonar_event_00001"}
{"table":"sonar_raw_event_00001"}
오류 응답
쿼리 매개변수가 누락된 경우
HTTP 상태 코드 400
응답
{
"error_code": "null-argument",
"error_msg": "q should be not null"
}
쿼리가 잘못된 경우
HTTP 상태 코드 400
응답
{
"error_code": "invalid-query",
"error_msg": "(10200) missing-json-quotation"
}
offset, limit 값이 정수가 아닌 경우
HTTP 상태 코드 400
응답
{
"error_code": "invalid-argument",
"error_msg": "offset should be long type."
}
offset, limit 값이 음수인 경우
HTTP 상태 코드 400
응답
{
"error_code": "invalid-argument",
"error_msg": "offset should be non-negative integer."
}
format 값이 잘못 지정된 경우
HTTP 상태 코드 400
응답
{
"error_code": "invalid-argument",
"error_msg": "format should be html, xml, csv, or json."
}