删除文件 | 大装置帮助中心
跳到主要内容

删除文件

先调用接口一创建commit任务,再调用接口二启动服务端版本提交任务完成文件删除

接口一:创建远端提交版本任务.

POST /aids/aidmp/data/v2/dataSpaces/{data_space_id}/repos/{repo_id}/branches/{branch_id}/commitTasks

请求头(Request Header)

参考认证(authentication)

请求参数(Request Parameters)

名称类型必须位置默认值取值范围描述
data_space_idstringpath--数据空间ID.
repo_idstringpath--数据集ID.
branch_idstringpath--分支ID.

请求体(Request Body)

名称类型必须默认值取值范围描述
dir_abs_pathstring--提交文件所属目录绝对路径.
commit_messagestring--版本提交信息.
oss_bucket_namestring--oss桶名称.
oss_temp_pathstring--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)

名称类型描述
namestring上传任务ID.
metadataobject上传任务元信息.
doneboolean接口是否完成.
errorobject错误信息.
responseobject上传任务.

其中,metadata的参数如下

名称类型描述
create_timestring($date-time)任务创建时间.
task_stateinteger($enum)任务状态.
finish_timestring($date-time)任务完成时间.

其中,task_state有如下情况

状态数值含义
STARTED0开始,默认值
RUNNING1任务正在运行
FINISHED2任务已完成
ERROR3任务出错失败
CANCEL4任务已取消

其中,response的参数如下

名称类型描述
dir_abs_pathstring提交文件所属目录绝对路径.
commit_messagestring版本提交信息.
oss_bucket_namestringoss桶名称.
oss_temp_pathstringoss存文件的临时路径: /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)

参考认证(authentication)

请求参数(Request Parameters)

名称类型必须位置默认值取值范围描述
data_space_idstringpath--数据空间ID.
repo_idstringpath--数据集ID.
commit_task_idstringpath--版本提交任务ID.

请求体(Request Body)

名称类型必须默认值取值范围描述
repo_idstring--数据集ID.
task_idstring--任务ID.
add_filesarray[string]--新增文件列表.
del_filesarray[string]--删除文件列表.
rename_filesmap[string]string--重命名文件列表.
forbid_overwriteboolean--是否禁止文件同名覆盖.

请求示例(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,无特殊返回。