API文档
云服务器相关接口
异步任务接口
查询异步任务执行进度

1. 查询异步任务执行进度

本接口用于查询资源操作的异步任务执行情况。

1.1. 接口说明

本接口操作类型为 DescribeJobs

1.1.1. 请求路径

POST {baseUrl}/v3/job/DescribeJobs

1.1.2. 请求体

{
  "jobUuid": "c587e4a5ffdb4a1eb866bc21caee8059"
}

请求体内容说明

属性名属性类型是否必须默认值说明
jobUuidString异步任务id

1.1.3. 返回内容

{
  "code": 200,
  "message": "查询异步任务成功",
  "data": [
    {
      "jobUuid": "c587e4a5ffdb4a1eb866bc21caee8059",
      "success": false,
      "progress": 97.0,
      "type": "RebootECS",
      "done": false,
      "resourceUuid": "1d393df7-5ef0-4123-bf44-d2f953efae5e"
    }
  ]
}

返回内容说明

属性名属性类型说明
codeInteger返回码。正常返回 200,异常返回500或其他业务错误码
messageString返回信息
dataArray异步任务执行信息
属性名属性类型说明
jobUuidString异步任务 UUID 号
typeString异步任务名称
resourceUuidString资源 UUID
doneBooleantrue 表示异步任务执行完成,false 表示异步任务正在执行
successBooleantrue 表示异步任务执行成功,false 表示异步任务执行失败或正在执行
progressDouble执行进度

通常情况下:

  1. done 为 false,success 为 false,表示异步任务正在执行。
  2. done 为 true,success 为 false。表示异步任务执行完成,但是执行失败。
  3. done 为 true,success 为 true。表示异步任务执行完成,并最终执行成功。