查询强制下线任务接口
将 <BASE_URL> 替换为所在企业环境的 API 域名。
- Scope:
admin.v1.force-logout-tasks.read - 权限项:强制下线任务读取(
force-logout-tasks) - 权限类型:读取
- 接口:GET
/api/openapi/v1/force-logout-tasks
认证与请求头
使用应用 API Key 调用。当前接口只校验上方独立 Scope;读取、管理与执行权限互不隐含。
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|---|
Authorization | header | string | 是 | 应用 API Key,使用 Bearer 方式传递。 | Bearer qwk_*** |
X-Request-Id | header | string | 否 | 可选的调用追踪标识;未传入时由服务端生成。 | req-20260831-001 |
请求参数
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|---|
keyword | query | string | 否 | - | "<string>" |
status | query | string | 否 | - | "pending" |
created_from | query | string · date-time | 否 | - | "2026-08-27T10:00:00Z" |
created_to | query | string · date-time | 否 | - | "2026-08-27T10:00:00Z" |
page | query | integer · int64 | 否 | - | 1 |
page_size | query | integer · int64 | 否 | - | 20 |
请求示例
cURL
curl --request GET \
--url '<BASE_URL>/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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
items | array<OpenapifacadeForceLogoutTaskResponse> | 是 | - | [{"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}] |
items[].created_at | string · date-time | 是 | - | "2026-08-27T10:00:00Z" |
items[].created_by | string | null · uuid | 否 | - | "<uuid>" |
items[].created_by_email | string | 否 | - | "<string>" |
items[].created_by_name | string | 否 | - | "<string>" |
items[].executed_at | string | null · date-time | 是 | - | "2026-08-27T10:00:00Z" |
items[].execution_mode | string | 是 | - | "immediate" |
items[].expires_at | string | null · date-time | 是 | - | "2026-08-27T10:00:00Z" |
items[].id | string · uuid | 是 | - | "<uuid>" |
items[].prompt | string | 是 | - | "<string>" |
items[].reason | string | 是 | - | "<string>" |
items[].scheduled_at | string | null · date-time | 是 | - | "2026-08-27T10:00:00Z" |
items[].scope_type | string | 是 | - | "all" |
items[].status | string | 是 | - | "pending" |
items[].subjects | array<OpenapifacadeScopeSubject> | 是 | - | [{"id":"<uuid>","name":"<string>","type":"department"}] |
items[].subjects[].id | string · uuid | 是 | - | "<uuid>" |
items[].subjects[].name | string | 是 | - | "<string>" |
items[].subjects[].type | string | 是 | - | "department" |
items[].target_client | string | 是 | - | "pc" |
items[].updated_at | string · date-time | 是 | - | "2026-08-27T10:00:00Z" |
items[].updated_by | string | null · uuid | 否 | - | "<uuid>" |
items[].updated_by_email | string | 否 | - | "<string>" |
items[].updated_by_name | string | 否 | - | "<string>" |
items[].version | integer · int64 | 是 | - | 0 |
page | integer · int64 | 是 | - | 0 |
page_size | integer · int64 | 是 | - | 0 |
total | integer · int64 | 是 | - | 0 |
响应示例
{
"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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
code | string | 否 | Stable business error code | "<string>" |
detail | string | 是 | Human-readable error description | "<string>" |
details | OpenapiErrorDetails | 否 | - | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
details.field | string | 否 | Request field that failed validation | "<string>" |
details.reason | string | 否 | Stable validation failure reason | "<string>" |
details.suggestion | string | 否 | Suggested normalized value | "<string>" |
error | string | 是 | Stable HTTP error type | "<string>" |
响应示例
{
"code": "<string>",
"detail": "<string>",
"details": {
"field": "<string>",
"reason": "<string>",
"suggestion": "<string>"
},
"error": "<string>"
}