查询任务列表
功能介绍
根据指定条件查询列举任务的详情。
URI
POST /v1/jobs/list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
start_time |
否 |
String |
参数解释: 查询开始时间。 约束限制: 格式为“yyyy-mm-ddThh:mm:ssZ”。 取值范围: 不涉及。 默认取值: 不涉及。 |
end_time |
否 |
String |
参数解释: 查询结束时间。 约束限制: 格式为“yyyy-mm-ddThh:mm:ssZ”。 取值范围: 不涉及。 默认取值: 不涉及。 |
status |
否 |
String |
参数解释: 任务状态。 约束限制: 不涉及。 取值范围: 1、“Running”:执行中; 2、“Completed”:完成; 3、“Failed”:失败。 默认取值: 不涉及。 |
offset |
否 |
Integer |
参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 必须为数字,不能为负数。 取值范围: [0-4096] 默认取值: 默认为0(偏移0条数据,表示从第一条数据开始查询)。 |
limit |
否 |
String |
参数解释: 查询记录数。 约束限制: 不能为负数。 取值范围: [1-100]。 默认取值: 1。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 返回码。参见错误码章节。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
message |
String |
参数解释: 描述信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
data |
list_jobs_data object |
参数解释: 响应数据。 约束限制: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
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/list
响应示例
状态码:200
列举jobs信息
{ "code" : "LMS.00000000", "message" : "list jobs success", "data" : { "jobs" : [ { "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 |
列举jobs信息 |
错误码
请参见错误码。