查询强制下线任务,按关键词、状态和创建时间范围筛选。返回任务涉及的人员范围、计划或执行时间,以及用于修改或取消的版本号。
所需权限
| 所需权限 | 资源 | Scope | 资源服务 |
|---|
| 强制下线任务读取(读取) | force-logout-tasks | admin.v1.force-logout-tasks.read | qwenwork-biz-service |
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 | 否 | 任务创建时间范围的起点,使用带时区的 RFC 3339 时间。 | "2026-08-27T10:00:00Z" |
| created_to | query | string · date-time | 否 | 任务创建时间范围的终点,使用带时区的 RFC 3339 时间。 | "2026-08-27T10:00:00Z" |
| page | query | integer · int64 | 否 | 请求的页码,从 1 开始。 默认值:1。 最小值:1。 | 1 |
| page_size | query | integer · int64 | 否 | 每页返回的记录数量。 默认值:20。 最小值:1。 最大值:100。 | 20 |
请求示例
将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
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 请求成功,返回当前或更新后的数据。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| 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、scheduled。 | "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 为所有用户,specified 为 subjects 指定的对象。 | "all" |
| items[].status | string | 是 | 任务状态:pending 为待执行,executed 为已执行。 | "pending" |
| items[].subjects | array<OpenapifacadeScopeSubject> | 是 | 策略或任务选择的范围对象列表。 | [{"id":"<uuid>","name":"<string>","type":"department"}] |
| items[].subjects[].id | string · uuid | 是 | 所选人员范围对象的标识。 | "<uuid>" |
| items[].subjects[].name | string | 是 | 所选人员范围对象的显示名称。 最多字符数:255。 | "<string>" |
| items[].subjects[].type | string | 是 | 人员范围对象的类型。 可选值:department、user_group、user。 | "department" |
| items[].target_client | string | 是 | 需要强制下线的客户端,当前只支持 pc(桌面客户端)。 | "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 | 是 | 当前结果页的页码,从 1 开始。 | 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 请求失败,返回错误码和错误详情。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| 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>"
}