跳转到主要内容
ZStack
系统全局相关/进度条相关接口

获取任务进度

获取任务进度

GET/zstack/v1/task-progresses/{apiId}

操作 ID

GetTaskProgress

起始版本

1.11

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

路径参数

  • apiId
    String

    任务对应的API ID

查询参数

  • all
    boolean

    指定获取所有进度信息

  • 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

  • inventories
    List必填

    详情参考inventories

    • taskUuid
      String必填

      任务UUID。

    • taskName
      String必填

      任务名称。

    • parentUuid
      String必填

      父级资源UUID。

    • type
      String必填

      类型。

    • content
      String必填

      内容。

    • opaque
      LinkedHashMap必填

      不透明。

    • time
      Long必填

      时间。

    • totalSteps
      Integer必填

      总步骤。

    • currentStep
      Integer必填

      当前步骤。

    • subTasks
      List必填

      详情参考subTasks