数据集模型画布与运维类工具 API--智能数据洞察 DataWind-火山引擎

文档中心

智能数据洞察 DataWind

数据集 Open API

数据集模型画布与运维类工具 API

1. 概述

本文为您介绍的是“数据集模型画布类与运维类工具的 Open API”，您将了解到用户可以通过 API 进行查看数据集模型画布与地表元数据刷新等操作。
注意：在您使用本文所述的 API 前，还需完成接入 JWT-Token 和申请 Token 的前置操作，请先了解调用方式，详情可阅读调用方式。

2. 查看数据集模型画布信息

权限需求。
资源
权限
数据集
read
接口描述与说明：仅查看数据集的模型画布信息，包含数据集中使用到的上游数据源节点的字段勾选情况，数据源信息；各数据源之间的 join 关系，数据源自身的筛选条件等。

资源	权限
数据集	read

请求说明

请求地址：{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/model

请求示例

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

请求参数

参数	类型	必选	枚举值	描述
dataSetId	integer	是	123	数据集 ID

返回参数

参数	类型	描述
$.nodeConf	list	数据集模型画布信息
$.nodeConf[i].tbName	string	数据源节点表名
$.nodeConf[i].tableAlias	string	数据源节点表别名
$.nodeConf[i].dbName	string	数据源节点库名
$.nodeConf[i].dataSourceId	integer	数据源 ID
$.nodeConf[i].clusterName	string	数据源集群信息
$.nodeConf[i].nodeId	string	数据源在画布中的节点 ID
$.nodeConf[i].nodeType	integer	数据源在画布中的节点类型
$.nodeConf[i].fields	list	数据源节点的字段信息
$.nodeConf[i].fields[i].type	string	数据源节点字段类型
$.nodeConf[i].fields[i].name	string	数据源节点字段名称
$.nodeConf[i].fields[i].alias	string	数据源节点字段别称 -> 应对多不同数据源有重名字段时
$.nodeConf[i].fields[i].comment	string	数据源节点字段注释
$.nodeConf[i].fields[i].status	integer	数据源节点字段状态
$.nodeConf[i].fields[i].isSelect	bool	数据源节点字段是否被勾选

返回示例

{
    "code": "aeolus/ok",
    "data": {
        "dagTagConf": {
            "dimTbNodes": []
        },
        "linkConf": [],
        "nodeConf": [
            {
                "clusterName": "cn",
                "dataSourceId": 2****,
                "dataSourceType": "ch_excel",
                "dbName": "aeolus_excel_upload_aeolus_toy",
                "displayDbName": "配比四刷-v4",
                "fields": [
                    {
                        "alias": "`字段四`",
                        "comment": null,
                        "isDynamicPartition": false,
                        "isSelect": true,
                        "isSourceTableField": false,
                        "name": "字段四",
                        "prepType": "string",
                        "status": 0,
                        "type": "Nullable(String)"
                    },
                    {
                        "alias": "`字段一`",
                        "comment": null,
                        "isDynamicPartition": false,
                        "isSelect": true,
                        "isSourceTableField": false,
                        "name": "字段一",
                        "prepType": "string",
                        "status": 0,
                        "type": "Nullable(String)"
                    },
                    {
                        "alias": "`字段三`",
                        "comment": null,
                        "isDynamicPartition": false,
                        "isSelect": true,
                        "isSourceTableField": false,
                        "name": "字段三",
                        "prepType": "string",
                        "status": 0,
                        "type": "Nullable(String)"
                    },
                    {
                        "alias": "`字段二`",
                        "comment": null,
                        "isDynamicPartition": false,
                        "isSelect": true,
                        "isSourceTableField": false,
                        "name": "字段二",
                        "prepType": "string",
                        "status": 0,
                        "type": "Nullable(String)"
                    }
                ],
                "fileId": "13***",
                "fullOption": false,
                "hiveOwner": "userEmailPrefix",
                "lastDdlTime": "2022-12-13 12:49:00",
                "metadataLink": "https://data.bytedance.net/coral/datamap/detail/table_info/clickhouse/aeolus_excel_upload_aeolus_toy/table_4f0cc551_9dfa_4915_****_***********#group=default",
                "nodeId": "77b3df39-834c-****-****-************",
                "nodeType": "table",
                "params": {
                    "extractType": "{\"key\":\"full\"}"
                },
                "partitionConfList": [],
                "query": "",
                "schemaName": "Sheet1",
                "tableAlias": "table_4f0cc551_9dfa_****_****_*********",
                "tableRowFilter": {},
                "tbId": "cn//aeolus_excel_upload_aeolus_toy//table_4f0cc551_9dfa_4915_a38******",
                "tbName": ""table_4f0cc551_9dfa_****_****_*********"
            }
        ],
        "parseEngine": 0,
        "whereConf": {
            "nodeRowFilter": {},
            "requiredRowFilter": []
        }
    },
    "msg": "成功"
}

3. 底表元数据刷新

支持版本 58.1 版本及以上。
权限需求
资源
权限
数据集
admin
接口描述与说明：刷新抽取数据集对应底表的关键字信息，支持刷新排序键、抽样键 (saas 环境不支持）

资源	权限
数据集	admin

请求说明

请求地址：{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/refreshDataTable

请求示例

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

返回示例

#data为更新后的关键字信息
{
    "code": "aeolus/ok",
    "data": {{"sample_key": "row_id_kmtq3k", "source_type": "Normal", "cnch_vw_default": "aeolus-turtle-lambda-default", "cnch_vw_write": "aeolus-turtle-lambda-write", "primary_key_list": ["row_id_km****"], "shard_key": "row_id_km****"}},
    "msg": "成功"
}

最近更新时间：2025.09.17 19:37:28

这个页面对您有帮助吗？

有用

无用