数据集 Open API 包含了：数据集操作 API、数据集信息 API、数据集维度指标与血缘关系 API、数据集同步任务 API、数据集可视化查询参数与开放查询 API、数据集模型画布与运维类工具 API、项目内数据集 API。
本文为您介绍的是“数据集操作类的 Open API”，您将了解到用户可以通过 API 进行创建、更新、移动、删除数据集，检查并移入数据集至回收站等操作。
注意：在您使用本文所述的 API 前，还需完成接入 JWT-Token 和申请 Token 的前置操作，详情可阅读数据集 Open API 概述。

• 新接口 V4 版本采用标准的 restful 接口命名方式，即资源+行为的命名方式。
• 针对每个接口提供直接可以导入 postMan 的 cURL 示例，方便客户体验，由于各环境 DataWind 域名和各个请求中都含有通用含义的变量，因此各接口的 cURL 实例中均采用{{}}包裹变量，{{变量}}格式可直接被 postMan 识别。
• 变量对照含义表：

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

• 本功能适用的版本: 2.48.0及以上

3.1 检查数据集是否可被移入回收站

• 权限需求

  资源	权限
  数据集	admin

• 接口描述与说明检查当前数据集是否存在血缘关联及其他问题，如无问题则返回空列表，表示当前可以直接删除，否则按照接口返回内容进行血缘解绑。

请求说明

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

请求示例

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

请求参数

返回示例

• 出参说明正常情况，可直接删除

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

• 备注

  应与移入数据集到回收站接口联动使用

3.2 移入数据集到回收站

• 权限需求

  资源	权限
  数据集	admin

• 接口描述与说明将数据集移入回收站，非彻底删除。

  

请求说明

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

请求示例

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

请求参数

返回示例

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

• 备注

  应与检查数据集是否可被移入回收站接口联动使用

3.3 从回收站恢复数据集

• 权限需求

  资源	权限
  数据集	admin

• 接口描述与说明从回收站将数据集移出。
  

请求说明

接口路径：{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/restore

请求示例

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

请求参数

返回示例

fails为空列表则代表恢复数据集成功

{
    "code": "aeolus/ok",
    "data": {
        "fails": []
    },
    "msg": "成功"
}

• 备注

  无

3.4 彻底删除数据集

• 权限需求

  资源	权限
  数据集	admin

• 接口描述与说明彻底删除数据集，清空数据集的数据、底表，关闭同步任务等；仅保留数据集本身的元信息。
  

请求说明

接口路径：{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}

请求示例

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

请求参数

返回示例

删除成功则返回数据集ID

{
    "code": "aeolus/ok",
    "data": [
        "180664"
    ],
    "msg": "成功"
}

• 备注

  无

3.5 移动数据集位置(更新文件夹路径)

• 权限需求

  资源	权限
  数据集	write
  新路径文件夹	write

• 接口描述与说明将指定数据集移动到特定的文件夹下，可与本文档 2.3.2 数据集文件夹-获取项目下数据集文件夹信息接口配合使用。
  

请求说明

接口路径：{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/folder/move

"move" operation is all about replacing the folder of the dataSet.

{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/folder

请求示例

curl --location --request PUT '{{domain}}/aeolus/api/v4/open/dataset/{{dataSetId}}/folder' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{jwtToken}}' \
--data-raw '{
    "folderId": 2706
}'

请求参数

返回示例

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

• 备注

  无