更新 Work 元数据

将 metadata 修改合并到 work item。

POST /api/v1/cloud/environments/{environment_id}/work/{work_id}

更新 work item 上的仅字符串 metadata map。该接口使用 merge-patch 语义：字符串值 upsert key，null 值删除 key。

​

路径参数

参数	类型	说明
environment_id	string	Environment ID，前缀为 env_
work_id	string	Work item ID，前缀为 work_

​

请求头

头部	必选	说明
Authorization	是	Bearer $QODER_PAT
Content-Type	是	application/json

​

请求体

字段	类型	必选	说明
metadata	object	否	Work metadata merge patch。字符串值 upsert key；null 删除 key。省略时返回当前 item，不修改 metadata

​

示例请求

curl -X POST "https://api.qoder.com/api/v1/cloud/environments/env_019e64e01a137caf953ac2ac7b42ec5c/work/work_019f3be4fd2475d9a784bf2c739e1194" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "worker": "byoc-worker-01",
      "obsolete_key": null
    }
  }'

​

示例响应

HTTP 200 OK

{
  "id": "work_019f3be4fd2475d9a784bf2c739e1194",
  "type": "work",
  "environment_id": "env_019e64e01a137caf953ac2ac7b42ec5c",
  "data": {
    "type": "session",
    "id": "sess_019f3be3fa66750bb9a1fbcde85b5fe1"
  },
  "state": "active",
  "created_at": "2026-07-01T08:15:01Z",
  "acknowledged_at": "2026-07-01T08:15:04Z",
  "started_at": "2026-07-01T08:15:06Z",
  "latest_heartbeat_at": "2026-07-01T08:16:06.120394Z",
  "stop_requested_at": null,
  "stopped_at": null,
  "metadata": {
    "job": "daily-report",
    "worker": "byoc-worker-01"
  }
}

​

响应字段

返回更新后的 Work item 对象。

​

错误码

HTTP	type	触发条件
400	invalid_request_error	请求体不是合法 JSON
400	invalid_request_error	metadata 中存在既不是 string 也不是 null 的值
400	invalid_request_error	Environment 不是 self_hosted
401	authentication_error	PAT 无效或过期
403	permission_error	无权限执行此操作
404	not_found_error	Environment 或 work item 不存在

完整错误信封格式见 错误参考。

​

相关

云端环境

选择 Agent 运行的容器、网络与依赖。