删除文件
先调用接口一创建commit任务,再调用接口二启动服务端版本提交任务完成文件删除
接口一:创建远端提交版本任务.
POST /aids/aidmp/data/v2/dataSpaces/{data_space_id}/repos/{repo_id}/branches/{branch_id}/commitTasks
请求头(Request Header)
请求参数(Request Parameters)
名称 | 类型 | 必须 | 位置 | 默认值 | 取值范围 | 描述 |
---|---|---|---|---|---|---|
data_space_id | string | 是 | path | - | - | 数据空间ID. |
repo_id | string | 是 | path | - | - | 数据集ID. |
branch_id | string | 是 | path | - | - | 分支ID. |
请求体(Request Body)
名称 | 类型 | 必须 | 默认值 | 取值范围 | 描述 |
---|---|---|---|---|---|
dir_abs_path | string | 是 | - | - | 提交文件所属目录绝对路径. |
commit_message | string | 否 | - | - | 版本提交信息. |
oss_bucket_name | string | 否 | - | - | oss桶名称. |
oss_temp_path | string | 否 | - | - | oss存文件的临时路径: /graviton/repo/repoID/tmp/taskID/. |
请求示例(Request Example)
curl --location 'https://aidmp.cn-sh-01.sensecoreapi.dev/aids/aidmp/data/v2/dataSpaces/ecfcd941-575c-11ee-9d6f-46f164dda338/repos/b2dc6d90-6b68-46e2-a1d1-fd4b323eef40/branches/a0100b78-0c88-45a3-b561-ceb71a777f01/commitTasks' \
--header 'Content-Type: application/json' \
--data '{
"dir_abs_path": "dir1",
"commit_message": "删除 000000017627.jpg"
}'
响应(Response)
名称 | 类型 | 描述 |
---|---|---|
name | string | 上传任务ID. |
metadata | object | 上传任务元信息. |
done | boolean | 接口是否完成. |
error | object | 错误信息. |
response | object | 上传任务. |
其中,metadata
的参数如下
名称 | 类型 | 描述 |
---|---|---|
create_time | string($date-time) | 任务创建时间. |
task_state | integer($enum) | 任务状态. |
finish_time | string($date-time) | 任务完成时间. |
其中,task_state
有如下情况
状态 | 数值 | 含义 |
---|---|---|
STARTED | 0 | 开始,默认值 |
RUNNING | 1 | 任务正在运行 |
FINISHED | 2 | 任务已完成 |
ERROR | 3 | 任务出错失败 |
CANCEL | 4 | 任务已取消 |
其中,response
的参数如下
名称 | 类型 | 描述 |
---|---|---|
dir_abs_path | string | 提交文件所属目录绝对路径. |
commit_message | string | 版本提交信息. |
oss_bucket_name | string | oss桶名称. |
oss_temp_path | string | oss存文件的临时路径: /graviton/repo/repoID/tmp/taskID/. |
响应示例(Response Example)
{
"name": "4752225f-eac1-49ec-ba22-4bde91169b96",
"metadata": {
"@type": "type.googleapis.com/sensecore.graviton.datamanagement.v1.CommitMetadata",
"create_time": "2023-10-08T08:42:23.806Z",
"task_state": 0,
"finish_time": "2023-10-08T08:42:23.806Z"
},
"done": false,
"response": {
"@type": "type.googleapis.com/sensecore.graviton.datamanagement.v1.CommitTask",
"dir_abs_path": "dir1",
"commit_message": "删除 000000017627.jpg",
"oss_bucket_name": "ecfcd941-575c-11ee-9d6f-46f164dda338-1696669448031732053",
"oss_temp_path": "/graviton/repo/b2dc6d90-6b68-46e2-a1d1-fd4b323eef40/tmp/4752225f-eac1-49ec-ba22-4bde91169b96/"
}
}
接口二:启动服务端版本提交任务.
POST /aids/aidmp/data/v2/dataSpaces/{data_space_id}/repos/{repo_id}/commitOperations/{commit_task_id}:start
请求头(Request Header)
请求参数(Request Parameters)
名称 | 类型 | 必须 | 位置 | 默认值 | 取值范围 | 描述 |
---|---|---|---|---|---|---|
data_space_id | string | 是 | path | - | - | 数据空间ID. |
repo_id | string | 是 | path | - | - | 数据集ID. |
commit_task_id | string | 是 | path | - | - | 版本提交任务ID. |
请求体(Request Body)
名称 | 类型 | 必须 | 默认值 | 取值范围 | 描述 |
---|---|---|---|---|---|
repo_id | string | 否 | - | - | 数据集ID. |
task_id | string | 否 | - | - | 任务ID. |
add_files | array[string] | 否 | - | - | 新增文件列表. |
del_files | array[string] | 否 | - | - | 删除文件列表. |
rename_files | map[string]string | 否 | - | - | 重命名文件列表. |
forbid_overwrite | boolean | 否 | - | - | 是否禁止文件同名覆盖. |
请求示例(Request Example)
curl --location 'https://aidmp.cn-sh-01.sensecoreapi.dev/aids/aidmp/data/v2/dataSpaces/ecfcd941-575c-11ee-9d6f-46f164dda338/repos/b2dc6d90-6b68-46e2-a1d1-fd4b323eef40/commitOperations/4752225f-eac1-49ec-ba22-4bde91169b96:start' \
--header 'Content-Type: application/json' \
--data '{
"del_files": [
"000000017627.jpg"
]
}'
响应示例(Response Example)
正常HTTP状态码为200,无特殊返回。