面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/get-work-queue-stats-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

查询 Work 队列状态

GET https://ark.cn-beijing.volces.com/api/v3/environments/{environment_id}/work/stats

查询自托管 Environment 中待拉取、待认领的 Work 数量、活跃 Worker 数及最早入队时间。

本接口仅用于观测 Work 队列,不执行 Work 的拉取、认领、续租或停止。

queued 状态的 Work 由以下两部分构成:

  • depth:尚未被拉取的 Work 数量。
  • pending:已被拉取但尚未认领的 Work 数量。

其他状态请通过查询 Work 列表查看。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • API Key 鉴权,请在 API Key 管理 页面,获取长效 API Key。

请求参数#

Path 参数#

environment_id string 必选  |  环境 ID

要操作的 Environment ID,以 env- 开头。填写创建环境或查询环境列表接口取得的 ID。

响应参数#

depth integer  |  待拉取条数

尚未被任何 Worker 通过拉取 Work 接口获取的 queued 状态 Work 数量。

pending integer  |  待认领条数

已由拉取接口返回给 Worker、但尚未通过认领接口确认的 queued 状态 Work 数量。

type string  |  对象类型

类型标识,固定为 work_queue_stats。

workers_polling integer  |  活跃 Worker 数

最近 30 秒内携带非空 Ark-Worker-ID 发起过 Work 拉取请求的 Worker 数。未携带该请求头的 Worker 不计入本字段,因此该值可能低于实际运行的 Worker 数。

oldest_queued_at string  |  最早入队时间

最早一条 queued 状态 Work 的创建时间,采用 UTC RFC 3339 格式。队列无待处理 Work 时不返回该字段。