更新时间:2024-10-30 GMT+08:00
分享

查询作业进度

功能介绍

查询作业进度。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

String

实例ID。

project_id

String

项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。

job_id

String

作业ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

作业ID。

type

String

作业类型。

status

String

作业状态。

  • RUNNING : 作业正在执行。

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

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

reason

Array of AssetJobReason objects

导致作业失败的错误原因。

progress_percent

Float

作业进度百分比。

archive_id

String

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

begin_time

String

作业开始时间。

end_time

String

作业结束时间。

表4 AssetJobReason

参数

参数类型

描述

resource_type

String

资源类型。

resource_name

String

资源名称。

error_code

String

错误码。

error_msg

String

错误信息。

状态码: 403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

error_details

String

具体错误消息。

request_id

String

请求处理ID。

请求示例

响应示例

状态码: 200

OK

{
  "id" : "ff8080814dbd65d7014dbe0d84db0013",
  "type" : "exportAsset",
  "status" : "Running",
  "reason" : [ {
    "resource_type" : "application",
    "resource_name" : "myApp",
    "error_code" : "ROMA.00000101",
    "error_msg" : "some error details here"
  } ],
  "progress_percent" : 0.35,
  "archive_id" : "string",
  "begin_time" : "2019-12-06T06:49:04Z",
  "end_time" : "2019-12-06T06:50:04Z"
}

状态码: 403

Forbidden

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

状态码

状态码

描述

200

OK

403

Forbidden

错误码

请参见错误码

相关文档