本文为您介绍的是“数据集操作类的 Open API”,您将了解到用户可以通过 API 进行更新、移动、删除数据集,检查并移入数据集至回收站等操作。
注意:在您使用本文所述的 API 前,还需完成接入 JWT-Token 和申请 Token 的前置操作,请先了解调用方式,详情可阅读调用方式。
权限需求
资源 | 权限 |
---|---|
数据集 | 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": "成功" }
权限需求
资源 | 权限 |
---|---|
数据集 | 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}}'
名称 | 类型 | 必选 | 示例值 | 含义说明 |
---|---|---|---|---|
dataSetId | integer | 是 | 123 | 数据集 ID |
{ "code": "aeolus/ok", "data": [], "msg": "成功" }
权限需求
资源 | 权限 |
---|---|
数据集 | 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}}'
名称 | 类型 | 必选 | 示例值 | 含义说明 |
---|---|---|---|---|
dataSetId | integer | 是 | 123 | 数据集 ID |
fails
为空列表则代表恢复数据集成功
{ "code": "aeolus/ok", "data": { "fails": [] }, "msg": "成功" }
权限需求
资源 | 权限 |
---|---|
数据集 | 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}}'
名称 | 类型 | 必选 | 示例值 | 含义说明 |
---|---|---|---|---|
dataSetId | integer | 是 | 123 | 数据集 ID |
删除成功则返回数据集 ID
{ "code": "aeolus/ok", "data": [ "180664" ], "msg": "成功" }
权限需求
资源 | 权限 |
---|---|
数据集 | write |
新路径文件夹 | write |
接口描述与说明:将指定数据集移动到特定的文件夹下,可与「数据集文件夹-获取项目下数据集文件夹信息」接口配合使用
接口路径:{{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": "成功" }