跳转到主要内容
ZStack
系统全局相关/长时任务相关接口

提交长时任务

提交长时任务

POST/zstack/v1/longjobs

操作 ID

SubmitLongJob

起始版本

2.3

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • params
    Object必填

    请求体参数结构

    • name
      String

      资源名称

    • description
      String

      资源的详细描述

    • jobName
      String必填

      任务名称

    • jobData
      String必填

      任务数据

    • resourceUuid
      String

      资源UUID

    • targetResourceUuid
      String

      可选UUID目标资源。

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventory
    LongJobInventory必填

    详情参考inventory

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • apiId
      String必填

      用于关联TaskProgress的APIID

    • jobName
      String必填

      任务名称

    • jobData
      String必填

      任务数据

    • jobResult
      String必填

      任务结果

    • targetResourceUuid
      String必填

      目标资源UUID

    • managementNodeUuid
      String必填

      管理节点UUID

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • state
      LongJobState必填

      详情参考state

      • name
        String必填

        资源名称

      • ordinal
        int必填

        ordinal数量。