You need to enable JavaScript to run this app.
导航
数据集 Open API 概述
最近更新时间:2025.01.10 19:21:52首次发布时间:2021.02.23 10:42:04
我的收藏
有用
有用
无用
无用

1. 概述

数据集 Open API 提供与数据集相关操作的 API,您可以通过开放能力实现灵活调用数据集。数据集 Open API 主要包含:数据集操作 API、数据集信息 API、数据集同步任务 API、数据集可视化查询参数 API、数据集模型画布与运维类工具 API、项目数据集标签与文件夹 API、项目数据集与数据源 API、项目集群配置 API。本文为您简单介绍数据集 Open API 的情况,其余 API 将为您单独成文介绍。
注意:在您开始使用本文介绍的接口之前,请先了解调用方式

2. 所有数据集接口介绍
  • 新接口 V4 版本采用标准的 restful 接口命名方式,即资源+行为的命名方式。
  • 文档的划分按照资源为主体,需要对某个资源做什么操作,就在对应的文档下找到对应的行为 API。
  • 针对每个接口提供直接可以导入 postMan 的 cURL 示例,方便客户体验,由于各环境 DataWind 域名和各个请求中都含有通用含义的变量,因此各接口的 cURL 实例中均采用{{}}包裹变量,{{变量}}格式可直接被 postMan 识别。

变量对照含义表:

jwtToken -> {{jwtToken}}
aeolus 域名 -> {{domain}} 
项目 ID -> {{appId}} 
数据集 ID -> {{dataSetId}} 
数据集标签 Id {{tagId}}
数据集文件夹 Id {{dataSetFolderId}}

本文适用的产品版本: 2.48.0及以上

接口类型

接口介绍

详情文档

数据集操作 API

用户可以通过 API 进行创建、更新、移动、删除数据集,检查并移入数据集至回收站等操作。

点击查看

数据集信息 API

用户可以通过 API 进行查看数据集详情页、编辑页的基础信息以及更新基础信息、设置标签等操作。

点击查看

数据集同步任务 API

用户可以通过 API 进行查看、更新数据集同步任务设置,提交数据集同步任务回溯以及终止数据集同步任务实例等操作。

点击查看

数据集可视化查询参数 API

用户可以通过 API 进行查看、更新可视化查询参数配置。

点击查看

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

用户可以通过 API 进行查看数据集模型画布与地表元数据刷新等操作。

点击查看

项目内数据集 API

用户可以通过 API 进行获取、创建、更新项目下相关数据集信息和文件夹信息,获取、新增、删除私有集群写入用户列表等操作。

点击查看