Docs

Intelligent Data Insight

Dataset Open API

Dataset Model Canvas and Operations Tools API

1. Overview

This document introduces the Open API for dataset model canvas and operations tools, allowing users to view dataset model canvas information, refresh base table metadata, and perform other operations through the API.
Caution: Before using the APIs described in this document, you must complete the prerequisites of integrating JWT-Token and applying for a Token. Please first review the invocation method. For details, see Invocation Method.

2. View dataset model canvas information

Permission requirements.
Resource
Permission
Dataset
read
API description: Only view the model canvas information of the dataset, including the field selection status of upstream data source nodes used in the dataset, data source information, join relationships between data sources, and filter conditions of each data source.

Resource	Permission
Dataset	read

Request description

Request URL: {{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/model

Request example

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

Request parameters

Parameter	Type	Required	Enumeration values	Description
dataSetId	integer	Yes	123	Dataset ID

Response parameters

Parameter	Type	Description
$.nodeConf	list	Dataset model canvas information
$.nodeConf[i].tbName	string	Data source node table name
$.nodeConf[i].tableAlias	string	Data source node table alias
$.nodeConf[i].dbName	string	Data source node database name
$.nodeConf[i].dataSourceId	integer	Data source ID
$.nodeConf[i].clusterName	string	Data source cluster information
$.nodeConf[i].nodeId	string	Node ID of the data source in the canvas
$.nodeConf[i].nodeType	integer	Node type of the data source in the canvas
$.nodeConf[i].fields	list	Field information of the data source node
$.nodeConf[i].fields[i].type	string	Data source node field type
$.nodeConf[i].fields[i].name	string	Data source node field name
$.nodeConf[i].fields[i].alias	string	Data source node field alias -> Used when there are fields with the same name in multiple different data sources
$.nodeConf[i].fields[i].comment	string	Data source node field comment
$.nodeConf[i].fields[i].status	integer	Data source node field status
$.nodeConf[i].fields[i].isSelect	bool	Whether the data source node field is selected

Response example

{
    "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. Refresh base table metadata

Supported in version 58.1 and above.
Permission requirements
Resource
Permission
Dataset
admin
API description: Refreshes the keyword information of the base table corresponding to the extracted dataset. Supports refreshing sort keys and sample keys (not supported in SaaS environments).

Resource	Permission
Dataset	admin

Request description

Request URL: {{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/refreshDataTable

Request example

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

Response example

#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": "成功"
}

Last updated: 2026.07.06 17:03:29