更新时间:2025-10-11 GMT+08:00
分享

查询任务列表

功能介绍

查询任务列表接口用于获取当前用户下的任务列表。该接口适用于以下场景:当需要查看任务状态、管理任务进度或统计任务数量时,用户可通过此接口获取当前用户下所有任务的详细信息。使用该接口的前提条件是用户已登录系统且具有查看任务的权限。调用接口成功后,系统将返回当前用户下的任务列表,包括任务ID、名称、状态、创建时间等信息。若用户未登录、无权限访问或系统中未配置任务,接口将返回相应的错误信息。

调试

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

URI

GET /v2/{project_id}/jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:用户项目ID。获取方法请参见获取项目ID和名称

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

type

String

参数解释:任务类型。

约束限制:不涉及。

取值范围:可选值如下:

  • replace-node:故障节点替换任务。

  • reboot-node:节点重启任务。

  • reset-nodes:节点重置任务。

默认取值:不涉及。

limit

Integer

参数解释:单页查询最大数量,该值为空时默认返回100条记录,单页最大允许查询500条记录。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

offset

Integer

参数解释:分页查询的偏移量,查询第一页时为空。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

since

Long

参数解释:查询起始时间,单位毫秒。默认从30天前开始查询。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

until

Long

参数解释:查询终止时间,单位毫秒。默认当前时间。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

resource

String

参数解释:任务关联的资源类型。

约束限制:不涉及。

取值范围:可选值如下:

  • pools:资源池

默认取值:不涉及。

name

String

参数解释:关联的资源名称,与resource配合使用。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

count

Integer

参数解释: 结果总数。

取值范围: 不涉及。

items

Array of PoolJob objects

参数解释:job列表。

表4 PoolJob

参数

参数类型

描述

startTimestamp

Long

参数解释: job开始处理时间,单位毫秒。

取值范围: 不涉及。

endTimestamp

Long

参数解释: Job结束时间,单位毫秒。

取值范围: 不涉及。

jobId

String

参数解释: 任务ID。

取值范围: 不涉及。

jobName

String

参数解释: 任务名称。

取值范围: 不涉及。

involvedObjects

String

参数解释: Job关联的资源,比如资源池描述。

取值范围: 不涉及。

inputs

String

参数解释: Job输入参数。

取值范围: 不涉及。

phase

String

参数解释: Job状态。

取值范围: 可选值如下:

  • Running:任务正在运行中。

  • Success:任务执行成功。

  • Failed:任务执行失败。

suspend

Boolean

参数解释: Job是否被挂起。

取值范围: 不涉及。

type

String

参数解释: Job类型。

取值范围: 不涉及。

conditions

String

参数解释: Job的执行过程信息。

取值范围: 不涉及。

message

String

参数解释: Job执行失败时返回执行信息。

取值范围: 不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:ModelArts错误码。

取值范围:不涉及。

error_msg

String

参数解释:具体错误信息。

取值范围:不涉及。

请求示例

查询节点重启任务列表。

GET https://{endpoint}/v2/{project_id}/jobs?type=reboot-node

{ }

响应示例

状态码:200

作业列表响应体。

{
  "count" : 22,
  "items" : [ {
    "startTimestamp" : 1757935854000,
    "endTimestamp" : 1757935891000,
    "jobId" : "8777d6bc-fee5-4c47-b46d-884189898ecb",
    "jobName" : "reboot-node-pool-b15e-6f5da086876d4cd084d36f8bd3346036-tbl97",
    "inputs" : "[{\"name\":\"PoolName\",\"value\":\"pool-b15e-6f5da086876d4cd084d36f8bd3346036\"},{\"name\":\"NodeName\",\"value\":\"os-node-created-4n6s7\"}]",
    "involvedObjects" : "[{\"kind\":\"Pool\",\"name\":\"pool-b15e-6f5da086876d4cd084d36f8bd3346036\",\"uid\":\"df88e877-08fa-44ab-9f0c-2926c4814ea2\",\"apiVersion\":\"os.modelarts.huaweicloud/v1\",\"resourceVersion\":\"1804287231\"}]",
    "type" : "reboot-node",
    "phase" : "Success",
    "conditions" : "[{\"type\":\"Complete\",\"status\":\"True\",\"lastTransitionTime\":\"2025-09-15T11:31:31Z\",\"reason\":\"Success\",\"message\":\"reboot progress: total: 1, completd: 1, rebooting: 0, failed: 0\"}]"
  }, {
    "startTimestamp" : 1757934802000,
    "endTimestamp" : 1757934803000,
    "jobId" : "52cf3c70-4e3a-4a28-8e03-3ce075482a0c",
    "jobName" : "reboot-node-pool-b15e-6f5da086876d4cd084d36f8bd3346036-mn4vh",
    "inputs" : "[{\"name\":\"PoolName\",\"value\":\"pool-b15e-6f5da086876d4cd084d36f8bd3346036\"},{\"name\":\"NodeName\",\"value\":\"os-node-created-62g8b\"}]",
    "involvedObjects" : "[{\"kind\":\"Pool\",\"name\":\"pool-b15e-6f5da086876d4cd084d36f8bd3346036\",\"uid\":\"df88e877-08fa-44ab-9f0c-2926c4814ea2\",\"apiVersion\":\"os.modelarts.huaweicloud/v1\",\"resourceVersion\":\"1804282251\"}]",
    "type" : "reboot-node",
    "phase" : "Failed",
    "conditions" : "[{\"type\":\"Complete\",\"status\":\"False\",\"lastTransitionTime\":\"2025-09-15T11:13:22Z\",\"reason\":\"Failed\",\"message\":\"reboot progress: total: 1, completd: 0, rebooting: 0, failed: 1, failedNodes[os-node-created-62g8b: duration must between 900 seconds(15 minutes) and 43200 seconds(12 hours)]\"}]",
    "message" : "os-node-created-62g8b: duration must between 900 seconds(15 minutes) and 43200 seconds(12 hours)"
  } ]
}

状态码

状态码

描述

200

作业列表响应体。

400

Error response

错误码

请参见错误码

相关文档