You need to enable JavaScript to run this app.
导航
数据集操作 API
最近更新时间:2025.03.27 14:43:04首次发布时间:2024.03.15 14:50:49
我的收藏
有用
有用
无用
无用

1. 概述

本文为您介绍的是“数据集操作类的 Open API”,您将了解到用户可以通过 API 进行更新、移动、删除数据集,检查并移入数据集至回收站等操作。
注意:在您使用本文所述的 API 前,还需完成接入 JWT-Token 和申请 Token 的前置操作,请先了解调用方式,详情可阅读调用方式

2. 接口介绍

2.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}}'

请求参数

名称

类型

必选

示例值

含义说明

dataSetId

integer

123

数据集 ID

返回示例

  • 出参说明正常情况,可直接删除
    {
        "code": "aeolus/ok",
        "data": [],
        "msg": "成功"
    }
    

2.2 移动数据集到回收站

  • 权限需求

    资源

    权限

    数据集

    admin

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

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

Image

请求说明

请求地址:{{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}}'

请求参数

名称

类型

必选

示例值

含义说明

dataSetId

integer

123

数据集 ID

返回示例

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

2.3 从回收站恢复数据集

  • 权限需求

    资源

    权限

    数据集

    admin

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

请求说明

接口路径:{{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}}'

请求参数

名称

类型

必选

示例值

含义说明

dataSetId

integer

123

数据集 ID

返回示例

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

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

2.4 彻底删除数据集

  • 权限需求

    资源

    权限

    数据集

    admin

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

请求说明

接口路径:{{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}}'

请求参数

名称

类型

必选

示例值

含义说明

dataSetId

integer

123

数据集 ID

返回示例

删除成功则返回数据集 ID

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

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

  • 权限需求

    资源

    权限

    数据集

    write

    新路径文件夹

    write

  • 接口描述与说明:将指定数据集移动到特定的文件夹下,可与「数据集文件夹-获取项目下数据集文件夹信息」接口配合使用
    Image

请求说明

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

请求示例

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
}'

请求参数

名称

类型

必选

示例值

含义说明

dataSetId

integer

123

数据集 ID

folderId

integer

123

待移动到的目标文件夹 ID

返回示例

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