获取数据传输任务列表 | 大装置帮助中心
跳到主要内容

获取数据传输任务列表

POST /v2/dataSpaces/{data_space_id}/task:list

请求头(Request Header)

参考认证(authentication)

请求体(Request Body)

名称类型必须默认值取值范围描述
data_space_idstring--数据空间ID.
repo_idstring--数据集ID.
repo_name_keywordstring--数据集名称检索词.
transfer_typeinteger($enum)--传输类型.
task_statesarray(integer($enum))--任务状态列表.
start_timestring($date-time)--开始时间.
end_timestring($date-time)--结束时间.
page_sizeint32-10每页条数.
page_noint32-0页码.

其中,transfer_type有如下情况

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

其中,task_state有如下情况

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

请求示例(Request Example)

  curl 'https://aidmp.cn-sh-01.sensecoreapi.tech/aids/aidmp/data/v2/dataSpaces/6794a734-54e7-11ed-b7c4-76337673fb0d/task:list' \
--data-raw '{"page_no":1,"page_size":10,"transfer_type":2}'

响应(Response)

名称类型描述
tasksarray(object)任务列表.
totalint32总数.

其中,tasks的参数如下

名称类型描述
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数据集名称.
extra_infoobject额外信息.

其中,task_state有如下情况

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

其中,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.

其中,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文件未找到

其中,extra_info的参数如下

名称类型描述
related_idstring关联任务的ID.
auth_infoobject授权信息.

其中,auth_info的参数如下

名称类型描述
auth_stateinteger($enum)授权状态.
authority_typeinteger($enum)授权类型.
auth_idstring授权项目id.

其中,auth_state有如下情况

状态数值含义
AUTH_REVIEW_STATUS_UNKNOWN0占位
AUTH_REVIEWING1审核中
AUTH_SUCCEED2审核通过
AUTO_PASSED3自动通过
AUTH_REJECTED4审核驳回

其中,authority_type有如下情况

状态数值含义
AUTHORITY_TYPE_UNKNOWN0占位
DATASET1关联历史数据集
AUTH_CENTER2关联授权中心
INSENSITIVE3无授权,不含人脸等敏感信息
NOT_DESENSITIZED4无授权,需脱敏打码处理
SEALING5无授权,封存处理
DESENSITIZED6无授权,数据已脱敏打码

响应示例(Response Example)

{
"tasks": [
{
"id": "d261c003-73c2-4ce2-aa55-af47b35e0969",
"task_type": 6,
"task_state": 4,
"target_branch": "",
"commit_id": "7ea4a2c553644b4b8577d03e1edb6a4d",
"commit_msg": "",
"creator_name": "testdata1024",
"oss_config": {
"bucket_name": "klz-test",
"oss_endpoint": "https://aoss.cn-sh-01.sensecoreapi-oss.tech",
"access_key": "",
"secret_key": "",
"virtual_host_style": false,
"disable_ssl": false,
"insecure_skip_verify": false
},
"source_path": "/",
"target_path": ".",
"err_msg": "",
"total_file_size": "1758928",
"total_file_count": "0",
"succeed_file_size": "435495704",
"succeed_file_count": "2658",
"failed_file_size": "0",
"failed_file_count": "0",
"files": [],
"create_time": "2023-12-05T08:06:38.526Z",
"finish_time": "2023-12-05T08:06:45.404Z",
"transfer_type": 2,
"repo_id": "f85e733d-480f-4079-b2d9-a14952161523",
"repo_display_name": "testklz001"
}
],
"total": 2
}