Dataset Open API provides APIs for dataset-related operations, allowing you to flexibly invoke dataset APIs through open capabilities. Dataset Open API mainly includes: dataset operation APIs, dataset information APIs, dataset synchronization task APIs, dataset visualization query parameter APIs, dataset model canvas and operations and maintenance tool APIs, project dataset tags and folders APIs, project dataset and data source APIs, and project cluster configuration APIs. This document provides a brief introduction to Dataset Open API. Other APIs will be introduced in separate documents.
Caution: Before you start using the interfaces described in this document, please first learn about the Invocation Method.
{{variable}} format can be directly recognized by Postman.Variable meaning reference table:
jwtToken -> {{jwtToken}} aeolus 域名 -> {{domain}} 项目 ID -> {{appId}} 数据集 ID -> {{dataSetId}} 数据集标签 Id {{tagId}} 数据集文件夹 Id {{dataSetFolderId}}
Applicable product version for this document: 2.48.0 and above
API type | API description | Detailed documentation |
|---|---|---|
Dataset operation APIs | Users can use the APIs to update, move, and delete datasets, check datasets and move them to the recycle bin, and perform other operations. | |
Dataset information APIs | Users can use the APIs to view the basic information on the dataset details page and edit page, update basic information, set tags, and perform other operations. | |
Dataset synchronization task APIs | Users can use the APIs to view and update dataset synchronization task settings, submit a backtracking task for dataset synchronization, and terminate dataset synchronization task instances, among other operations. | |
Dataset visualization query parameter APIs | Users can view and update visualization query parameter configurations through the API. | |
Dataset model canvas and operations and maintenance tool APIs | Users can view the dataset model canvas and perform operations such as refreshing base table metadata through the API. | |
Project dataset APIs | Users can use the API to retrieve, create, and update information about datasets and folders within a project, as well as to retrieve, add, or remove users from the write user list of a private cluster. |