创建数据集指定版本导出任务 | 大装置帮助中心
跳到主要内容

创建数据集指定版本导出任务

POST /v2/dataSpaces/{data_space_id}/repos/{repo_id}/commits/{commit_id}/transferTasks

请求头(Request Header)

参考认证(authentication)

请求参数(Request Parameters)

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

请求体(Request Body)

名称类型必须默认值取值范围描述
task_typeinteger($enum)--上传任务的类型.
commit_idstring--新建commitID.
source_pathstring--上传的源路径.
target_pathstring--上传文件的远端目的路径.
commit_msgstring--版本提交信息.
oss_configobject--对象存储配置信息.
transfer_typeinteger($enum)--传输类型.

其中,task_type有如下情况

状态数值含义
LOCAL_UPLOAD0本地上传
AOSS_UPLOAD1对象存储上传
WEB_UPLOAD2web端上传
SENSEDATA_UPLOAD3senseData上传
MOSAIC_UPLOAD4数据脱敏
LOCAL_DOWNLOAD5导出到本地
AOSS_DOWNLOAD6导出到对象存储

其中,oss_config的参数如下

名称类型描述
bucket_namestring文件的所在的源桶名称.
oss_endpointstring对象存储的endpoint.
access_keystring对象存储的access key.
secret_keystring对象存储的secret key.
virtual_host_styleboolaoss需要为false,阿里云oss需要为true.
disable_sslbool一些自建的没配置https的对象存储需要为true.
insecure_skip_verifybool一些自建的配置了https但是没配置证书的需要为true.

其中,transfer_type有如下情况

状态数值含义
TRANSFER_TYPE_UNDEFINED0未定义
TRANSFER_TYPE_UPLOAD1导入
TRANSFER_TYPE_DOWNLOAD2导出

请求示例(Request Example)

curl 'https://aidmp.cn-sh-01.sensecoreapi.tech/aids/aidmp/data/v2/dataSpaces/6794a734-54e7-11ed-b7c4-76337673fb0d/repos/452ba6a5-06bc-4b6b-a121-c30797ad3131/commits/91de91e3b6ea40cf99f929d0c9a7c6b7/transferTasks' \
--header 'Content-Type: application/json' \
--data '{
"target_path":"test01/00000",
"source_path":"00001",
"task_type":6,
"oss_config":{
"bucket_name":"klz-test",
"oss_endpoint":"https://aoss.cn-sh-01.sensecoreapi-oss.tech",
"access_key":"***",
"secret_key":"***"
}}'

响应(Response)

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

其中,metadata的参数如下

名称类型描述
idstring数据传输任务ID.
task_typeinteger($enum)数据传输任务的类型.
task_stateinteger($enum)传输任务状态.
target_branchstring上传任务的目标分支.
commit_idstring版本ID.
commit_msgstring版本提交信息.
creator_namestring创建者用户名.
oss_configobject对象存储配置信息.
source_pathstring上传的源路径.
target_pathstring上传文件的远端目的路径.
err_msgstring错误信息.
total_file_sizeinteger总文件大小.
total_file_countinteger总文件数.
successed_file_sizeinteger已成功文件大小.
successed_file_countinteger已成功文件数.
failed_file_sizeinteger失败文件大小.
failed_file_countinteger失败文件数.
filesarray[object]文件列表.
create_timestring($date-time)任务创建时间.
finish_timestring($date-time)任务完成时间.
transfer_typeinteger($enum)传输类型.
repo_idstring数据集ID.
repo_display_namestring数据集名称.

其中,task_state有如下情况

状态数值含义
STARTED0开始,默认值
RUNNING1任务正在运行
FINISHED2任务已完成
ERROR3任务出错失败
CANCEL4任务已取消
REVIEW5数据审核状态
REJECTED6数据审核驳回状态
SENSEDATA_TRANSFER7senseData数据传输状态
SENSEDATA_TRANSFER_FAILED8senseData数据传输失败状态

其中,files的参数如下

名称类型描述
pathstring文件路径.
stateinteger($enum)文件状态.
errinteger($enum)上传文件错误.
sizeinteger文件大小.

其中,state有如下情况

状态数值含义
PENDING0待办
SUCCESSED1成功
FAILED2失败

其中,err有如下情况

状态数值含义
UNKNOWN_ERROR0系统错误
AOSS_SERVER_ERROR1AOSS报错
INVALID_FORMAT_ERROR2格式校验不通过
FORBIDDEN_ERROR3无权限
NOT_FOUND_ERROR4文件未找到

其中,error的参数如下

名称类型描述
codeinteger错误码.
messagestring错误信息.
detailsobject错误详情.

其中,response的参数如下

名称类型描述
task_typeinteger($enum)上传任务的类型.
commit_idstring新建commitID.
source_pathstring上传的源路径.
target_pathstring上传文件的远端目的路径.
commit_msgstring版本提交信息.
oss_configobject对象存储配置信息.
transfer_typeinteger($enum)传输类型.

响应示例(Response Example)

{
"name": "803a1c0f-a530-4119-acaa-344be4c7a92f",
"metadata": {
"@type": "type.googleapis.com/sensecore.graviton.datamanagement.v2.TransferTaskMetadata",
"id": "",
"task_type": 0,
"task_state": 0,
"target_branch": "",
"commit_id": "",
"commit_msg": "",
"creator_name": "",
"oss_config": null,
"source_path": "",
"target_path": "",
"err_msg": "",
"total_file_size": "0",
"total_file_count": "0",
"succeed_file_size": "0",
"succeed_file_count": "0",
"failed_file_size": "0",
"failed_file_count": "0",
"files": [],
"create_time": "2023-12-05T07:22:47.279Z",
"finish_time": "2023-12-05T07:22:47.279Z",
"transfer_type": 0,
"repo_id": "",
"repo_display_name": ""
},
"done": false,
"response": {
"@type": "type.googleapis.com/sensecore.graviton.datamanagement.v2.TransferTask",
"task_type": 6,
"commit_id": "91de91e3b6ea40cf99f929d0c9a7c6b7",
"source_path": "00001",
"target_path": "test01/00000",
"commit_msg": "",
"oss_config": {
"bucket_name": "klz-test",
"oss_endpoint": "https://aoss.cn-sh-01.sensecoreapi-oss.tech",
"access_key": "044C2FDEBBC44E4B9E1B0574746D6BA7",
"secret_key": "",
"virtual_host_style": false,
"disable_ssl": false,
"insecure_skip_verify": false
},
"transfer_type": 2
}
}