数据集可视化查询参数 API--智能数据洞察 DataWind-火山引擎

文档中心

立即注册

导航

数据集可视化查询参数 API

最近更新时间：2025.09.17 19:37:26首次发布时间：2025.09.17 19:37:26

本文为您介绍的是“数据集可视化查询参数 API”，您将了解如何通过 API 进行查看和更新可视化查询参数配置。

功能概述

数据集可视化查询参数 API 支持用户通过 API 查看和更新数据集可视化查询参数配置。
功能入口如下：

进入「数据准备」-「数据集」界面，选择要配置可视化查询参数的数据集，右键选择「更多」，点击「可视化查询配置」。
进入「可视化查询配置」界面，为数据集配置相关可视化查询参数，包括推送、查询、默认设置等。

前提条件

在您使用本文所述的 API 前，还需完成接入 JWT-Token 和申请 Token 的前置操作，请先了解调用方式，详情可阅读调用方式。

查看数据集可视化查询参数配置

注意

用户需至少拥有数据集的查看权限。

请求说明

请求方式：GET
请求地址：{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/vqsParams

请求参数

参数	类型	是否必填	示例值	描述
dataSetId	integer	是	123	数据集ID，获取方式见资源 ID 获取方式

请求示例

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

返回参数

参数	类型	示例值	描述
detailedFields	bool	true
enableReportMonitor	bool	false	筛选搜索优化。true 为允许，false 为不允许，设为允许时，筛选器在精确搜索列表中，搜索数据项时优先走前端缓存
enableSubscription	bool	false	数据集订阅。true 为允许，false 为不允许，允许后，订阅数据集后，图表数据可在仪表盘订阅截图中显示，但会对集群产生压力
queryPartitionLimit	bool	true	自动查询。true 为允许，false 为不允许，允许后，在可视化查询界面允许自动触发查询，但会对集群产生压力
vqsAutoQuery	bool	true
vqs_auto_query	bool	true

返回示例

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

更新数据集可视化查询参数配置

注意

用户需至少拥有数据集的编辑权限。

请求说明

请求方式：PUT
请求地址：{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/vqsParams

请求参数

参数	类型	必选	描述
enableReportMonitor	string	是	新建监控允许后，该数据集可以新建监控，但会对集群产生压力
enableSubscription	bool	是	数据集订阅数据集首次创建后的默认回溯周期允许后，订阅数据集后，图表数据可在仪表盘订阅截图中显示，但会对集群产生压力
vqsAutoQuery	bool	是	自动查询允许后，在可视化查询界面允许自动触发查询，但会对集群产生压力
enableSearchOptimizationStrategy	bool	是	筛选搜索优化设为不允许会在列表中搜索数据项全量查最近30天的后端数据，保障数据完整性

请求示例

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
    }
}'

返回参数

参数	类型	必选	描述
enableReportMonitor	string	是	新建监控允许后，该数据集可以新建监控，但会对集群产生压力
enableSubscription	bool	是	数据集订阅数据集首次创建后的默认回溯周期允许后，订阅数据集后，图表数据可在仪表盘订阅截图中显示，但会对集群产生压力
vqsAutoQuery	bool	是	自动查询允许后，在可视化查询界面允许自动触发查询，但会对集群产生压力
enableSearchOptimizationStrategy	bool	是	筛选搜索优化设为不允许会在列表中搜索数据项全量查最近30天的后端数据，保障数据完整性

返回示例

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