Skip to content

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 composed of query objects
Allow null: False
fieldTagDescNeeded boolean Whether field or tag description information is needed
Allow null: False

Additional Parameter Description

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. Structure Description of queries[*] Member Parameters
Parameter Name type Required Description
qtype string Y The type of the query statement
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 type, such as a dql or promql query statement
query.ignore_cache boolean Whether the query disables caching, default is false, indicating use of cache
query.promqlType enum Effective 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 List of timestamps for the time range
query.disableMultipleField bool Whether single-column mode is enabled, default is true
query.showLabel bool Whether object labels are displayed, default is none
query.funcList array Aggregates and modifies 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 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 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 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 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 previous response with identical parameters as the parameter for this 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: Line protocol output, if not filled by default, the existing output format remains unchanged
query.cursor_time integer Segment query threshold: When performing the first segment query, cursor_time should be set to end_time; for subsequent segment queries, cursor_time should be set to next_cursor_time in the response
query.cursor_token string Pagination query token (value returned by the Guance select engine cursor_token): During pagination queries, the next_cursor_token returned from the previous query should be set as cursor_token for this query; requests without cursor_token may cause data with the same timestamp to be skipped during page flipping.
query.disable_sampling bool Sampling disable switch, default value is false
  1. Description of the density Parameter Values for Response Point Density
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 DQL statements

  • 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 might restrict access.

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": "guancedb",
                "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"
}