释放运行队列项

方法: POST

端点: /api/v2/run-queue/items/release

认证: 支持 Authorization: Bearer <YOUR_API_KEY>、api-key: <YOUR_API_KEY> 和 ?token=<YOUR_API_KEY>。推荐优先使用 Bearer token。

在线试用

POST/api/v2/run-queue/items/releaseRelease run queue items

AuthenticationRequired

Auth mode

Authorization: Bearerapi-key headerQuery token

API token

Stored only in this browser tab. Sent only to https://openapi.coreclaw.com.

Request BodyRequiredapplication/json

FieldTypeRequiredDescription

queue_refsarrayRequiredQueue item IDs.

reasonstringOptionalRelease reason.

Request body (JSON)Reset to example

{ "queue_refs": [], "reason": "YOUR_REASON" }

Send Request Clear all

什么时候使用这个接口

用于把一个或多个运行从运行队列移除，使其不再执行——比如某个等待中的运行你已经不需要了。这是批量版本：一次调用传入多个 queue_ref。如果只释放一个项，请改用 释放单个运行队列项。

请先调用 查询运行队列项 获取要释放项的 queue_ref。

请求体

使用 Content-Type: application/json 发送请求体。

字段	必填	类型	说明
queue_refs	是	array<string>	要释放的队列项 ID。从 查询运行队列项 返回的 queue_ref 复制。
reason	否	string	可选的释放原因，用于事后查阅。

JSON 示例

{
  "queue_refs": ["123456", "123457"],
  "reason": "no longer needed"
}

请求示例

curl -X POST "https://openapi.coreclaw.com/api/v2/run-queue/items/release" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"queue_refs":["123456","123457"],"reason":"no longer needed"}'

响应示例

{
  "code": 0,
  "data": {
    "results": [
      { "queue_ref": "123456", "success": true },
      { "queue_ref": "123457", "success": false, "error": "item is not in waiting state" }
    ]
  },
  "message": "success",
  "request_id": "req-123"
}

响应字段

字段	类型	说明
data.results[]	array	每个提交项的释放结果，一个 queue_ref 一条。
data.results[].queue_ref	string	该结果对应的队列项 ID。
data.results[].success	boolean	是否释放成功。当项已不在可释放状态（例如已执行或已激活）时为 false。
data.results[].error	string	可选。仅当 success 为 false 时出现，说明该队列项无法释放的简短原因。

说明

• API v2 支持 Bearer token、旧版 api-key 请求头和 query token。新集成推荐使用 Bearer token。
• 释放是不可逆的：项会从队列移除且不会执行。如果想让运行执行，请改用 激活运行队列项。
• 状态处理与取消行为可参考 运行生命周期与状态。

HTTP 响应

HTTP 状态码	应用码	含义
200	0	OK
400	11000	Bad Request
401	12001	Unauthorized
404	11004	Not Found
422	11000	Unprocessable Entity
429	13000	Too Many Requests
500	10000	Internal Server Error