[]
        
在线Demo 免费试用
(Showing Draft Content)

QueueMonitor

QueueMonitor

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

获取队列监控统计信息。

返回值

状态码: 200

成功

QueueStatsResponseModel

状态码: 400

错误的请求

ServerPluginError

类型定义

Ƭ QueueStatsResponseModel

表示排队统计响应模型。

名称 类型 描述 示例
workers可为空 WorkerInfoViewModel 获取或设置员工信息列表。
tasks可为空 CommonTaskInfo 获取或设置任务信息列表。

Ƭ WorkerInfoViewModel

构建员工信息模型。

名称 类型 描述 示例
id可为空 string 获取或设置工作者 ID。
url可为空 string 获取或设置工作进程 URL。
lastSeen ISO DateTime Sting 获取或设置工作人员的最后在线时间。
tasksInProgress int32 获取或设置工作人员正在进行的任务数量。
displayName可为空 string 获取或设置工作进程的显示名称。
specializations可为空 Array<string> 获取或设置工人的专业技能。

Ƭ CommonTaskInfo

表示一个通用的任务信息响应模型。

名称 类型 描述 示例
taskID TaskIDViewModel
workerUrl可为空 string 获取或设置工作进程 URL。
workerID可为空 string 获取或设置工作进程 ID。
initiator可为空 string 获取或设置任务发起者。
documentName可为空 string 获取或设置文档名称。
displayDocName可为空 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

Ƭ TaskIDViewModel

表示任务 ID 视图模型。

名称 类型 描述 示例
id可为空 string 获取或设置任务 ID。
parent TaskIDViewModel

Ƭ CommonTaskInfo+TaskStatus

Enum:

  • 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

Enum:

  • Queue
  • Scheduler

任务类型枚举。

* 队列 - 0 - 队列任务。
* 调度器 - 1 - 调度器任务。

Ƭ ServerPluginError

服务器插件错误

名称 类型 描述 示例
code可为空 string 错误代码
message可为空 string 错误信息
context可为空 string 错误上下文
innerError ServerPluginError
extensions可为空 any 扩展结果