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

查询批量处理作业详情

功能介绍

查询批量处理作业详情

调试

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

URI

GET /v2/{project_id}/productmgr/jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

job_id

是

String

批量处理作业ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

ief-instance-id

否

String

铂金版实例ID，专业版实例为空值

Content-Type

是

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

job_id

String

批量处理作业ID

job_name

String

批量处理作业名称

job_type

String

批量作业类型，支持以下选项： - node_upgrade： 节点升级 - deployment_deploy：应用部署 - deployment_upgrade：应用升级

description

String

描述

created_at

Integer

创建时间戳

status

String

执行状态

task_total_count

Integer

任务总数

task_failed_count

Integer

任务项执行成功数

task_success_count

Integer

任务项执行失败数

target_type

String

批量作业对象类型，支持如下选项： - node：边缘节点 - node_group：边缘节点组 - deployment：边缘应用

task_data

String

批量作业内容，仅在批量应用部署和批量应用升级时需要填写，填入的内容为：使用json结构体编写的创建应用部署接口请求体deployment参数，并将其转换为字符串

tasks

Array of Task objects

任务项详情

targets

Array of Target objects

批量处理对象详情

status_last_updated_at

Integer

状态更新时间戳
表4 Task

参数

参数类型

描述

task_id

String

任务项ID

task_name

String

任务项名称

status

String

任务项状态

reason

String

任务项失败的原因

created_at

Integer

创建时间戳

target_id

String

批量处理对象ID

extension_info

Array of Extension objects

批量处理对象基本信息
表5 Target

参数

参数类型

描述

extension_info

Array of Extension objects

批量处理对象基本信息

target_id

String

批量处理对象ID
表6 Extension

参数

参数类型

描述

key

String

属性名，可填：node_name

value

String

属性值

请求示例

无

响应示例

状态码： 200

查询成功

{
  "job_name" : "aaa",
  "job_id" : "66273c66-f72e-4607-8769-3663d255fb83",
  "job_type" : "deployment_deploy",
  "target_type" : "node",
  "description" : "",
  "targets" : [ {
    "target_id" : "72eb5df1-295b-41f6-baed-d1a56728b0e0",
    "extension_info" : [ {
      "key" : "node_name",
      "value" : "test1"
    } ]
  }, {
    "target_id" : "b1c0e722-ee98-4ae3-9224-881224cb32c9",
    "extension_info" : [ {
      "key" : "node_name",
      "value" : "test2"
    } ]
  } ],
  "task_data" : "{\"deployment\":{\"replicas\":1,\"template\":{\"configs\":{\"host_network\":false,\"restart_policy\":\"Always\",\"host_pid\":false},\"containers\":[{\"name\":\"container-06fefd36\",\"version\":\"latest\",\"image_url\":\"sample:latest\",\"envs\":[],\"volumes\":[],\"resources\":{\"limits\":{\"cpu\":\"0.25\",\"memory\":\"512\"},\"requests\":{\"cpu\":\"0.25\",\"memory\":\"512\"}},\"privileged\":false,\"ports\":[]}]}},\"source\":\"userdefined\",\"name_prex\":\"aaa\",\"tags\":[],\"description\":\"\"}",
  "status" : "Successful",
  "created_at" : 1667218308,
  "status_last_updated_at" : 1667218329,
  "tasks" : [ {
    "task_name" : "aaa-c530d",
    "task_id" : "382cca3e-88e6-4a7c-bf23-b637a99761f9",
    "target_id" : "72eb5df1-295b-41f6-baed-d1a56728b0e0",
    "status" : "Successful",
    "created_at" : 1667218324,
    "reason" : "",
    "extension_info" : [ {
      "key" : "deployment_id",
      "value" : "9bdefd92-c724-41f4-b07a-4b1061e096d6"
    } ]
  }, {
    "task_name" : "aaa-ce854",
    "task_id" : "ac04605b-c286-4f23-97e0-fe08366c36f5",
    "target_id" : "b1c0e722-ee98-4ae3-9224-881224cb32c9",
    "status" : "Successful",
    "created_at" : 1667218325,
    "reason" : "",
    "extension_info" : [ {
      "key" : "deployment_id",
      "value" : "4b4c7b0c-7ee8-4a7e-b79e-9291b7fd365d"
    } ]
  } ],
  "task_total_count" : 2,
  "task_failed_count" : 2,
  "task_success_count" : 0
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

父主题： 批量作业管理

相关文档