取消待执行下线任务接口
取消尚未执行的强制下线任务,提交最新 version,并可附上取消原因。成功时返回 204,无响应正文。
所需权限
| 所需权限 | 资源 | Scope | 资源服务 |
|---|---|---|---|
| 强制下线任务执行(执行) | force-logout-tasks | admin.v1.force-logout-tasks.execute | qwenwork-biz-service |
POST /api/openapi/v1/force-logout-tasks/{taskId}/cancellations
认证与请求头
使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|---|
| Authorization | header | string | 是 | 应用 API Key,使用 Bearer 方式传递。 | Bearer qwk_\\* |
| X-Request-Id | header | string | 否 | 可选的调用追踪标识;未传入时由服务端生成。 | req-20260831-001 |
请求参数
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|---|
| taskId | path | string · uuid | 必填 | 需要操作的强制下线任务标识。 | "<uuid>" |
| Idempotency-Key | header | string | 必填 | 本次写操作的幂等键。同一操作重试时复用相同键和请求内容,避免重复处理。 | "<string>" |
| reason | body | string | 否 | 执行本次操作的原因说明。 最多字符数:255。 | "<string>" |
| version | body | integer · int64 | 必填 | 当前记录的版本号,修改或取消时提交最新读取的值以校验并发变更。 最小值:1。 | 1 |
请求示例
将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
curl --request POST --url '<BASE_URL>/api/openapi/v1/force-logout-tasks/<taskId>/cancellations' --header 'Authorization: Bearer <API_KEY>' --header 'Idempotency-Key: <UNIQUE_REQUEST_ID>' --header 'Content-Type: application/json' --data '{ "reason": "<string>", "version": 1}'响应
204 操作成功,无响应正文。
default 请求失败,返回错误码和错误详情。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 否 | 用于程序判断错误原因的稳定业务错误码。 | "<string>" |
| detail | string | 是 | 便于阅读的错误说明。 | "<string>" |
| details | OpenapiErrorDetails | 否 | 字段校验失败时的详细信息。 | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
| details.field | string | 否 | 未通过校验的请求字段。 | "<string>" |
| details.reason | string | 否 | 稳定的校验失败原因,用于判断字段为何不合法。 | "<string>" |
| details.suggestion | string | 否 | 建议采用的规范化字段值。 | "<string>" |
| error | string | 是 | 稳定的 HTTP 错误类型。 | "<string>" |
{
"code": "<string>",
"detail": "<string>",
"details": {
"field": "<string>",
"reason": "<string>",
"suggestion": "<string>"
},
"error": "<string>"
}