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 Multiple command queries, consisting of 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 Explanation
Parameter Name Type Required Description
queries array Y Multiple command queries, consisting of 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 previous dql query result; if this value exists in the previous query 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 qtype, such as dql or promql query statement
query.ignore_cache boolean Whether to disable cache for the query, default is false, indicating use of cache
query.promqlType enum Effective when qtype=promql, type of promql query, optional values instantQuery and rangeQuery, default value is rangeQuery
query.highlight boolean Whether to display highlighted data
query.timeRange array Timestamp list 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-aggregation to modify dql return value, note that when disableMultipleField=False, this parameter is invalid
query.slimit integer Time series group size, only effective for Metrics 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, sorderby's column is an expression, supports all aggregation functions that return a single value min max last avg p90 p95 count, {fieldName:method}, structure is 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 higher than density set in dql statement
query.interval integer Unit is seconds, time slice interval, used to calculate response points; calculated points less than or equal to points when density=high are valid, otherwise invalid
query.search_after array Pagination query marker. The search_after value from the previous request response result with the same parameters is used as the parameter for this request.
query.maxPointCount integer Maximum number of points
query.workspaceUUID string UUID of the workspace to query, "*" means query all authorized workspaces, refer to the interface /wksp_share/granted_ws_list for workspace reference
query.workspaceUUIDs array 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 workspace reference
query.targetRegion string When specifying the query workspace as ["*"], this field is mandatory
query.output_format string lineprotocol: line protocol output, if not filled, the existing output format remains unchanged by default
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 next_cursor_time in the response
query.cursor_token string Pagination query token (returned by the engine as cursor_token value): for pagination queries, the next_cursor_token returned from the previous 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 Low, 720 points

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

  • Common Query Explanations

  • Unrecovered Event Query Note: When using the openapi interface for data queries, the default role is administrator. Be aware that data access rules may apply.

Response