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

查询 Work 列表

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

分页查询指定自托管 Environment 中的 Work,适用于查看 Work 状态和排查任务。结果按创建时间从新到旧排列。

鉴权#

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

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

请求参数#

Path 参数#

environment_id string 必选  |  环境 ID

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

Query 参数#

在 URL Query String 中传入。

limit integer 默认值 50  |  每页数量

单页返回的最大条数;大于 200 时按 200 处理。

page string  |  下一页标识

用于告诉服务端从上一页结束的位置继续返回数据。该值由服务端生成,不是页码。

响应参数#

data object[]  |  Work 列表

当前页的 Work 列表。

created_at string  |  创建时间

data.created_at

服务端创建 Work 时记录的时间,格式为 RFC 3339。

data object  |  工作载荷

data.data

Work 对应的 Session 信息。

id string  |  Session ID

data.data.id

Work 对应的 Session ID,可用于调用 Session 相关接口。

type string  |  载荷类型

data.data.type

当前固定为 session,表示 data.id 指向一个 Session。

environment_id string  |  环境 ID

data.environment_id

Work 所属的环境 ID,以 env- 开头。

id string  |  Work 标识符

data.id

Work ID,以 sesn- 开头。

state string  |  当前状态

data.state

Work 当前状态:queued 为已入队,starting 为启动中,active 为执行中,stopping 为停止中,stopped 为已停止。

type string  |  对象类型

data.type

类型标识,固定为 work。

updated_at string  |  更新时间

data.updated_at

Work 最近一次状态迁移的时间,格式为 RFC 3339。

acknowledged_at string  |  认领时间

data.acknowledged_at

Work 被 Worker 成功认领的时间,格式为 RFC 3339;尚未认领时不返回该字段。

latest_heartbeat_at string  |  最近心跳时间

data.latest_heartbeat_at

服务端最近一次接受 Work 心跳的时间,格式为 RFC 3339;尚未收到心跳时不返回该字段。

started_at string  |  开始时间

data.started_at

Work 开始执行的时间,格式为 RFC 3339;尚未开始执行时不返回该字段。

stop_requested_at string  |  停止请求时间

data.stop_requested_at

服务端收到 Work 停止请求的时间,格式为 RFC 3339;尚未收到停止请求时不返回该字段。

stopped_at string  |  停止时间

data.stopped_at

Work 进入 stopped 状态的时间,格式为 RFC 3339;尚未停止时不返回该字段。

tags object[]  |  资源标签

data.tags

与当前 Work 关联的资源标签列表。

key string  |  标签键

data.tags.key

资源标签的键,用于标识当前 Work 关联的标签。

value string  |  标签值

data.tags.value

资源标签的值,用于描述当前 Work 在该标签键下的取值;未设置值时不返回该字段。

next_page string  |  下一页标识

服务端生成的下一页标识。返回该字段表示还有更多结果;不返回表示已到最后一页。