查询微服务引擎任务详情 - QueryMicroserviceEngineJobDetails

功能介绍

查询微服务引擎任务详情。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
cse:engine:get
read
engine
g:ResourceTag/<tag-key>
g:EnterpriseProjectId
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
cse:engine:get	read	engine	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	-

URI

GET /v2/{project_id}/enginemgr/engines/{engine_id}/jobs/{job_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户子项目的唯一标识。字符长度为1~64。
engine_id	是	String	微服务引擎ID。
job_id	是	String	任务ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。
X-Enterprise-Project-ID	否	String	如果不带则默认企业项目为“default”，ID为“0”。
Content-Type	是	String	该字段内容填为 "application/json;charset=UTF-8"。
Accept	是	String	该字段内容填为 "application/json"。

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
id	Integer	任务ID。
engineId	String	任务所属引擎ID。
type	String	任务类型。取值范围： Create：创建操作。 Delete：删除操作。 Upgrade：升级操作。 Modify：更新操作。
description	String	任务描述。
status	String	任务状态。取值范围： Init：任务初始化。 Executing：任务执行中。 Error：任务错误。 Timeout：任务超时。 Finished：任务完成。
scheduling	Integer	任务是否正在执行。取值范围： 0：表示不在执行。 1：表示执行中。
createUser	String	任务创建者。
startTime	Long	任务开始时间。
endTime	Long	任务结束时间。
context	String	任务执行上下文。
tasks	Array of TaskSteps objects	任务包含的处理阶段。

表4 TaskSteps
参数	参数类型	描述
taskName	String	处理阶段名称。
taskNames	Array of strings	当前处理阶段包含的处理步骤名称列表。
status	String	处理阶段状态。取值范围： Init：任务初始化。 Executing：任务执行中。 Error：任务错误。 Timeout：任务超时。 Finished：任务完成。
startTime	Long	处理阶段开始时间。
endTime	Long	处理阶段结束时间。
taskExecutorBrief	TaskExecutorBrief object	处理阶段元数据。
tasks	Array of Task objects	处理步骤。

表5 Task
参数	参数类型	描述
jobId	Integer	子任务所属任务ID。
id	Long	子任务ID，使用uuid。
type	String	子任务的类型。取值范围： Create：创建操作。 Delete：删除操作。 Upgrade：升级操作 Modify：更新操作。
assigned	String	子任务的执行者。
taskName	String	子任务名称。
engineName	String	子任务所属引擎名称。
taskOrder	Integer	子任务执行的顺序，从小到大。
status	String	子任务状态。取值范围： Init：子任务初始化。 Executing：子任务执行中。 Error：子任务报错。 Timeout：子任务超时。 Finished：子任务完成。
startTime	Long	子任务开始时间。
endTime	Long	子任务结束时间。
createTime	Long	子任务创建时间。
updateTime	Long	子任务更新时间。
timeout	Integer	子任务是否超时。
log	String	子任务详细信息，执行过程中产生的辅助信息。
output	String	子任务输出信息。
taskExecutorBrief	TaskExecutorBrief object	任务元数据。

表6 TaskExecutorBrief
参数	参数类型	描述
duration	Long	子任务持续时长。
description	String	子任务描述。

状态码： 400

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误信息。
detail	String	详细定位信息。

状态码： 500

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误信息。
detail	String	详细定位信息。

请求示例

GET https://{endpoint}/v2/{project_id}/enginemgr/engines/{engine_id}/jobs/{job_id}

响应示例

状态码： 200

查询微服务引擎任务详情结构体。

{
  "id" : 12339,
  "engineId" : "ad76972c-a743-4770-859c-c98a680f4d98",
  "type" : "Create",
  "description" : "",
  "status" : "Finished",
  "scheduling" : 0,
  "createUser" : "test",
  "startTime" : 1636540095901,
  "endTime" : 1636540460230,
  "context" : "string",
  "tasks" : [ {
    "taskName" : "resourcePrepare",
    "taskNames" : [ "TenantTaskExecutor" ],
    "status" : "Finished",
    "startTime" : 1636540100216,
    "endTime" : 1636540110215,
    "taskExecutorBrief" : {
      "duration" : 6000,
      "description" : "资源准备"
    },
    "tasks" : [ {
      "jobId" : 12339,
      "id" : 89117,
      "type" : "Create",
      "assigned" : "string",
      "taskName" : "TenantTaskExecutor",
      "engineName" : "test",
      "taskOrder" : 0,
      "status" : "Init",
      "startTime" : 1636540100216,
      "endTime" : 1636540110215,
      "createTime" : 1636540095910,
      "updateTime" : 1636540110230,
      "timeout" : -1,
      "log" : "string",
      "output" : "{}",
      "taskExecutorBrief" : {
        "duration" : 6000,
        "description" : "租户处理"
      }
    } ]
  } ]
}