data statistic

本页内容主要介绍相关的信息统计相关的 API 支持，这些 API 一般来说和需求有很大关系，比较容易变动，和业务有一定关系。

1.统计某段时间内的任务运行状态

说明：统计某时间段的所有工作流的状态信息, 所属项目 "有执行权限的用户和项目所有者可以查询"，这里按天进行了汇总。注意时间段不能超过 30 天。

GET  /statistic/states
Parameters: projectName={projectName}&startTime={startTime}&endTime={endTime}

Response:
Status: 200 OK
[
  {
    "date": 1468391778000, # 注意是某天的，可以格式化为 yyyy-MM-dd
    "info": {
      "init": 1,
      "waitingDep": 1,
      "waitingRes": 1,
      "running": 10,
      "success": 1,
      "kill": 1,
      "failed": 0,
      "depFailed": 0,
      "inactive": 0,
      "total":15
    }
  },
  {
    "date": 1468392778000,
    "info": {
      "init": 1,
      "waitingDep": 1,
      "waitingRes": 1,
      "running": 10,
      "success": 1,
      "kill": 1,
      "failed": 0,
      "depFailed": 0,
      "inactive": 0,
      "total": 15
    }
  }
]

参数说明：

参数	类型	是否必选	描述	说明
projectName	string	是	项目名称
startTime	long	是	起始时间，毫秒时间戳
endTime	long	是	结束时间，毫秒时间戳	注意，时间跨度有效范围为：(0,30]

返回说明：

参数	类型	是否必选	描述	说明
date	long	是	具体日期，毫秒时间戳
info	jsonObject	是	具体的详情

info 结构说明：

参数	类型	是否必选	描述	说明
init	int	是	初始化中的任务数
waitingDep	int	是	调度依赖任务中
waitingRes	int	是	调度依赖资源中
running	int	是	运行中的任务数
success	int	是	成功的任务数
kill	int	是	kill 的任务数
failed	int	是	失败的任务数
depFailed	int	是	依赖失败的任务数
inactive	int	是	暂停的任务数
total	int	是	总任务数

2.统计某天的分小时级别的任务运行状态

说明：统计某天的小时段的所有工作流的状态信息, 所属项目 "有执行权限的用户和项目所有者可以查询"，这里按小时进行了汇总。

GET  /statistic/states-hour
Parameters: projectName={projectName}&date={date}

Response:
Status: 200 OK
[
  {
    "hour": 0, # 0 ~23
    "info": {
      "init": 1,
      "waitingDep": 1,
      "waitingRes": 1,
      "running": 10,
      "success": 1,
      "kill": 1,
      "failed": 0,
      "depFailed": 0,
      "inactive": 0,
      "total": 15
    }
  },
  {
    "hour": 1,
    "info": {
      "init": 1,
      "waitingDep": 1,
      "waitingRes":1,
      "running": 10,
      "success": 1,
      "kill": 1,
      "failed": 0,
      "depFailed": 0,
      "inactive": 0,
      "total": 15
    }
  }
]

参数说明：

参数	类型	是否必选	描述	说明
projectName	string	是	项目名称
date	long	是	具体的日期

返回说明：

参数	类型	是否必选	描述	说明
hour	int	是	时间段	0~23
info	jsonObject	是	具体的详情

info 结构说明同上。

3.工作流耗时排行

说明：统计某天的工作流耗时排行信息, 所属项目 "有执行权限的用户和项目所有者可以查询"。

GET  /statistic/consumes
Parameters: projectName={projectName}&date={date}&num={num}

Response:
Status: 200 OK
[
  {
    "projectName": "project name",
    "workflowName": "workflow name",
    "owner": "owner of the workflow",
    "startTime": 1468392778000,
    "endTime": 1468392778000,
    "duration": 13,
    "execId": "xxx",
    "proxyUser": "abc",
    "status": 0
  }
]

参数说明：

参数	类型	是否必选	描述	说明
projectName	string	是	项目名称
date	long	是	查询的日期
num	int	否	返回的结果数	默认为 10，有效值 (0, 100]

返回说明：

参数	类型	是否必选	描述	说明
projectName	string	是	项目名称
workflowName	string	是	工作流名称
owner	int	是	工作流责任人
startTime	long	是	开始运行时间
endTime	long	否	结束运行时间
duration	int	是	当前的耗费时间，单位 "秒"	3201
execId	string	是	执行 id
proxyUser	string	是	执行的代理用户
status	int	是	执行状态

4.工作流出错排行

说明：统计某天的工作流出错排行信息, 所属项目 "有执行权限的用户和项目所有者可以查询"。

GET  /statistic/errors
Parameters: projectName={projectName}&date={date}&num={num}

Response:
Status: 200 OK
[
  {
    "projectName": "project name",
    "workflowName": "workflow name",
    "owner": "owner of the workflow",
    "proxyUser":test
    "times": 20
  }
]

参数说明：

参数	类型	是否必选	描述	说明
projectName	string	是	项目名称
date	long	是	查询的日期
num	int	否	返回的结果数	默认为 10，有效值 (0, 100]

返回说明：

参数	类型	是否必选	描述	说明
projectName	string	是	项目名称
workflowName	string	是	工作流名称
owner	int	是	工作流责任人
proxyUser	string	是	工作流执行代理用户
times	int	是	出错的次数