文档首页/ 数据工坊 DWR/ LMS API参考/ API/ 任务查询接口/ 获取指定ID任务信息
更新时间：2025-07-18 GMT+08:00
查看PDF
分享

获取指定ID任务信息

功能介绍

根据指定的jobid查询任务信息。用于在创建和删除知识仓实例操作执行成功后，通过响应中返回的job_id，来查询创建和删除知识仓实例执行的具体结果。

URI

POST /v1/jobs/describe

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

job_id

是

String

参数解释：

创建知识仓实例的任务id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

code

String

参数解释：

返回码。参见错误码章节。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

message

String

参数解释：

描述信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

data

job_data object

参数解释：

任务详情。

约束限制：

不涉及。
表3 job_data

参数

参数类型

描述

job_id

String

参数解释：

创建知识仓实例的任务id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

status

String

参数解释：

任务执行状态。

约束限制：

不涉及。

取值范围：

Running：任务正在执行

Completed：任务执行成功

Failed：任务执行失败

默认取值:

不涉及。

name

String

参数解释：

任务名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

create_time

String

参数解释：

创建时间。

约束限制：

格式为“yyyy-mm-ddThh:mm:ssZ”。

取值范围：

不涉及。

默认取值:

不涉及。

end_time

String

参数解释：

结束时间。

约束限制：

格式为“yyyy-mm-ddThh:mm:ssZ”。

取值范围：

不涉及。

默认取值:

不涉及。

progress

String

参数解释：

任务执行进度。运行中状态返回执行进度，例如“60%”，表示任务执行进度为60%。

约束限制：

不涉及。

取值范围：

[1%-100%]。

默认取值:

不涉及。

store_name

String

参数解释：

知识仓实例名称，region内唯一。

约束限制：

长度范围为3到63个字符，支持小写字母、数字、中划线（-），第一个字符只能够是小写字母，中划线(-)不得出现在字符串末尾。

取值范围：

不涉及

默认取值：

不涉及

fail_reason

String

参数解释：

任务执行失败时的错误信息。

约束限制：

当status是Failed时生效。

取值范围：

不涉及。

默认取值:

不涉及。

请求示例

/v1/jobs/describe

{
  "job_id" : "8234ba08-74ca-4a23-b129-460f73537dfe"
}

响应示例

状态码：200

执行成功，返回指定job的信息

{
  "code" : "LMS.00000000",
  "message" : "Describe job success",
  "data" : {
    "job_id" : "8234ba08-74ca-4a23-b129-460f73537dfe",
    "name" : "CREATE_INSTANCE_JOB",
    "status" : "Completed",
    "create_time" : "2025-07-16T09:21:44Z",
    "end_time" : "2025-07-16T09:21:45Z",
    "progress" : "100%",
    "store_name" : "test-storename"
  }
}

状态码

状态码

描述

200

执行成功，返回指定job的信息

错误码

请参见错误码。

父主题： 任务查询接口

相关文档