Skip to main content

取消待执行下线任务接口

取消尚未执行的强制下线任务，提交最新 version，并可附上取消原因。成功时返回 204，无响应正文。

  • Scope：admin.v1.force-logout-tasks.execute
  • 权限项：强制下线任务执行（force-logout-tasks）
  • 权限类型：执行
  • 接口：POST/api/openapi/v1/force-logout-tasks/{taskId}/cancellations

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
taskIdpathstring · uuid必填任务 ID"<uuid>"
Idempotency-Keyheaderstring必填幂等键，用于避免重复提交"<string>"
reasonbodystring否取消原因"<string>"
versionbodyinteger · int64必填版本号，用于并发更新校验1

请求示例

curl --request POST \
  --url 'https://example.invalid/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 No Content

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}