# 查询任务列表 - ListJobs #### 功能介绍 查询任务列表。 #### URI GET /v1/jobs 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释** 返回结果个数限制，用于控制单次查询返回的最大记录数。 **约束限制** 不涉及。 **取值范围** 值为大于0的整数。 **默认取值** 1000。 | | offset | 否 | Integer | **参数解释** 偏移量，用于分页查询，从第offset+1条记录开始返回结果。 **约束限制** 不涉及。 **取值范围** 值为大于等于0的整数。 **默认取值** 0。 | | job_type | 否 | String | **参数解释** job类型，用于区分不同类型任务的查询。 **约束限制** 不涉及。 **取值范围** - short: 短时间运行任务。 - long: 长时间运行任务。 **默认取值** short。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | jobs | Array of [JobDetail] objects | **参数解释** 任务列表信息。 **取值范围** 任务对象数组，最多1000个元素。 | 表3JobDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释** 任务标识符，全局唯一。 **取值范围** 不涉及。 | | cluster_id | String | **参数解释** 任务所关联的集群ID，与任务ID一对一关联。 **取值范围** 由数字、小写字母和连字符组成，且长度为0-36个字符。 | | name | String | **参数解释** 任务名称，用于标识和识别不同的任务。 **取值范围** 由任意字符组成，且长度为1-128个字符。 | | status | String | **参数解释** 任务状态，用于标识任务执行的当前状态。 **取值范围** - INIT：初始化。 - RUNNING：运行中。 - STOPPED：已停止。 - FAILED：失败。 - COMPLETED：已完成。 | | progress | Double | **参数解释** 任务执行进度，以百分比表示，用于显示任务的当前完成程度。 **取值范围** 0-100。 | | message | String | **参数解释** 任务信息，当前message仅返回错误码，格式为ems.000x，用于标识任务执行过程中的错误类型。 **取值范围** 由字母、数字和连字符组成，且长度为1-32个字符。 | | created_at | String | **参数解释** 任务创建时间，记录任务被创建的时间点。 **取值范围** 使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ssZ，例如：2020-09-25T12:05:00Z。 | | begin_at | String | **参数解释** 任务执行开始时间，记录任务开始。 **取值范围** 不涉及。 | | end_at | String | **参数解释** 任务执行结束时间，记录任务完成执行的时间点。 **取值范围** 使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ssZ，例如：2020-09-25T12:05:00Z。 | | task_list | Array of [TaskInfo] objects | **参数解释** 任务子任务列表，包含任务执行过程中的所有子任务详情。 **取值范围** 任务子任务数组，最多16个元素。 | 表4TaskInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释** 任务子任务标识符，用于唯一标识任务下的子任务。 **取值范围** 由字母、数字、连字符(-)和下划线(_)组成，且必须以"short-"或"long-"开头，长度为0-48个字符。 | | status | String | **参数解释** 任务子任务状态，用于标识子任务执行的当前状态。 **取值范围** - INIT：初始化。 - RUNNING：运行中。 - STOPPED：已停止。 - FAILED：失败。 - COMPLETED：已完成。 | | message | String | **参数解释** 任务子任务详情描述，用于说明子任务执行过程中的具体信息或错误原因。 **取值范围** 由任意字符组成，且长度为1-128个字符。 | | created_at | String | **参数解释** 任务子任务创建时间，记录子任务被创建的时间点。 **取值范围** 使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ssZ，例如：2020-09-25T12:05:00Z。 | | begin_at | String | **参数解释** 任务子任务执行开始时间，记录子任务开始执行的时间点。 **取值范围** 使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ssZ，例如：2020-09-25T12:05:00Z。 | | end_at | String | **参数解释** 任务子任务执行结束时间，记录子任务完成执行的时间点。 **取值范围** 使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ssZ，例如：2020-09-25T12:10:00Z。 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** 错误码，用于标识具体的错误类型。 **取值范围** 不涉及。 | | error_msg | String | **参数解释** 错误描述，用于说明具体的错误信息。 **取值范围** 不涉及。 | #### 请求示例 查询任务列表，任务类型为short，每页返回10个记录，从第2条记录（offset=1）开始返回结果。 ``` GET https://{endpoint}/v1/jobs?limit=10&offset=1&job_type=short ``` #### 响应示例 **状态码：200** **参数解释** 查询成功响应。 **取值范围** 不涉及。 ``` { "jobs" : [ { "id" : "short-055c00f6-6c71-11f0-916e-0255ac1001b5", "cluster_id" : "451496c1-41cb-44bc-a0c2-facbfd2ec311", "name" : "string", "status" : "INIT", "progress" : 60, "message" : "string", "created_at" : "string", "begin_at" : "string", "end_at" : "string", "task_list" : [ { "id" : "long-055c00f6-6c71-11f0-916e-0255ac1001b5", "status" : "INIT", "message" : "Task execution completed successfully", "created_at" : "2024-01-01T10:00:00Z", "begin_at" : "2024-01-01T10:05:00Z", "end_at" : "2024-01-01T10:10:00Z" } ] } ] } ``` **状态码：400** **参数解释** 错误响应体。 **取值范围** 不涉及。 ``` { "error_code" : "EMS.00004000", "error_msg" : "invalid parameter" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | **参数解释** 查询成功响应。 **取值范围** 不涉及。 | | 400 | **参数解释** 错误响应体。 **取值范围** 不涉及。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ems/ems_04_0031.html)。