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

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

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

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

请求说明 #

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

请求参数 #

请求示例 #

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

返回参数 #

返回示例 #

{
    "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

请求参数 #

请求示例 #

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

返回参数 #

返回示例 #

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