跳转到主要内容
API Explorer|API Explorer
系统全局相关/进度条相关接口
GETProgress Bar起始版本 1.11同步需要认证

获取任务进度

获取任务进度

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

查询参数

请求参数

路径参数

  • apiIdString

    任务对应的API ID

查询参数

  • allboolean

    指定获取所有进度信息

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • taskUuidString必填

      任务UUID。

    • taskNameString必填

      任务名称。

    • parentUuidString必填

      父级资源UUID。

    • typeString必填

      类型。

    • contentString必填

      内容。

    • opaqueLinkedHashMap必填

      暂无描述。

    • timeLong必填

      时间。

    • totalStepsInteger必填

      总步骤。

    • currentStepInteger必填

      当前步骤。

    • subTasksList必填

      详情参考subTasks

请求地址

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

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

操作 ID

GetTaskProgress

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/task-progresses/{apiId}?all=True&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "taskUuid": "931102503f64436ea649939ff3957406", "taskName": "org.zstack.header.vm.APICreateVmInstanceMsg", "type": "Task", "content": "Choose backup storage for downloading the image", "time": 1.510669257141E12 } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史