Skip to content

DQL Data Asynchronous Query


POST /api/v1/df/asynchronous/query_data

Overview

Body Request Parameters

Parameter 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 Additional Description

Query Description

  1. Parameter Description
Parameter 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 Description *** Note, the async_id parameter has been added based on the "DQL Data Query" interface ***
Parameter 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 result, it needs to be included in this query
qtype string Y The type of query statement
dql: indicates DQL type query statement;
promql: indicates PromQl type query statement
query json Y Query structure
query.q string The query statement consistent with the qtype, such as DQL or PromQL query statement
query.ignore_cache boolean Whether the query disables caching, default is false, indicating using cache
query.promqlType enum Effective when qtype=promql, the 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 of 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-aggregate to modify DQL return values, note that when disableMultipleField=Flse, 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 aggregate 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 less than autoDensity and greater than the density set in the DQL statement
query.interval integer Unit is seconds, time slice interval, used to calculate response points; if the calculated points are less than or equal to the points when density=high, it is valid, otherwise invalid
query.search_after array Pagination query marker. The search_after value in the response result of the last request with the same parameters is used as the parameter for this request.
query.maxPointCount integer Maximum points
query.workspaceUUID string The uuid of the workspace to be queried, "*" means query all authorized spaces, refer to the interface /wksp_share/granted_ws_list for viewable spaces
query.workspaceUUIDs array The uuids of the workspaces to be queried, priority is higher than query.workspaceUUID. ["*"] means query all authorized spaces, refer to the interface /wksp_share/granted_ws_list for viewable spaces
query.targetRegion string When the query workspace is specified as ["*"], this field is required
query.output_format string lineprotocol: line protocol output, if not filled, the default 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 (returned by the engine cursor_token value): for pagination queries, the next_cursor_token returned by 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 Description
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 the DQL statement

  • Common Query Descriptions

  • Unrecovered Incident Query Note: When performing data queries through the openapi interface, the default role is administrator. Note that it may be subject to data access rule restrictions

Response

Feedback

Is this page helpful? ×