获取数据传输任务列表
POST /v2/dataSpaces/{data_space_id}/task:list
请求头(Request Header)
请求体(Request Body)
名称 | 类型 | 必须 | 默认值 | 取值范围 | 描述 |
---|---|---|---|---|---|
data_space_id | string | 是 | - | - | 数据空间ID. |
repo_id | string | 是 | - | - | 数据集ID. |
repo_name_keyword | string | 是 | - | - | 数据集名称检索词. |
transfer_type | integer($enum) | 是 | - | - | 传输类型. |
task_states | array(integer($enum)) | 是 | - | - | 任务状态列表. |
start_time | string($date-time) | 是 | - | - | 开始时间. |
end_time | string($date-time) | 是 | - | - | 结束时间. |
page_size | int32 | 是 | - | 10 | 每页条数. |
page_no | int32 | 是 | - | 0 | 页码. |
其中,transfer_type
有如下情况
状态 | 数值 | 含义 |
---|---|---|
TRANSFER_TYPE_UNDEFINED | 0 | 未定义 |
TRANSFER_TYPE_UPLOAD | 1 | 导入 |
TRANSFER_TYPE_DOWNLOAD | 2 | 导出 |
其中,task_state
有如下情况
状态 | 数值 | 含义 |
---|---|---|
STARTED | 0 | 开始,默认值 |
RUNNING | 1 | 任务正在运行 |
FINISHED | 2 | 任务已完成 |
ERROR | 3 | 任务出错失败 |
CANCEL | 4 | 任务已取消 |
REVIEW | 5 | 数据审核状态 |
REJECTED | 6 | 数据审核驳回状态 |
SENSEDATA_TRANSFER | 7 | senseData数据传输状态 |
SENSEDATA_TRANSFER_FAILED | 8 | senseData数据传输失败状态 |
请求示例(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)
名称 | 类型 | 描述 |
---|---|---|
tasks | array(object) | 任务列表. |
total | int32 | 总数. |
其中,tasks
的参数如下
名称 | 类型 | 描述 |
---|---|---|
id | string | 数据传输任务ID. |
task_type | integer($enum) | 数据传输任务的类型. |
task_state | integer($enum) | 传输任务状态. |
target_branch | string | 上传任务的目标分支. |
commit_id | string | 版本ID. |
commit_msg | string | 版本提交信息. |
creator_name | string | 创建者用户名. |
oss_config | object | 对象存储配置信息. |
source_path | string | 上传的源路径. |
target_path | string | 上传文件的远端目的路径. |
err_msg | string | 错误信息. |
total_file_size | integer | 总文件大小. |
total_file_count | integer | 总文件数. |
successed_file_size | integer | 已成功文件大小. |
successed_file_count | integer | 已成功文件数. |
failed_file_size | integer | 失败文件大小. |
failed_file_count | integer | 失败文件数. |
files | array[object] | 文件列表. |
create_time | string($date-time) | 任务创建时间. |
finish_time | string($date-time) | 任务完成时间. |
transfer_type | integer($enum) | 传输类型. |
repo_id | string | 数据集ID. |
repo_display_name | string | 数据集名称. |
extra_info | object | 额外信息. |
其中,task_state
有如下情况
状态 | 数值 | 含义 |
---|---|---|
STARTED | 0 | 开始,默认值 |
RUNNING | 1 | 任务正在运行 |
FINISHED | 2 | 任务已完成 |
ERROR | 3 | 任务出错失败 |
CANCEL | 4 | 任务已取消 |
REVIEW | 5 | 数据审核状态 |
REJECTED | 6 | 数据审核驳回状态 |
SENSEDATA_TRANSFER | 7 | senseData数据传输状态 |
SENSEDATA_TRANSFER_FAILED | 8 | senseData数据传输失败状态 |
其中,oss_config
的参数如下
名称 | 类型 | 描述 |
---|---|---|
bucket_name | string | 文件的所在的源桶名称. |
oss_endpoint | string | 对象存储的endpoint. |
access_key | string | 对象存储的access key. |
secret_key | string | 对象存储的secret key. |
virtual_host_style | bool | aoss需要为false,阿里云oss需要为true. |
disable_ssl | bool | 一些自建的没配置https的对象存储需要为true. |
insecure_skip_verify | bool | 一些自建的配置了https但是没配置证书的需要为true. |
其中,files
的参数如下
名称 | 类型 | 描述 |
---|---|---|
path | string | 文件路径. |
state | integer($enum) | 文件状态. |
err | integer($enum) | 上传文件错误. |
size | integer | 文件大小. |
其中,state
有如下情况
状态 | 数值 | 含义 |
---|---|---|
PENDING | 0 | 待办 |
SUCCESSED | 1 | 成功 |
FAILED | 2 | 失败 |
其中,err
有如下情况
状态 | 数值 | 含义 |
---|---|---|
UNKNOWN_ERROR | 0 | 系统错误 |
AOSS_SERVER_ERROR | 1 | AOSS报错 |
INVALID_FORMAT_ERROR | 2 | 格式校验不通过 |
FORBIDDEN_ERROR | 3 | 无权限 |
NOT_FOUND_ERROR | 4 | 文件未找到 |
其中,extra_info
的参数如下
名称 | 类型 | 描述 |
---|---|---|
related_id | string | 关联任务的ID. |
auth_info | object | 授权信息. |
其中,auth_info
的参数如下
名称 | 类型 | 描述 |
---|---|---|
auth_state | integer($enum) | 授权状态. |
authority_type | integer($enum) | 授权类型. |
auth_id | string | 授权项目id. |
其中,auth_state
有如下情况
状态 | 数值 | 含义 |
---|---|---|
AUTH_REVIEW_STATUS_UNKNOWN | 0 | 占位 |
AUTH_REVIEWING | 1 | 审核中 |
AUTH_SUCCEED | 2 | 审核通过 |
AUTO_PASSED | 3 | 自动通过 |
AUTH_REJECTED | 4 | 审核驳回 |
其中,authority_type
有如下情况
状态 | 数值 | 含义 |
---|---|---|
AUTHORITY_TYPE_UNKNOWN | 0 | 占位 |
DATASET | 1 | 关联历史数据集 |
AUTH_CENTER | 2 | 关联授权中心 |
INSENSITIVE | 3 | 无授权,不含人脸等敏感信息 |
NOT_DESENSITIZED | 4 | 无授权,需脱敏打码处理 |
SEALING | 5 | 无授权,封存处理 |
DESENSITIZED | 6 | 无授权,数据已脱敏打码 |
响应示例(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
}