更新时间:2022-12-05 GMT+08:00

查询作业进度

功能介绍

查询作业进度

URI

GET /v2/{project_id}/instances/{instance_id}/assets/jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

String

实例ID

最小长度:0

最大长度:64

project_id

String

项目ID

最小长度:0

最大长度:64

job_id

String

作业ID

最小长度:0

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

最小长度:1

最大长度:100000

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

作业ID

最小长度:1

最大长度:128

type

String

作业类型

status

String

作业状态

  • Running : 作业正在执行

  • Success : 作业执行成功,对于导出作业,用户可以通过archive_id来下载资产包

  • Failed : 作业执行失败,通过reason字段查看具体错误原因

  • Finished : 作业完成,针对导出作业,如果在有效期内下载了资产包,则作业状态从Success转换到Finished,此时不再返回archive_id字段

reasons

Array of AssetJobReason objects

导致作业失败的错误原因

progress_percent

Float

作业进度百分比

最小值:0

最大值:1

archive_id

String

导出作业成功时,供下载的资产包ID

最小长度:1

最大长度:128

begin_time

Number

作业开始时间

最小值:1

最大值:128

end_time

Number

作业结束时间

最小值:1

最大值:128

表4 AssetJobReason

参数

参数类型

描述

resource_type

String

资源类型

resource_name

String

资源名称

最小长度:1

最大长度:64

error_code

String

错误码

最小长度:1

最大长度:64

error_msg

String

错误信息

最小长度:1

最大长度:64

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:128

error_details

String

具体错误消息

最小长度:1

最大长度:128

request_id

String

请求处理ID

最小长度:1

最大长度:128

suggestion

String

处理建议

最小长度:1

最大长度:128

请求示例

响应示例

状态码: 200

OK

{
  "id" : "ff8080814dbd65d7014dbe0d84db0013",
  "type" : "exportAsset",
  "status" : "Running",
  "reason" : "json string",
  "progress_percent" : 0.35,
  "archive_id" : "string",
  "begin_time" : "2019-12-06T06:49:04Z",
  "end_time" : "2019-12-06T06:50:04Z"
}

状态码: 400

Not Found

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "suggestion" : "some suggestion",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

状态码

状态码

描述

200

OK

400

Not Found

错误码

请参见错误码