拉取同步任务列表 | 大装置帮助中心
跳到主要内容

拉取同步任务列表

POST /storage/ads/data/v1/subscriptions/{subscription_name}/resourceGroups/{resource_group_name}/zones/{zone}/dataSync/{data_sync_name}/task/list

请求头(Request Header)

参考认证(authentication)

请求参数(Request Parameters

名称类型必须位置默认值取值范围描述
subscription_namestringpath--订阅名称.
resource_group_namestringpath--资源组.
zonestringpath--可用区.
data_sync_namestringpath--数据同步工具资源名称,需符合正则:^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.

请求体(Request Body)

名称类型必须默认值取值范围描述
pageobject--分页信息.
is_historyboolean--是否是历史任务.
filterstring--关键字:任务名称.
typestring--任务类型.

其中,page的参数如下

名称类型必须默认值取值范围描述
pageinteger--页码.
page_sizeinteger--页大小.

其中,type有如下情况

类型含义
AOSSTOFS对象到文件
FSTOAOSS文件到对象
THIRDTOAOSS第三方云到对象
THIRDTOFS第三方云到文件
AOSSTOAOSS对象到对象
FSTOFS文件到文件

请求示例(Request Example)

curl 'https://ads.cn-sh-01.sensecoreapi.dev/storage/ads/data/v1/subscriptions/e995c396-83f6-4a1b-a055-2acb8bc7cf1f/resourceGroups/default/zones/cn-sh-01z/dataSync/ads/task/list' \
-H 'authority: ads.cn-sh-01.sensecoreapi.dev' \
-H 'accept: application/json' \
-H 'accept-language: zh-CN' \
-H 'authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InB1YmxpYzpoeWRyYS5qd3QuYWNjZXNzLXRva2VuIiwidHlwIjoiSldUIn0.eyJhdWQiOltdLCJjbGllbnRfaWQiOiI0ZTQxNDg1NC03MjAwLTUwOWYtYjk2MC1mOGIwZGJiYmYzMzEiLCJleHAiOjE2OTU3OTIyNTksImV4dCI6eyJpc19kZWRpY2F0ZWRfdGVuYW50IjpmYWxzZSwicHJwX2xpc3QiOlsiY24tc2gtMDFhLXBycDAxIiwiY24tc2gtMDFiLXBycDAxIl0sInRlbmFudF9jZXJ0aWZ5X3N0YXR1cyI6dHJ1ZSwidGVuYW50X2NlcnRpZnlfdHlwZSI6ImVudGVycHJpc2UiLCJ0ZW5hbnRfY29kZSI6ImFvc3MwOTI4IiwidGVuYW50X2lkIjoiZTk5NWMzOTYtODNmNi00YTFiLWEwNTUtMmFjYjhiYzdjZjFmIiwidXNlcl9pZCI6IjU3NDYzY2Q4LTNlZTktNGJmNC1iMTM5LTg4OTBmZDI2YzkxNCIsInVzZXJfdHlwZSI6ImFkbWluIiwidXNlcm5hbWUiOiJhb3NzMDkyOCJ9LCJpYXQiOjE2OTU3ODE0NTksImlzcyI6Imh0dHBzOi8vc2lnbmluLnNlbnNlY29yZS5kZXYvIiwianRpIjoiODUyNjcxMTUtMmNlMi00YTBlLWIzZDEtMDAxMjYyMzM0YWVlIiwibmJmIjoxNjk1NzgxNDU5LCJzY3AiOlsib3BlbmlkIiwib2ZmbGluZSIsIm9mZmxpbmVfYWNjZXNzIl0sInN1YiI6ImFvc3MwOTI4OmU5OTVjMzk2LTgzZjYtNGExYi1hMDU1LTJhY2I4YmM3Y2YxZjo1NzQ2M2NkOC0zZWU5LTRiZjQtYjEzOS04ODkwZmQyNmM5MTQifQ.EyPsN5MlwkX5TUOAEMW4WMPneqMf9eiGZOP_-mLQC-grK9dj5K8ARUJUtYWMO7SnjxzDnqJf3to25wqNPGfFr9LEW6ismShD0rG8JE4SW-8jqp4jZ3ZW7-wDbOmtgzpEgTmMjlRAn5bYGFHG0XkguhiT7E6who4d_agNFzbl03ySjEHPhIf_Uk6v9yFuUVVV8djFLXcaOMPzz3T-f6ZOH8WIgtDy51WzqIuF1tDg-9eL5EYGeDBzH2udjzubvdYgkm-wwNM_4kGEIdxHGrVEhX7EqB03STOCuFjtAIE4KLGGHSRMp3ax6yZNcoHni-wAwgzWz5n862tfURuh9U49mhtzF2Mx6d7srLBTWBbQl9pNC12fYNMZxqJ9J76emoszbXpHWN7zZr5qhJ_qZ_xgbIs20K51WdpcyfK__8xL1H8PpBgLRwZZ4FvgY99iuC51otfCm6T-ZEpIhDPYRmf88bBjJWNJ9tAeNnY6Xc5MYoIWWpURw9krJj0QHXiQTYlPX5QGu9lGedyn0l0Uvzd3VdLNePQrxvEgteVFFpwoP60dkzo52FanwKZaKGO63JzVCr2BmtLWeNlWGKI6nvZVmKEotQzN71Mt_zBlOdnWgocgeeBIpc-aULskA3-q3DiR7Ex7dQJKtgJ1UsWUQ9gbmlnwReg38CM5Ak7oUc7tPQs' \
-H 'content-type: application/json;charset=UTF-8' \
-H 'dnt: 1' \
-H 'origin: https://console.sensecore.dev' \
-H 'referer: https://console.sensecore.dev/' \
-H 'sec-ch-ua: "Chromium";v="116", "Not)A;Brand";v="24", "Google Chrome";v="116"' \
-H 'sec-ch-ua-mobile: ?0' \
-H 'sec-ch-ua-platform: "macOS"' \
-H 'sec-fetch-dest: empty' \
-H 'sec-fetch-mode: cors' \
-H 'sec-fetch-site: cross-site' \
-H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36' \
--data-raw '{"page":{"page":0,"page_size":10},"is_history":0,"type":""}' \
--compressed

响应(Response)

名称类型描述
data_sync_taskarray[object]数据同步任务列表.
pageobject分页信息.

其中,data_sync_task的参数如下

名称类型描述
task_idstring数据同步任务id.
task_namestring数据同步任务名称.
uidstring数据同步工具资源uuid.
user_idstring创建数据同步任务的用户id.
tenant_idstring租户id.
typestring当前数据同步任务类型.
statestring当前数据同步任务状态.
src_infoarray[object]数据同步任务源路径信息.
dst_infoobject数据同步任务目的路径信息.
size_unitstring数据同步任务大小单位.
sizeinteger数据同步任务大小.
startinteger数据同步任务开始时间.
endinteger数据同步任务结束时间.
percentinteger数据同步任务进度百分比.
ratestring数据同步任务速率.
time_coststring数据同步任务耗时.
src_third_infoobject第三方云信息.
err_msgstring任务失败原因.
total_numinteger文件总数.
complete_numinteger成功传输个数.
exist_numinteger已存在文件个数.

其中,type有如下情况

类型含义
AOSSTOFS对象到文件
FSTOAOSS文件到对象
THIRDTOAOSS第三方云到对象
THIRDTOFS第三方云到文件
AOSSTOAOSS对象到对象
FSTOFS文件到文件

其中,state有如下情况

状态含义
SCANNING扫描中
DOING进行中
PAUSED已暂停
COMPLETED已完成
FAILED已失败
CANCELLED已取消

其中,src_info的参数如下

|名称|类型|描述| |---|---||---| |id|string|卷id或桶名.| |region|string|地域.| |prefix|string|前缀.| |name|string|卷名或桶名.| |endpoint|string|桶in_endpoint.| |zone|string|可用区.|

其中,dst_info的参数如下

名称类型描述
idstring卷id或桶名.
regionstring地域.
prefixstring前缀.
namestring卷名或桶名.
endpointstring桶in_endpoint.
zonestring可用区.

其中,size_unit有如下情况

状态含义
B-
KB-
MB-
GB-
TB-
PB-
EB-

其中,src_third_info的参数如下

名称类型描述
typestring第三方云类型.
hoststring域名.
akstring第三方云用户公钥.
skstring第三方云用户私钥.
pathstring第三方云数据存储路径.

其中,src_third_info.type有如下情况

类型含义
OSS阿里云
COS腾讯云
OBS华为云
BOS百度云
S3AWS
KS3金山云
QINIU七牛云
WASBAzure Blob
UFILEUCloud

其中,page的参数如下

名称类型描述
pageinteger页码.
page_sizeinteger页大小.
totalinteger总记录数.

响应示例(Response Example)

{
"data_sync_task": [
{
"task_id": "8376ef5d-0146-4291-b420-ab11c6b1335d",
"task_name": "test0927_test2",
"uid": "78ca6095-ad15-11ed-8800-26b9868a206f",
"user_id": "57463cd8-3ee9-4bf4-b139-8890fd26c914",
"tenant_id": "e995c396-83f6-4a1b-a055-2acb8bc7cf1f",
"type": "AOSSTOFS",
"state": "SCANNING",
"src_info": [
{
"id": "0888",
"region": "cn-sh-01",
"prefix": "/",
"name": "0888",
"endpoint": "",
"zone": "cn-sh-01b"
}
],
"dst_info": {
"id": "5d79e1de-51de-11ee-a7c9-f665d8019db5",
"region": "cn-sh-01",
"prefix": "/0927/",
"name": "test_ads",
"endpoint": "",
"zone": "cn-sh-01b"
},
"size_unit": "B",
"size": 0,
"start": 1695783120,
"end": 0,
"percent": 0,
"rate": "0KB/s",
"time_cost": "<1秒",
"create": 1695783120,
"src_third_info": {
"type": "OSS",
"host": "",
"ak": "",
"sk": "",
"path": ""
},
"err_msg": "",
"total_num": 0,
"complete_num": 0,
"exist_num": 0
}
],
"page": {
"page": 0,
"page_size": 10,
"total": 1
}
}