DQL 데이터 비동기 쿼리¶
POST /api/v1/df/asynchronous/query_data
개요¶
Body 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| queries | array | 다중 명령 쿼리입니다. 내용은 query 객체로 구성된 리스트입니다. Null 허용: False |
|
| fieldTagDescNeeded | boolean | field 또는 tag 설명 정보 필요 여부 Null 허용: False |
파라미터 추가 설명¶
쿼리 설명
비동기 쿼리 최종 응답의 content.data[i].warnings[]에는
DQLDataAccessScopeRestricted가 포함될 수 있습니다.
details[0].metadata.namespace는 현 버전에서 고정값으로
logging입니다. restriction=partial은 권한이 있는 인덱스의 데이터만 반환함을 의미하고,
restriction=all은 관련 로그 인덱스에 모두 권한이 없어 빈 결과를 반환함을 의미합니다. HTTP 상태 코드와 요청 파라미터는 변경되지 않습니다.
- 파라미터 설명
| 파라미터명 | type | 필수 | 설명 |
|---|---|---|---|
| queries | array | Y | 다중 명령 쿼리입니다. 내용은 query 객체로 구성된 리스트입니다. |
| fieldTagDescNeeded | boolean | field 또는 tag 설명 정보 필요 여부 |
- queries[*] 멤버 파라미터 구조 설명
*** 참고: "DQL 데이터 쿼리" API에
async_id파라미터가 추가되었습니다. ***
| 파라미터명 | type | 필수 | 설명 |
|---|---|---|---|
async_id |
string | N | 비동기 쿼리 작업 ID입니다. 이 값은 이전 dql 쿼리 결과의 content.data[*].async_id에서 가져옵니다. 이전 쿼리 결과에 해당 값이 존재하면, 이번 쿼리에서 이 값을 포함해야 합니다. |
| qtype | string | Y | 쿼리문 유형입니다. dql: dql 유형 쿼리문을 의미합니다. promql: PromQl 유형 쿼리문을 의미합니다. |
| query | json | Y | 쿼리 구조입니다. |
| query.q | string | qtype 유형과 일치하는 쿼리문입니다. 예: dql 또는 promql 쿼리문 | |
| query.ignore_cache | boolean | 쿼리에서 캐시를 비활성화할지 여부입니다. 기본값은 false이며, 캐시를 사용함을 의미합니다. | |
| query.promqlType | enum | qtype=promql일 때 적용됩니다. promql의 쿼리 유형입니다.可选值 instantQuery 및 rangeQuery, 기본값은 rangeQuery입니다. |
|
| query.highlight | boolean | 강조 표시 데이터를 표시할지 여부입니다. | |
| query.timeRange | array | 시간 범위의 타임스탬프 리스트입니다. | |
| query.disableMultipleField | bool | 단일 열 모드를 활성화할지 여부입니다. 기본값은 true입니다. |
|
| query.showLabel | bool | 객체의 레이블을 표시할지 여부입니다. 기본값은 없음입니다. | |
| query.funcList | array | dql 반환값을 재집계하여 수정합니다. disableMultipleField=false인 경우 이 파라미터는 유효하지 않습니다. | |
| query.slimit | integer | 시계열 그룹 크기입니다. 메트릭 쿼리에만 유효합니다. | |
| query.soffset | integer | 시계열 그룹 오프셋입니다. | |
| query.limit | integer | 페이지 크기입니다. | |
| query.offset | integer | 페이지 오프셋입니다. | |
| query.orderby | array | 정렬 리스트입니다. {fieldName:method}. 메저먼트 쿼리의 정렬은 fieldName=time만 지원합니다. method는 ["desc", "asc"] 중 하나입니다. 메저먼트 쿼리의 정렬은 fieldName=time만 지원합니다. |
|
| query.sorderby | array | 정렬 리스트입니다. sorderby의 column은 표현식이며, 단일 값을 반환하는 모든 집계 함수(min, max, last, avg, p90, p95, count)를 지원합니다. {fieldName:method}, 구조는 orderby와 동일합니다. |
|
| query.order_by | array | 정렬 리스트입니다. 구조는 [{"column": "field", "order": "DESC"}]입니다. Doris 엔진 호환 필드입니다. | |
| query.sorder_by | array | 정렬 리스트입니다. 구조는 [{"column": "field", "order": "DESC"}]입니다. Doris 엔진 호환 필드입니다. | |
| query.density | string | 응답 점 밀도입니다. 우선순위는 autoDensity보다 낮고 dql 문에서 설정한 밀도보다 높습니다. | |
| query.interval | number | 시간 분할 간격입니다. Kodo int64 범위 내로 변환 가능하고 1ms 이상의 정수 밀리초인 양수만 허용됩니다. 기본 단위는 초이며, interval_unit을 통해 밀리초로 지정할 수 있습니다. | |
| query.interval_unit | string | interval의 단위입니다.可选值 s, ms, 기본값 s입니다. |
|
| query.search_after | array | 페이지 매김 쿼리 마커입니다. 동일 파라미터로 이전 요청 응답 결과의 search_after 값을 이번 요청의 파라미터로 사용합니다. | |
| query.maxPointCount | integer | 최대 포인트 수입니다. | |
| query.workspaceUUID | string | 쿼리할 워크스페이스의 UUID입니다. "*"는 모든 권한이 부여된 워크스페이스를 쿼리함을 의미합니다. 워크스페이스 참조 API /wksp_share/granted_ws_list를 확인하세요. | |
| query.workspaceUUIDs | array | 쿼리할 워크스페이스의 UUID 리스트입니다. 우선순위는 query.workspaceUUID보다 높습니다. ["*"]는 모든 권한이 부여된 워크스페이스를 쿼리함을 의미합니다. 워크스페이스 참조 API /wksp_share/granted_ws_list를 확인하세요. | |
| query.targetRegion | string | 쿼리 워크스페이스가 ["*"]로 지정된 경우, 이 필드는 필수입니다. | |
| query.output_format | string | lineprotocol: 라인 프로토콜 출력입니다. 기본적으로 입력하지 않으면 현재 출력 형식을 유지합니다. | |
| query.cursor_time | integer | 세그먼트 쿼리 임계값입니다. 첫 번째 세그먼트 쿼리에서는 cursor_time을 end_time으로 설정해야 합니다. 이후 세그먼트 쿼리에서는 cursor_time을 응답의 next_cursor_time으로 설정해야 합니다. | |
| query.cursor_token | string | 페이지 매김 쿼리 토큰(엔진이 cursor_token 값을 반환함)입니다. 페이지 매김 쿼리 시, 이전 쿼리에서 반환된 next_cursor_token을 이번 쿼리의 cursor_token으로 설정해야 합니다. cursor_token이 없는 요청은 페이지를 넘길 때 동일한 타임스탬프의 데이터가 건너뛰어질 수 있습니다. | |
| query.disable_sampling | bool | 샘플링 비활성화 스위치입니다. 기본값은 false입니다. | |
| query.disable_truncate | bool | 쿼리에서 반환 내용을 자를지 여부를 나타냅니다. 기본값은 없음입니다. |
- 응답 점 밀도
density파라미터 값 설명
| 선택 가능한 값 | 설명 |
|---|---|
| lower | 낮음, 60포인트 |
| low | 낮음, 180포인트 |
| medium | 중간, 360포인트 |
| high | 높음, 720포인트 |
-
밀도 파라미터의 우선순위에 유의하십시오. 최대 밀도
density[high]* maxPointCount > interval > density > dql 문의 제어 파라미터 -
일반적인 쿼리 설명
-
미복구 이벤트 쿼리 참고: openapi API를 통해 데이터를 쿼리할 때 기본 역할은 관리자입니다. 데이터 액세스 규칙 제한이 적용될 수 있으므로 주의하십시오.