zstackio / doc-ch

ZStack Chinese user manual
Apache License 2.0
12 stars 21 forks source link

[Progress]org.zstack.header.core.progress.APIGetTaskProgressMsg #84

Open mingjian2049 opened 7 years ago

mingjian2049 commented 7 years ago

描述

在zstack中有一类操作是重耗时操作,希望在这类操作的时候能够实时获取操作进度,并展现给用户

API

org.zstack.header.core.progress.APIGetTaskProgressMsg

举例(Example)

当正在migration的时候,通过API获得进度,若迁移未开始或者迁移己完成,返回报错:NO SUCH TASK RUNNING

GetTaskProgressMsg resourceUuid=f995b4e3593c45fabeabd92185d33f91 processType= LocalStorageMigrateVolume

返回结果:

{
   "success": true,
   "createDate": "Dec 15, 2016 1:19:09 PM",
   "lastOpDate": "Dec 15, 2016 1:19:09 PM",
   "processType": "LocalStorageMigrateVolume",
   "progress": "32",
   "resourceUuid": "f995b4e3593c45fabeabd92185d33f91"
}

参数(Parameters)

名字 描述 可选的参数 起始支持版本
processType 操作类型 1.9
resourceUuid 资源的uuid 1.9

返回值(returnValue)

名字 描述
progress 进度值
resourceUuid 资源uuid
processType 操作类型
createDate 任务创建时间
lastOpDate 任务最后汇报时间

备注