Skip to main content

查询强制下线任务接口

查询强制下线任务，按关键词、状态和创建时间范围筛选。返回任务涉及的人员范围、计划或执行时间，以及用于修改或取消的版本号。

  • Scope：admin.v1.force-logout-tasks.read
  • 权限项：强制下线任务读取（force-logout-tasks）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/force-logout-tasks

认证与请求头

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

请求参数

名称位置类型必填说明示例
keywordquerystring否搜索关键词"<string>"
statusquerystring否执行状态"pending"
created_fromquerystring · date-time否创建时间（开始）"2026-08-27T10:00:00Z"
created_toquerystring · date-time否创建时间（结束）"2026-08-27T10:00:00Z"
pagequeryinteger · int64否页码1
page_sizequeryinteger · int64否每页条数20

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/force-logout-tasks?keyword=<keyword>&status=<status>&created_from=<created_from>&created_to=<created_to>&page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray<OpenapifacadeForceLogoutTaskResponse>是记录列表-
pageinteger · int64是页码0
page_sizeinteger · int64是每页条数0
totalinteger · int64是总条数0

items[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
created_atstring · date-time是创建时间
created_bystring ｜ null · uuid否创建人 ID
created_by_emailstring否创建人邮箱
created_by_namestring否创建人
executed_atstring ｜ null · date-time是执行时间
execution_modestring是执行时间（立即执行或定时执行）；可选值：immediate, scheduled
expires_atstring ｜ null · date-time是到期时间
idstring · uuid是任务 ID
promptstring是用户提示语
reasonstring是任务原因
scheduled_atstring ｜ null · date-time是定时执行时间
scope_typestring是下线范围类型；可选值：all, specified
statusstring是执行状态；可选值：pending, executed
subjectsarray<object>是下线范围
target_clientstring是下线目标端；可选值：pc
updated_atstring · date-time是更新时间
updated_bystring ｜ null · uuid否更新人 ID
updated_by_emailstring否更新人邮箱
updated_by_namestring否更新人
versioninteger · int64是版本号，用于并发更新校验

items[].subjects[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
idstring · uuid是范围对象 ID
namestring是范围对象名称
typestring是对象类型；可选值：department, user_group, user
{
  "items": [
    {
      "created_at": "2026-08-27T10:00:00Z",
      "created_by": "<uuid>",
      "created_by_email": "<string>",
      "created_by_name": "<string>",
      "executed_at": "2026-08-27T10:00:00Z",
      "execution_mode": "immediate",
      "expires_at": "2026-08-27T10:00:00Z",
      "id": "<uuid>",
      "prompt": "<string>",
      "reason": "<string>",
      "scheduled_at": "2026-08-27T10:00:00Z",
      "scope_type": "all",
      "status": "pending",
      "subjects": [
        {
          "id": "<uuid>",
          "name": "<string>",
          "type": "department"
        }
      ],
      "target_client": "pc",
      "updated_at": "2026-08-27T10:00:00Z",
      "updated_by": "<uuid>",
      "updated_by_email": "<string>",
      "updated_by_name": "<string>",
      "version": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total": 0
}

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>"
}