Skip to content

DQL Data Asynchronous Query


POST /api/v1/df/asynchronous/query_data

Overview

Body Request Parameters

Parameter Name Type Required Description
queries array Multi-command query, its content is a list composed of query objects
Allow empty: False
fieldTagDescNeeded boolean Whether field or tag description information is needed
Allow empty: False

Additional Parameter Notes

Query Description

  1. Parameter Description
Parameter Name type Required Description
queries array Y Multi-command query, its content is a list composed of query objects
fieldTagDescNeeded boolean Whether field or tag description information is needed
  1. Member Parameter Structure Description for queries[*] *** Note: The async_id parameter has been added based on the "DQL Data Query" interface ***
Parameter Name type Required Description
async_id string N Asynchronous query task ID; this value comes from the content.data[*].async_id in the previous DQL query result; if the last query returned this value, it must be included in the current query
qtype string Y Query statement type
dql: Indicates a DQL type query statement;
promql: Indicates a PromQl type query statement
query json Y Query structure
query.q string Query statement consistent with the qtype, such as a DQL or PromQL query statement
query.ignore_cache boolean Whether to disable cache during the query, default is false, meaning use cache
query.promqlType enum Effective when qtype=promql, PromQL query type, optional values are instantQuery and rangeQuery, default value is rangeQuery
query.highlight boolean Whether to display highlighted data
query.timeRange array List of timestamps for time range
query.disableMultipleField bool Whether to enable single-column mode, default is true
query.showLabel bool Whether to display object labels, default is none
query.funcList array Re-aggregates the return values of DQL, note that this parameter is invalid when disableMultipleField=False
query.slimit integer Time series grouping size, only effective for metrics queries
query.soffset integer Time series grouping offset
query.limit integer Pagination size
query.offset integer Pagination offset
query.orderby array Sorting list, {fieldName:method} , note that sorting for measurements only supports fieldName=time; method in ["desc", "asc"]; note that sorting for measurements only supports fieldName=time
query.sorderby array Sorting list, columns in sorderby are expressions, all aggregation functions that return a single value are supported: min max last avg p90 p95 count, {fieldName:method}, structure is the same as orderby
query.order_by array Sorting list, structure is [{"column": "field", "order": "DESC"}], Doris engine compatible field
query.sorder_by array Sorting list, structure is [{"column": "field", "order": "DESC"}], Doris engine compatible field
query.density string Response point density, priority less than autoDensity and greater than density set in DQL statement
query.interval integer Unit is seconds, time slice interval used to calculate the number of response points; if the calculated number of points is less than or equal to the number of points when density=high, then it is valid, otherwise it is invalid
query.search_after array Pagination query marker. Use the search_after value from the response of the previous request with identical parameters as the parameter for the current request.
query.maxPointCount integer Maximum number of points
query.workspaceUUID string UUID of the workspace to be queried
query.workspaceUUIDs array UUIDs of the workspaces to be queried, higher priority than query.workspaceUUID.
query.output_format string lineprotocol: output in line protocol format, default keeps existing output format unchanged if not specified
query.cursor_time integer Segment query threshold: Set cursor_time to end_time during the first segment query; for subsequent segment queries, set cursor_time to the next_cursor_time in the response.
query.cursor_token string Pagination query token (value returned by the Guance select engine as cursor_token): During pagination queries, set the cursor_token from the previous query response as the cursor_token for the current query; requests without cursor_token may cause data with the same timestamp to be skipped when flipping pages.
query.disable_sampling bool Sampling disable switch, default value is false
  1. Description of Response Point Density density Parameter Values
Optional Value Description
lower Low, 60 points
low Lower, 180 points
medium Medium, 360 points
high Higher, 720 points

  • Note the priority of the point density parameter, maximum density density[high] * maxPointCount > interval > density > control parameters in the DQL statement

  • Common Query Descriptions

  • Unrecovered Event Query Note: When performing data queries using the OpenAPI interface, the default role is Administrator. Be aware that data access rules may apply restrictions.

Response

Feedback

Is this page helpful? ×