文档首页/智能边缘平台 IEF/API参考/API/批量作业管理/查询批量处理作业列表 - ListBatchJob
更新时间：2025-11-18 GMT+08:00
查看PDF
分享

查询批量处理作业列表 - ListBatchJob

功能介绍

查询批量处理作业列表

URI

GET /v2/{project_id}/productmgr/jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

job_type

否

String

批量处理作业类型，支持以下选项：

  • node_upgrade： 节点升级

  • deployment_deploy：应用部署

  • deployment_upgrade：应用升级

limit

否

Integer

查询返回记录的数量限制

offset

否

Integer

偏移量，表示查询该偏移量后面的记录

sort

否

String

查询结果排序，如按照创建时间降序排序为created_at:desc，升序排序为created_at:asc

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

ief-instance-id

否

String

企业版实例ID，专业版实例为空值

Content-Type

是

String

消息体的类型（格式），默认取值为“application/json”

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_count

Integer

数目

jobs

Array of BatchJobForList objects

批量处理作业详情

表5 BatchJobForList

参数

参数类型

描述

job_id

String

批量处理作业ID

job_name

String

批量处理作业名称

job_type

String

批量处理作业类型，支持以下选项：

  • node_upgrade： 节点升级

  • deployment_deploy：应用部署

  • deployment_upgrade：应用升级

created_at

Integer

创建时间戳

status

String

执行状态

task_total_count

Integer

任务总数

task_success_count

Integer

任务项执行成功数

task_failed_count

Integer

任务项执行失败数

status_last_updated_at

Integer

状态更新时间戳

description

String

任务描述

请求示例

无

响应示例

状态码： 200

查询成功

{
  "job_count" : 2,
  "jobs" : [ {
    "job_name" : "aaa",
    "job_type" : "deployment_deploy",
    "job_id" : "66273c66-f72e-4607-8769-3663d255fb83",
    "status" : "Successful",
    "created_at" : 1667218308,
    "status_last_updated_at" : 1667218329,
    "task_total_count" : 2,
    "task_failed_count" : 0,
    "task_success_count" : 2,
    "description" : ""
  }, {
    "job_name" : "test0929-pm",
    "job_type" : "deployment_deploy",
    "job_id" : "0a95c8df-eab5-4a8b-a63b-df9f208ad0ce",
    "status" : "Successful",
    "created_at" : 1664444410,
    "status_last_updated_at" : 1664444411,
    "task_total_count" : 1,
    "task_failed_count" : 0,
    "task_success_count" : 1,
    "description" : ""
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

父主题：批量作业管理