Skip to content

10.任务管理

1. 查询子任务详情

接口地址: /v1/task/{jobId}

请求方式:GET

请求数据类型:application/json

响应数据类型:*/*,application/json

支持版本:v1.0.0

接口描述:

查询单个子任务的执行详情

请求参数:

参数名称 参数说明 位置 是否必须 数据类型 描述
jobId 调用接口后返回的 jobId path true string 任务 id

请求示例,实际请求请替换参数值:

POST "/openapi/v1/task/5d5d1e43226f4a348c883643696e045f"

响应参数:

参数名称 参数说明 类型 描述
code 返回代码 integer(int32)
message 返回处理消息 string
result 返回数据对象 object
  traceId 业务ID string
  jobId 任务ID string
  message 执行结果描述 string
  uuid 资源UUID string
  sn sn string 板卡操作:申请板卡、创建容器、云盘挂载卸载等会返回
methodDesc 任务类型 string
  method 方法名称 string
  armCardIp 板卡IP string 容器类操作:重启、重置、启动、停止、备份等容器纬度会返回
  status 任务状态码 integer -1,0:执行失败;1:等待中; 2:执行成功; 3:进行中; 4:取消中; 5:已取消
  data 执行具体内容 object
    stdOut 执行内容输出 list
    stdErr 执行异常输出 list
  beginTime 任务开始时间 string
  endTime 任务结束时间 string
timestamp 时间戳 integer(int64)

响应示例:

{
    "message": "操作成功!",
    "code": 200,
    "result": {
        "traceId": "C20250822151033726037",
        "jobId": "5169daa682384453a6c523572b4587e4",
        "methodDesc": "执行异步命令",
        "method": "InstanceCommandSync",
        "data": {
            "stdOut": [
                "/",
                ""
            ],
            "stdErr": [
                ""
            ]
        },
        "beginTime": "2025-08-22 15:10:33",
        "endTime": "2025-08-22 15:10:34",
        "message": "任务成功",
        "uuid": "qs-fs-pre-fmmjbdac7ye24o40",
        "status": 2,
        "armCardIp": "172.30.0.40"
    },
    "timestamp": 1755847993501
}

2. 查询子任务列表

接口地址: /v1/task/list

请求方式:GET

请求数据类型:application/json

响应数据类型:*/*,application/json

支持版本:v1.0.0

接口描述:

查询单个或多个批次任务(主任务)的子任务列表

请求参数:

参数名称 参数说明 位置 是否必须 数据类型 描述
traceIds 调用接口后返回的traceId列表 body true string
offset 查询的起始位置 body false integer 不填默认0
limit 单次查询条数 body false integer 不填默认100

请求示例:

POST "/openapi/v1/task/list"
body:
{
    "offset": 0,
    "limit": 100,
    "traceIds": [
        "C20250822151034530048"
    ]
}

响应参数:

参数名称 参数说明 类型 描述
code 返回代码 integer(int32)
message 返回处理消息 string
result 返回数据对象 object
  jobs 任务对象 object
    jobId 任务ID string
    message 执行结果描述 string
    uuid 资源uuid string
    status 状态码 integer -1,0:执行失败;1:等待中;2:执行成功; 3:进行中; 4:取消中; 5:已取消
methodDesc 任务类型 string
    method 方法名称 string
armCardIp 板卡IP string
    sn 板卡sn string
    data 执行具体内容 object
      stdOut 执行内容输出 List
      stdErr 执行异常输出 List
    beginTime 任务开始时间 string
    endTime 任务结束时间 string
timestamp 请求时间戳 interger(int64)
traceId 批量任务请求处理ID string

响应示例:

{
  "message": "操作成功!",
  "code": 200,
  "result": [
    {
      "traceId": "C20250822151034530048",
      "jobs": [
        {
          "traceId": "C20250822151034530048",
          "jobId": "f58a02ab832845f99348b3d26b85330a",
          "methodDesc": "执行异步命令",
          "method": "InstanceCommandSync",
          "data": {
            "stdOut": [
              "/",
              ""
            ],
            "stdErr": [
              ""
            ]
          },
          "beginTime": "2025-08-22 15:10:34",
          "endTime": "2025-08-22 15:10:34",
          "message": "任务成功",
          "uuid": "qs-fs-pre-fmmjbdac7ye24o40",
          "status": 2,
          "armCardIp": "172.30.0.40"
        }
      ]
    }
  ],
  "timestamp": 1755846640915
}