Skip to content

DQL Asynchronous Data Query


POST /api/v1/df/asynchronous/query_data

Overview

Body Request Parameters

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

Parameter Supplementary Explanation

Query Explanation

  1. Parameter Description
Parameter Name type Required Description
queries array Y Multi-command queries, the content is a list of query objects
fieldTagDescNeeded boolean Whether field or tag description information is needed
  1. queries[*] Member Parameter Structure Explanation *** 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 last DQL query result; if this value exists in the last query return result, it needs to be included in this query.
qtype string Y Type of query statement
dql: indicates DQL type query statement;
promql: indicates PromQL type query statement
query json Y Query structure
query.q string Query statement consistent with the qtype, e.g., DQL or PromQL query statement.
query.ignore_cache boolean Whether the query disables caching, default is false, meaning use cache.
query.promqlType enum Effective when qtype=promql, the query type for PromQL, optional values instantQuery and rangeQuery, default value is rangeQuery.
query.highlight boolean Whether to display highlighted data.
query.timeRange array Timestamp list for the 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-aggregation modifies the DQL return value. Note: this parameter is invalid when disableMultipleField=False.
query.slimit integer Time series group size, only valid for metric queries.
query.soffset integer Time series group offset.
query.limit integer Pagination size.
query.offset integer Pagination offset.
query.orderby array Sorting list, {fieldName:method}, note that sorting for measurement queries only supports fieldName=time; method in ["desc", "asc"]; note that sorting for measurement queries only supports fieldName=time.
query.sorderby array Sorting list, the column for sorderby is an expression, supports all aggregation functions returning a single value min max last avg p90 p95 count, {fieldName:method}, structure consistent with orderby.
query.order_by array Sorting list, structure is [{"column": "field", "order": "DESC"}], doris engine compatibility field.
query.sorder_by array Sorting list, structure is [{"column": "field", "order": "DESC"}], doris engine compatibility field.
query.density string Response point density, priority is lower than autoDensity and greater than the density set in the 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, it is valid, otherwise invalid.
query.search_after array Pagination query marker. The search_after value from the last request's response result with the same parameters is used as the parameter for this request.
query.maxPointCount integer Maximum number of points.
query.workspaceUUID string The uuid of the workspace to query, "*" means query all authorized workspaces, refer to the interface /wksp_share/granted_ws_list for viewable workspaces.
query.workspaceUUIDs array The uuids of the workspaces to query, priority is higher than query.workspaceUUID. ["*"] means query all authorized workspaces, refer to the interface /wksp_share/granted_ws_list for viewable workspaces.
query.targetRegion string When the specified query workspace is ["*"], this field is mandatory.
query.output_format string lineprotocol: line protocol output, if not filled by default, the existing output format remains unchanged.
query.cursor_time integer Segmented query threshold: for the first segmented query, cursor_time needs to be set to end_time; for subsequent segmented queries, cursor_time needs to be set to the next_cursor_time in the response.
query.cursor_token string Pagination query token (the value of cursor_token returned by the engine): during pagination queries, the next_cursor_token returned from the last query needs to be set as the cursor_token for this query; requests without cursor_token may cause data with the same timestamp to be skipped during pagination.
query.disable_sampling bool Sampling disable switch, default value is false.
  1. Response Point Density density Parameter Value Explanation
Optional Value Description
lower Lower, 60 points
low Low, 180 points
medium Medium, 360 points
high High, 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 Explanations

  • Unrecovered Event Query Note: When using the openapi interface for data queries, the default role is Administrator. Note that data access rule restrictions may apply.

Response

Feedback

Is this page helpful? ×