QueueMonitor

任务队列监控器(QueueMonitor)

[GET] /api/v2/common/task-queue-monitor

获取任务队列监控数据.

响应

状态代码: 200

成功

QueueStatsResponseModel

状态代码: 400

错误请求

ServerPluginError

模型定义

Ƭ QueueStatsResponseModel

返回任务队列统计数据模型

名称	类型	描述	示例
workers可为空	WorkerInfo	获取或设置各个工作节点的信息列表
tasks可为空	CommonTaskInfo	获取或设置任务信息列表

Ƭ WorkerInfo

名称	类型	描述	示例
id可为空	string
url可为空	string
lastSeen	ISO DateTime Sting
tasksInProgress	int32
displayName可为空	string
specializations可为空	`Array<string>`

Ƭ CommonTaskInfo

一般任务信息的响应模型

名称	类型	描述
taskID	TaskID
workerUrl可为空	string	获取或设置工作节点地址(url)
workerID可为空	string	获取或设置工作节点Id
initiator可为空	string	获取或设置工作节点发起人
documentName可为空	string	获取或设置文档名称
documentId可为空	string	获取或设置文档Id
documentType可为空	string	获取或设置文档类型
startTime	ISO DateTime Sting	获取或设置任务开始时间
endTime可为空	ISO DateTime Sting	获取或设置任务结束时间
progress可为空	string	获取或设置任务进程
errorMessage可为空	string	获取或设置错误信息
description可为空	string	获取或设置任务描述信息
breakStatus	CommonTaskInfo+TaskStatus
status	CommonTaskInfo+TaskStatus
type	CommonTaskInfo+TaskType

Ƭ TaskID

名称	类型	描述	示例
parent	TaskID
id可为空	string

Ƭ CommonTaskInfo+TaskStatus

枚举:

NotStarted
WaitingForActivation
WaitingToRun
Started
ReadingResult
Verifying
Canceled
Failed
Finished

任务状态枚举

* NotStarted - 0 - 尚未开始
* WaitingForActivation - 1 - 等待激活
* WaitingToRun - 2 - 等待执行
* Started - 3 - 运行中
* ReadingResult - 4 - 读取结果
* Verifying - 5 - 验证
* Canceled - 6 - 已取消
* Failed - 7 - 失败
* Finished - 8 - 已完成

Ƭ CommonTaskInfo+TaskType

枚举:

Queue
Scheduler

任务类型的枚举

* Queue - 0 - 队列任务
* Scheduler - 1 - 计划任务

Ƭ ServerPluginError

服务器插件错误

名称	类型	描述
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	ServerPluginError