查询后台任务详细信息
功能介绍
查询后台任务详细信息。
URI
GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}/progress
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
|
instance_id |
是 |
String |
实例ID。 |
|
task_id |
是 |
String |
后台任务ID。 |
请求参数
无
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
progress |
Integer |
总体进度，单位：%。 |
|
remain_time |
Integer |
剩余时间，单位：秒。 |
|
step_details |
Array of StepDetail objects |
任务详情列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
step_id |
String |
后台任务ID。 |
|
step_name |
String |
任务名。 最大长度：1024 |
|
step_status |
String |
任务状态，取值范围：
枚举值：
|
|
begin_time |
String |
任务启动时间，格式为2020-06-17T07:38:42.503Z。 |
|
end_time |
String |
任务结束时间，格式为2020-06-17T07:38:42.503Z。 |
|
error_code |
String |
错误码。 |
|
sub_step_details |
Array of SubStepDetail objects |
子任务详情列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
sub_step_id |
String |
任务ID。 |
|
sub_step_name |
String |
任务名。 最大长度：1024 |
|
sub_step_status |
String |
任务状态。 |
|
begin_time |
String |
任务启动时间，格式为2020-06-17T07:38:42.503Z。 |
|
end_time |
String |
任务结束时间，格式为2020-06-17T07:38:42.503Z。 |
|
detail |
String |
子任务的附加属性详情。 最大长度：1024 |
|
error_code |
String |
错误码。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误信息。 最大长度：1024 |
|
error_code |
String |
错误码。 最大长度：9 |
|
error_ext_msg |
String |
扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误信息。 最大长度：1024 |
|
error_code |
String |
错误码。 最大长度：9 |
|
error_ext_msg |
String |
扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误信息。 最大长度：1024 |
|
error_code |
String |
错误码。 最大长度：9 |
|
error_ext_msg |
String |
扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误信息。 最大长度：1024 |
|
error_code |
String |
错误码。 最大长度：9 |
|
error_ext_msg |
String |
扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误信息。 最大长度：1024 |
|
error_code |
String |
错误码。 最大长度：9 |
|
error_ext_msg |
String |
扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 |
请求示例
GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/tasks/8abf6e1e72c12e7c0172c15b508500aa/progress
响应示例
状态码： 200
查询后台任务详情成功。
{
"progress" : 30,
"remain_time" : 100,
"step_details" : [ {
"step_id" : "9d1d1da8-650e-406f-81e4-b3c11515869f",
"step_name" : "前置检查",
"step_status" : "FINISH",
"begin_time" : "2022-09-01 11:52:24",
"end_time" : "2022-09-01 11:52:29",
"error_code" : "DCS.4064",
"sub_step_details" : [ {
"sub_step_id" : "4692b05b-fa55-4f7d-9be6-527bde25b424",
"sub_step_name" : "资源检查",
"sub_step_status" : "FINISH",
"begin_time" : "2022-09-01 11:52:24",
"end_time" : "2022-09-01 11:52:26",
"detail" : "",
"error_code" : "DCS.4065"
}, {
"sub_step_id" : "4692b05b-fa55-4f7d-9be6-527bde25b425",
"sub_step_name" : "实例状态检查",
"sub_step_status" : "FINISH",
"begin_time" : "2022-09-01 11:52:26",
"end_time" : "2022-09-01 11:52:29",
"detail" : "",
"error_code" : "DCS.4064"
} ]
}, {
"step_id" : "9d1d1da8-650e-406f-3fad-c4a22515869f",
"step_name" : "数据迁移",
"step_status" : "EXECUTING",
"begin_time" : "2022-09-01 11:52:30",
"end_time" : "2022-09-01 11:54:30",
"error_code" : "DCS.4065",
"sub_step_details" : [ {
"sub_step_id" : "cb58a8ea-b8e2-4626-b3fa-57ab1a830724",
"sub_step_name" : "申请资源",
"sub_step_status" : "FINISH",
"begin_time" : "2022-09-01 11:52:30",
"end_time" : "2022-09-01 11:53:30",
"detail" : "{node_id:9996c3376318417281fb5e611f3fb1a0,slot_range:[0 5460],full_migration:迁移中,inc_migration:迁移中}",
"error_code" : "DCS.4065"
}, {
"sub_step_id" : "f9df7fd2-b31f-4ec3-bbb1-3dc740326342",
"sub_step_name" : "申请资源",
"sub_step_status" : "FINISH",
"begin_time" : "2022-09-01 11:53:30",
"end_time" : "2022-09-01 11:54:30",
"detail" : "{node_id:5b70f440ccc94789b34a5c98c2ba05ea,slot_range:[5461 10921],full_migration:待开始,inc_migration:待开始}",
"error_code" : "DCS.4066"
} ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询后台任务详情成功。 |
|
400 |
非法请求。 |
|
401 |
认证信息非法。 |
|
403 |
请求被拒绝访问。 |
|
404 |
所请求的资源不存在。 |
|
500 |
内部服务错误。 |
错误码
请参见错误码。
