Docs

Intelligent Data Insight

Visual Query

Dataset Visualization Query Parameter API

This document introduces the "Dataset Visualization Query Parameter API" and explains how to view and update visualization query parameter configurations through the API.

Feature overview

The Dataset Visualization Query Parameter API allows users to view and update dataset visualization query parameter configurations via the API.
The entry point for this feature is as follows:

Go to the "Data Preparation" - "Dataset" page, select the dataset for which you want to configure visualization query parameters, right-click and select "More", then click "Visualization Query Configuration".
On the "Visualization Query Configuration" page, configure the relevant visualization query parameters for the dataset, including push, query, default settings, and so on.

Prerequisites

Before using the API described in this document, you must complete the steps for integrating JWT-Token and applying for a Token. Please review the invocation method first. For details, see Invocation Method.

View dataset visualization query parameter configuration

warning

The user must have at least permission to view the dataset.

Request description

Request method: GET
Request URL: {{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/vqsParams

Request parameters

Parameter	Type	Required	Example value	Description
dataSetId	integer	Yes	123	Dataset ID. For information on how to obtain it, see How to Obtain Resource IDs

Request example

curl --location --request GET '{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/vqsParams' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{jwtToken}}'

Response parameters

Parameter	Type	Example value	Description
detailedFields	bool	true
enableReportMonitor	bool	false	Filter search optimization. If set to true, the filter will prioritize using the front-end cache when searching for data items in the exact search list; if set to false, this is not allowed.
enableSubscription	bool	false	Dataset subscription. If set to true, after subscribing to the dataset, chart data can be displayed in dashboard subscription snapshots, but this may put pressure on the cluster; if set to false, this is not allowed.
queryPartitionLimit	bool	true	Auto query. If set to true, automatic query triggering is allowed in the visualization query interface, but this may put pressure on the cluster; if set to false, this is not allowed.
vqsAutoQuery	bool	true
vqs_auto_query	bool	true

Response example

{
    "code": "aeolus/ok",
    "data": {
        "detailedFields": [],
        "enableReportMonitor": true,
        "enableSubscription": true,
        "queryPartitionLimit": null,
        "vqsAutoQuery": true,
        "vqs_auto_query": true
    },
    "msg": "成功"
}

Update dataset visualization query parameter configuration

warning

The user must have at least permission to edit the dataset.

Request description

Request method: PUT
Request URL: {{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/vqsParams

Request parameters

Parameter	Type	Required	Description
enableReportMonitor	string	Yes	Create a monitor When enabled, this dataset can create a monitor, but this will put pressure on the cluster.
enableSubscription	bool	Yes	The default lookback period after the dataset subscription is created for the first time. When enabled, after subscribing to the dataset, chart data can be displayed in the dashboard subscription screenshot, but this will put pressure on the cluster.
vqsAutoQuery	bool	Yes	Automatic query When enabled, the visual query interface allows automatic query triggering, but this will put pressure on the cluster.
enableSearchOptimizationStrategy	bool	Yes	Filter search optimization If not enabled, searching for data items in the list will perform a full query of the backend data for the last 30 days to ensure data integrity.

Request example

curl --location --request PUT '{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/vqsParams' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{jwtToken}}' \
--data-raw '{
    "vqsParams": {
        "vqsAutoQuery": false,
        "enableSubscription": false,
        "enableReportMonitor": false,
        "enableSearchOptimizationStrategy": false
    }
}'

Response parameters

Parameter	Type	Required	Description
enableReportMonitor	string	Yes	Create a monitor When enabled, this dataset can create a monitor, but this will put pressure on the cluster.
enableSubscription	bool	Yes	The default lookback period after the dataset subscription is created for the first time. When enabled, after subscribing to the dataset, chart data can be displayed in the dashboard subscription screenshot, but this will put pressure on the cluster.
vqsAutoQuery	bool	Yes	Automatic query When enabled, the visual query interface allows automatic query triggering, but this will put pressure on the cluster.
enableSearchOptimizationStrategy	bool	Yes	Filter search optimization If not enabled, searching for data items in the list will perform a full query of the backend data for the last 30 days to ensure data integrity.

Response example

{
    "code": "aeolus/ok",
    "data": null,
    "msg": "成功"
}

Last updated: 2026.07.06 17:03:29

Intelligent Data Insight

Request description #

Request parameters #

Request example #

Response parameters #

Response example #

Request description #

Request parameters #

Request example #

Response parameters #

Response example #

Request description

Request parameters

Request example

Response parameters

Response example

Request description

Request parameters

Request example

Response parameters

Response example