API

task

URI

http://<server>:<port>/imanager/cloud/web/tasks/{id}[.<format>]

支持的方法

GET

介绍

查询某一指定任务信息的资源。

支持的方法：

GET：获取某一指定任务信息。

支持的表述格式：JSON。

HTTP 请求方法

对如下 URI 执行 HTTP 请求，以 json 输出格式为例加以说明，其中，supermapimanager 是服务器名。

http://supermapimanager:8390/imanager/cloud/web/tasks/{id}.json

GET 请求

获取某一指定任务信息。

请求参数

名称	类型	含义
id	String	【必选参数】请求处理结果id。例如创建环境返回对应任务的id。

响应结构

对task资源执行GET请求，返回任务信息，由以下字段组成：

字段	类型	说明
description	LocaleMessage>	任务描述。
id	String	任务id。
status	TransactionStatus	任务状态，包括DONE(已完成)，ERROR(出错)，PENDING(未完成)，CANCELLING(正在取消)，CANCELLED(已取消)。
steps	TransactionStep[]	任务步骤信息。
timelineId	long	任务执行时间线id。

其中，TransactionStep表示任务步骤信息，由以下字段组成：

字段	类型	说明
description	LocaleMessage	步骤描述。
contents	TransactionStepContent[]	步骤内容信息。
startTime	Calendar	步骤开始时间。
costTime	long	任务步骤花费时间，单位毫秒。

其中，TransactionStepContent表示任务步骤内容信息，由以下字段组成：

字段	类型	说明
isProgressAvailable	boolean	进度是否可用。
message	LocaleMessage	步骤内容描述。
progress	float	进度值。
status	StepStatus	步骤内容状态，包括WAITING(等待前置操作完成)，DONE(已完成)，ERROR(出错)，PENDING(未完成)，CANCELLING(正在取消)，CANCELLED(已取消)。

响应示例

获取某一指定任务信息，即对 task 资源执行GET请求如下：

http://localhost:8390/imanager/cloud/web/tasks/690.json

则返回的json格式响应结果如下：

{
  "description": "创建1个GIS服务器:GIS服务器",
  "id": "690",
  "status": "DONE",
  "steps": [
    {
      "contents": [
        {
          "isProgressAvailable": true,
          "message": "虚拟机sm_iserver-69创建完成",
          "progress": 100,
          "status": "DONE"
        }
      ],
      "costTime": 460000,
      "description": "创建虚拟机",
      "startTime": {
        "dayOfWeek": 3,
        "month": 12,
        "hour": 11,
        "year": 2016,
        "day": 13,
        "minute": 12,
        "second": 46
      }
    },
    {
      "contents": [
        {
          "isProgressAvailable": true,
          "message": "IP192.168.22.69检测成功。",
          "progress": 100,
          "status": "DONE"
        }
      ],
      "costTime": 123000,
      "description": "检测IP",
      "startTime": {
        "dayOfWeek": 3,
        "month": 12,
        "hour": 11,
        "year": 2016,
        "day": 13,
        "minute": 17,
        "second": 6
      }
    },
    {
      "contents": [
        {
          "isProgressAvailable": true,
          "message": "设置附加信息成功",
          "progress": 100,
          "status": "DONE"
        }
      ],
      "costTime": 2000,
      "description": "设置附加信息",
      "startTime": {
        "dayOfWeek": 3,
        "month": 12,
        "hour": 11,
        "year": 2016,
        "day": 13,
        "minute": 18,
        "second": 29
      }
    }
  ],
  "timelineId": 7
}