千问办公企业旗舰版开发者文档:查询计划任务列表。
认证方式见APP开发者文档 → 认证接入。
仅查询当前用户自己的计划;列表与执行流水使用offset分页,limit默认20、范围1–100,offset默认0且非负。
接口只消费可信入口的当前用户;需启用Session计划组件且依赖就绪。支持单次与周期计划。
| status | query | string | 否 | active/paused;省略不按状态过滤 |
| sort | query | string | 否 | created_asc/created_desc;默认降序,ID同方向作次序 |
当前恢复已消费单次任务的拒绝是400 OPERATION_NOT_ALLOWED;不要把它当作任务成功恢复。错误体沿用Session现有运行时中间件,不套用管理后台错误码或生成器默认problem+json字段。保存trace_id排查,移除用户凭据。
支持可选
- 模块:计划任务
- 接口:GET
/api/openapi/app/v1/scheduler/tasks - operationId:
list-single-scheduled-tasks
接口说明
仅查询当前用户自己的计划;列表与执行流水使用offset分页,limit默认20、范围1–100,offset默认0且非负。
接口只消费可信入口的当前用户;需启用Session计划组件且依赖就绪。支持单次与周期计划。
请求头
| 参数/字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| Content-Type | header | string | JSON body时 | application/json |
请求参数
| 参数/字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| limit | query | integer (int64) | 否 | 分页参数default=20;minimum=1;maximum=100 |
| offset | query | integer (int64) | 否 | 分页参数default=0;minimum=0 |
成功响应
HTTP 200
| 参数/字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| items | response | array[object] / null | 是 | 本页记录集合。 |
| items.[].created_at | response | string (date-time) | 是 | 计划创建时间,RFC3339。 |
| items.[].description | response | string | 是 | 用户填写的计划描述;未填写时为空字符串。 |
| items.[].delete_after_run | response | boolean | 是 | at 自动执行成功后软删除计划,默认false |
| items.[].id | response | string | 是 | 计划任务 UUID。 |
| items.[].name | response | string | 是 | 去首尾空白后1–100个字符 |
| items.[].next_fire_at | response | string / null (date-time) | 是 | 完整UTC日期时间;无后续触发时可为null |
| items.[].owner | response | object | 是 | 服务端保存的归属身份;不由调用方指定 |
| items.[].owner.org_id | response | string | 否 | 归属企业 UUID,未设置时省略。 |
| items.[].owner.team_id | response | string | 否 | 归属团队 UUID,未设置时省略。 |
| items.[].owner.user_id | response | string | 是 | 归属 IAM 用户 UUID。 |
| items.[].schedule_by | response | string | 是 | 仅cloud,创建默认cloud |
| items.[].status | response | string | 是 | active/paused,创建默认active;未知值拒绝 |
| items.[].target | response | object | 是 | 本记录保存的执行目标配置,子字段见下。 |
| items.[].target.kind | response | string | 是 | trigger仅at/cron/every,target仅cloud_session;值:cloud_session |
| items.[].target.payload | response | object | 是 | 会话创建所用的运行参数;执行记录中为触发时快照。 |
| items.[].target.payload.agent_id | response | string | 否 | 可选非零UUID,作为已有Agent配置选择 |
| items.[].target.payload.mode | response | string | 否 | 档位选择,最多128字节;不暴露海外模型ID |
| items.[].target.payload.prompt | response | string | 是 | 文本Prompt不能为空或仅空白 |
| items.[].target.payload.session_name | response | string | 否 | 可选,最多255个字符 |
| items.[].target.payload.delivery_mode | response | string | 否 | 新建及更新仅允许省略或 isolated,每次触发新建会话;历史执行快照可能保留 bound |
| items.[].target.payload.session_id | response | string | 否 | 仅历史绑定快照可能返回;新建及更新必须省略 |
| items.[].target.payload.files | response | array | 否 | 附件引用数组,每项含必填 oss_id、可选 name/mime_type;通过现有文件服务复制至工作区 |
| items.[].trigger | response | object | 是 | 本记录保存的触发规则,子字段见下。 |
| items.[].trigger.kind | response | string | 是 | trigger仅at/cron/every,target仅cloud_session;值:at, cron, every |
| items.[].trigger.spec | response | object | 是 | 与 trigger.kind 对应的规则参数。 |
| items.[].trigger.spec.expr | response | string | 否 | 仅cron必填;标准5字段,不接受描述符或秒字段 |
| items.[].trigger.spec.fire | response | string (date-time) | 否 | 仅at必填;保存的RFC3339触发时刻(UTC毫秒),执行后可为过去时间 |
| items.[].trigger.spec.interval_ns | response | integer | 否 | every 必填;1分钟至365天,单位纳秒,存储规范化到毫秒 |
| items.[].trigger.spec.start_from | response | string (date-time) | 否 | every 必填;RFC3339 起算时间,可在过去;按固定间隔推进至未来 |
| items.[].trigger.spec.rest_day | response | object | 否 | 保留的日历策略结构;本期不启用日历过滤。 |
| items.[].trigger.spec.rest_day.enabled | response | boolean | 是 | rest_day只能false;true拒绝;值:false |
| items.[].trigger.spec.rest_day.region | response | string | 否 | 保留的地区字段;本期不参与调度。 |
| items.[].trigger.spec.rest_day.skip_on | response | string | 否 | 保留的跳过日期策略字段;本期不参与调度。 |
| items.[].trigger.spec.tz | response | string | 否 | 仅cron可用;IANA时区,省略默认UTC |
| items.[].updated_at | response | string (date-time) | 是 | 计划最近更新时间,RFC3339。 |
| limit | response | integer (int64) | 是 | 本次查询的每页数量。 |
| offset | response | integer (int64) | 是 | 本次查询跳过的记录数量。 |
拒绝与排查
| HTTP | 错误语义 |
|---|---|
| 401 | 缺少或无效的可信IAM用户入口身份;不能通过切换身份参数重试 |
| 404 | 任务不存在或非当前用户;除执行流水外,软删除任务也不可读取 |
| 422 | 无效任务ID、分页、请求体、触发规则或目标参数 |
| 503 | Session计划组件未启用或所需服务不可用 |
状态与排序
支持可选 status=active/paused;省略查询全部状态。sort=created_asc/created_desc,默认 created_desc;创建时间相同时按任务 ID 同方向排序。继续使用 limit/offset;没有 no_page 参数。CLI 的 --all 会自动翻页并聚合结果,列表同时变动时不承诺快照完整性。