DQL Data Query¶

POST /api/v1/df/query_data_v1

Overview¶

DQL Data Query

Body Request Parameters¶

Parameter Name	Type	Required	Description
queries	array		Multi-command query, its 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 Description¶

Query Description

Parameter Description

Parameter Name	type	Required	Description
queries	array	Y	Multi-command query, its content is a list of query objects
fieldTagDescNeeded	boolean		Whether field or tag description information is needed

queries[*] Member Parameter Structure Description

Parameter Name	type	Required	Description
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 cache, default is false, meaning cache is used
query.promqlType	enum		Takes effect when qtype=promql, promql query type, 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 to modify DQL return values, note: when disableMultipleField=False, this parameter is invalid
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: sorting for measurement queries only supports fieldName=time; method in ["desc", "asc"]; note: sorting for measurement queries only supports fieldName=time
query.sorderby	array		Sorting list, the column of sorderby is an expression, supports all aggregation functions returning 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 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. Use the search_after value from the last request's response result with the same parameters 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 required
query.output_format	string		lineprotocol: line protocol output, if not filled by default, 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 the next_cursor_time in the response
query.cursor_token	string		Pagination query token (returned by the engine as the cursor_token value): during pagination query, 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

Response Point Density density Parameter Value Description

Optional Value	Description
lower	Lower, 60 points
low	Low, 180 points
medium	Medium, 360 points
high	High, 720 points

Note the priority of point density parameters, maximum density density[high] * maxPointCount > interval > density > control parameters in the DQL statement
Common Query Descriptions
Unrecovered Event Query

Note: When the openapi interface performs data queries, the default role is administrator. Note that it may be subject to data access rule restrictions.

Request Example¶

curl 'https://openapi.truewatch.com/api/v1/df/query_data_v1' \
-H 'Content-Type: application/json' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw $'{"queries":[{"qtype":"dql","query":{"q":"M::`cpu`:(avg(`usage_idle`))","_funcList":[],"funcList":[],"maxPointCount":720,"interval":10,"align_time":true,"sorder_by":[{"column":"`#1`","order":"DESC"}],"slimit":20,"disable_sampling":false,"timeRange":[1708911106000,1708912906999],"tz":"Asia/Shanghai"}}]}' \
--compressed

Response¶

{
    "code": 200,
    "content": {
        "data": [
            {
                "async_id": "",
                "column_names": [
                    "avg(usage_idle)"
                ],
                "complete": false,
                "cost": "14.815745ms",
                "index_name": "",
                "index_names": "",
                "index_store_type": "",
                "interval": 10000,
                "is_running": false,
                "max_point": 181,
                "next_cursor_time": -1,
                "points": null,
                "query_parse": {
                    "fields": {
                        "avg(usage_idle)": "usage_idle"
                    },
                    "funcs": {
                        "avg(usage_idle)": [
                            "avg"
                        ]
                    },
                    "namespace": "metric",
                    "sources": {
                        "cpu": "exact"
                    }
                },
                "query_type": "example_db",
                "sample": 1,
                "scan_completed": false,
                "scan_index": "",
                "series": [
                    {
                        "columns": [
                            "time",
                            "avg(usage_idle)"
                        ],
                        "name": "cpu",
                        "units": [
                            null,
                            null
                        ],
                        "values": [
                            [
                                1708912900000,
                                75.68748278863335
                            ],
                            [
                                1708912890000,
                                80.20737341208
                            ],
                            [
                                1708912880000,
                                73.23943236630001
                            ],
                            [
                                1708912870000,
                                71.08465385756001
                            ],
                            [
                                1708912860000,
                                75.12657005472002
                            ],
                            [
                                1708912850000,
                                84.19848645072001
                            ],
                            [
                                1708912840000,
                                81.59161169702
                            ],
                            [
                                1708912830000,
                                77.14274451154
                            ]
                        ]
                    }
                ],
                "window": 10000
            }
        ],
        "declaration": {
            "b": [
                "asfawfgajfasfafgafwba",
                "asfgahjfaf"
            ],
            "business": "aaa",
            "organization": "6540c09e4243b300077a9675"
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "10888927517520616916"
}