5.2 迁移任务管理
5.2.2 查询指定 ID 的任务详情
"start_time" : 1586249019394, "status" : 4,
"successful_num" : 19895, "task_type" : "prefix", "thread_num" : 50, "total_num" : 20001, "total_size" : 102629086, "total_time" : 131202, "smn_info" : "smn", "source_cdn" : "source_cdn"
} ] }
响应示例
无
状态码
状态码 描述
200 OK
400 Bad Request
错误码
请参见错误码。
5.2.2 查询指定 ID 的任务详情
功能介绍
查询指定ID的任务详情。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/tasks/{task_id}
表5-23 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID 最小长度：1 最大长度：1024
task_id 是 Long 任务ID
最小值：0
最大值：999999999999999
请求参数
表5-24 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String IAM 鉴权 Token 最小长度：1 最大长度：16384
响应参数
状态码： 200
表5-25 响应 Body 参数
参数 参数类型 描述
bandwidth_po
licy Array of BandwidthPo licyDto objects
流量控制策略，每个任务最多可设置5条限速策 略。
complete_size Long 任务迁移完成大小（Byte）。
最小值：0
最大值：9223372036854775807 description String 任务描述，没有设置时为空字符串。
最小长度：0 最大长度：255 dst_node DstNodeResp
object 目的端节点信息
参数 参数类型 描述 enable_failed_
object_recordi ng
Boolean 是否记录失败对象。开启后，如果有迁移失败对 象，会在目的端存储失败对象信息。
enable_kms Boolean 存储入OBS时是否使用KMS加密。
enable_restor
e Boolean 是否自动解冻归档数据，（由于对象存储解冻需
要源端存储等待一定时间，开启自动解冻会对迁 移速度有较大影响，建议先完成归档存储数据解 冻后再启动迁移）。 开启后，如果遇到归档类型 数据，会自动解冻再进行迁移；如果遇到归档类 型的对象直接跳过相应对象，系统默认对象迁移 失败并记录相关信息到失败对象列表中。
error_reason ErrorReasonR
esp object 任务失败原因，非失败状态时该字段为空字符 串。
failed_num Long 迁移失败对象数量。
最小值：0
最大值：9223372036854775807 failed_object_
record FailedObject RecordDto object
失败对象列表记录结果，记录成功时提供失败对 象列表存放链接，记录失败时显示失败原因。
group_id String 迁移任务组ID，当任务由迁移任务组创建时会包 含迁移任务组的id信息。
最小长度：0 最大长度：36
id Long 任务ID。
最小值：0
最大值：999999999999999
is_query_over Boolean 迁移任务是否完成源端对象统计数据扫描。
left_time Long 任务剩余时间（毫秒）。
最小值：0
最大值：9223372036854775807
migrate_since Long 迁移指定时间（时间戳，毫秒），表示仅迁移在 指定时间之后修改的源端待迁移对象。默认为0，
表示不设置迁移指定时间。
最小值：0
最大值：9223372036854775807 migrate_spee
d Long 任务迁移速度（Byte/s）。
最小值：0
最大值：9223372036854775807
参数 参数类型 描述
name String 任务名称。
最小长度：0 最大长度：10240
progress Double 任务进度，例如：0.522代表任务进度为52.2%，
1代表任务进度为100%。
最小值：0 最大值：1
real_size Long 实际迁移对象总大小（Byte），忽略对象的大小 不会统计在内。
最小值：0
最大值：9223372036854775807
skipped_num Long 迁移忽略对象数（存在以下两种情况会自动跳 过：1.源端对象最后修改时间在迁移指定时间 前；2.目的端已有该对象。）
最小值：0
最大值：9223372036854775807 src_node SrcNodeResp
object 源端节点信息
start_time Long 任务启动时间（Unix时间戳，毫秒）。
最小值：0
最大值：9223372036854775807
status Integer 任务状态。 1：等待调度 2：正在执行 3：停止 4：失败 5：成功
最小值：1 最大值：5 successful_nu
m Long 迁移成功对象数量。
最小值：0
最大值：9223372036854775807
task_type String 任务类型，为空默认设置为object。 list：对象列 表迁移 object：文件/文件夹迁移 prefix：对象前 缀迁移 url_list: url对象列表
缺省值：object 枚举值：
● list
● object
● prefix
● url_list
参数 参数类型 描述
group_type String 分组类型 NORMAL_TASK：一般迁移任务 SYNC_TASK：同步任务所属迁移任务 GROUP_TASK：任务组所属迁移任务 缺省值：NORMAL_TASK
枚举值：
● NORMAL_TASK
● SYNC_TASK
● GROUP_TASK total_num Long 迁移任务对象总数量。
最小值：0
最大值：9223372036854775807 total_size Long 任务迁移总大小（Byte）。
最小值：0
最大值：9223372036854775807 total_time Long 任务总耗时（毫秒）。
最小值：0
最大值：9223372036854775807 smn_info SmnInfo
object SMN消息通知结果 source_cdn SourceCdnRe
sp object 指定是否启用CDN迁移支持。启用CDN迁移支持 后，迁移时将从CDN域名获取源端对象。若包含 此字段则为支持，否则为不支持。
success_recor d_error_reaso n
String 迁移成功对象列表记录失败错误码，记录成功时 为空
最小长度：0 最大长度：255 skip_record_er
ror_reason String 迁移忽略对象列表记录失败错误码,记录记录成功 时为空。
最小长度：0 最大长度：255
表5-26 BandwidthPolicyDto
参数 参数类型 描述
end String 流量控制结束时间（包含），格式为
“hh:mm”。例如“12:03”表示12时03分。
参数 参数类型 描述 max_bandwid
th Long 时段内允许的最大流量带宽，单位Byte/s，取值
范围为>= 1048576Byte/s（相当于1MB/s）且
<=209715200Byte/s（相当于200MB/s）。
最小值：1048576 最大值：209715200
start String 流量控制开始时间（包含），格式为
“hh:mm”。例如“12:03”表示12时03分。
表5-27 DstNodeResp
参数 参数类型 描述
bucket String 目的端桶的名称。
最大长度：1024 region String 目的端桶所处的区域。
请与Endpoint对应的区域保持一致。
最小长度：0 最大长度：100
save_prefix String 目的端桶内路径前缀（拼接在对象key前面,组成 新的key,拼接后不能超过1024个字符）。
最小长度：0 最大长度：1024
表5-28 ErrorReasonResp
参数 参数类型 描述
error_code String 迁移失败的错误码。
最小长度：0 最大长度：10 error_msg String 迁移失败的原因。
最小长度：0 最大长度：1024
表5-29 FailedObjectRecordDto
参数 参数类型 描述
result Boolean 是否支持失败对象重传。
参数 参数类型 描述
list_file_key String 失败对象列表文件路径。
最小长度：0 最大长度：1024
error_code String 失败对象列表上传失败的错误码。
最小长度：0 最大长度：10
表5-30 SrcNodeResp
参数 参数类型 描述
bucket String 源端桶的名称。
最小长度：0 最大长度：1024 cloud_type String 源端云服务提供商。
可选值有AWS、Azure、Aliyun、Tencent、
HuaweiCloud、QingCloud、KingsoftCloud、
Baidu、Qiniu、URLSource或者UCloud。默认值 为Aliyun。
枚举值：
● AWS
● Azure
● Aliyun
● Tencent
● HuaweiCloud
● QingCloud
● KingsoftCloud
● Baidu
● Qiniu
● URLSource
● UCloud
region String 源端桶所处的区域。
最小长度：0 最大长度：100
app_id String 当源端为腾讯云时，会返回此参数。
最小长度：0 最大长度：255
参数 参数类型 描述 object_key Array of
strings 任务类型为对象迁移任务时，表示待迁移对象名 称； 任务类型为前缀迁移任务时，表示待迁移前 缀。
list_file ListFile object 列表文件配置，当task_type为list或url_list时，
list_file为必选参数。
表5-31 ListFile
参数 参数类型 描述
list_file_key String 对象列表文件或URL列表文件对象名。
最小长度：1 最大长度：1024
obs_bucket String 存放对象列表文件的OBS桶名。
请确保与目的端桶处于同一区域，否则将导致任 务创建失败。
最小长度：0 最大长度：1024
表5-32 SmnInfo
参数 参数类型 描述
notify_result Boolean 记录迁移任务执行完毕后SMN消息是否发送成 功。
notify_error_
message String 记录SMN消息发送失败原因的错误码（迁移任务 成功时为空）。
最小长度：0 最大长度：1024
topic_name String SMN Topic的名称（SMN消息发送成功时为 空）。
最小长度：0 最大长度：5120
表5-33 SourceCdnResp
参数 参数类型 描述
domain String 从指定域名获取对象。
最小长度：0 最大长度：1024
protocol String 协议类型，支持http和https协议。
枚举值：
● http
● https authenticatio
n_type String 鉴权类型: NONE,
QINIU_PRIVATE_AUTHENTICATION, ALIYUN_OSS_A, ALIYUN_OSS_B, ALIYUN_OSS_C,
KSYUN_PRIVATE_AUTHENTICATION, AZURE_SAS_TOKEN
枚举值：
● NONE
● QINIU_PRIVATE_AUTHENTICATION
● ALIYUN_OSS_A
● ALIYUN_OSS_B
● ALIYUN_OSS_C
● KSYUN_PRIVATE_AUTHENTICATION
● AZURE_SAS_TOKEN
状态码： 404
表5-34 响应 Body 参数
参数 参数类型 描述
error_msg String 错误信息。
error_code String 错误码。
请求示例
查询2c0689c860ad4728a497c91ec0844383项目下的191297407830872任务的详情
GET https://{endpoint}/v2/2c0689c860ad4728a497c91ec0844383/tasks/191297407830872 { "bandwidth_policy" : [ {
"start" : "00:00", "end" : "15:00",
"max_bandwidth" : 5242880 } ],
"complete_size" : 102608606, "description" : "Aliyun_API_Sonar", "dst_node" : {
"region" : "cn-north-1", "bucket" : "oms-sonar-north1"
}, "enable_failed_object_recording" : true, "enable_kms" : false,
"enable_restore" : false, "error_reason" : {
"error_code" : "TRF.0001",
"error_msg" : "System error. Click the restart button to try to start the migration task."
}, "failed_num" : 7, "failed_object_record" : { "result" : true,
"list_file_key" : "oms/failed_object_lists/api-auto-test1-oms-sonar-north1-20200407164335723_487.failed_list.txt"
}, "group_id" : "null", "id" : 191297407830872, "is_query_over" : true, "left_time" : 0, "migrate_since" : 0, "migrate_speed" : 780973,
"name" : "api-auto-test1-oms-sonar-north1-20200407164335723_487", "progress" : 0.998,
"real_size" : 102465246, "skipped_num" : 99, "src_node" : {
"region" : "cn-beijing", "bucket" : "api-auto-test1", "object_key" : [ "10000" ], "list_file" : "",
"cloud_type" : "Aliyun"
}, "start_time" : 1586249019394, "status" : 4,
"successful_num" : 19895, "task_type" : "prefix", "thread_num" : 50, "total_num" : 20001, "total_size" : 102629086, "total_time" : 131202, "smn_info" : "smn", "source_cdn" : "source_cdn"
}
404 Not Found
错误码
请参见错误码。