千问办公企业旗舰版开发者文档:创建计划任务。
认证方式见APP开发者文档 → 认证接入。
创建仅保存计划,不代表Agent已执行或完成。每次新创建请求产生新任务;当前接口不提供创建幂等键,超时后不要直接重复创建。
接口只消费可信入口的当前用户;需启用Session计划组件且依赖就绪。支持单次与周期计划。
嵌套字段必填性以父对象存在为前提,at/cron/every条件规则以以下示例和约束为准。未知字段和多个JSON对象拒绝;不要发送owner作为授权依据。
单次示例的fire必须替换为实际未来时间。at不额外加秒位错峰,不允许同时传expr或tz。
按天示例;按周一将expr改为
Cron复用任务UUID的FNV-1a哈希模60得到固定0–59秒偏移,分散在指定分钟内;重启和副本变化不重新抽签。next_fire_at包含日期、时间、时区对应的完整时刻,不只存时分秒。停机后补执行一次已到期记录,再推进至下一个未来时间;同次执行重试复用执行身份,不会为每次重试创建新会话。每个新触发实例创建新会话;新建或更新不接受 bound。
不启用节假日/调休过滤,rest_day省略或enabled=false;true拒绝,false规范化后不参与计算。连接器、Harness覆盖及子Agent字段仍不支持,不静默丢弃。修改已有计划使用 PATCH /api/openapi/app/v1/scheduler/tasks/{task_id}。
当前恢复已消费单次任务的拒绝是400 OPERATION_NOT_ALLOWED;不要把它当作任务成功恢复。错误体沿用Session现有运行时中间件,不套用管理后台错误码或生成器默认problem+json字段。保存trace_id排查,移除用户凭据。
every 按起算时间加整数个间隔计算,下一时刻严格晚于当前时间;不加 Cron 秒位错峰,也不启用日历过滤。起算时间未来时,第一次触发就是起算时间;停机补执行一次,再按原起算时间推进。
存量任务中的旧绑定配置在读取时规范化为独立会话;历史执行快照仍可能保留原绑定字段,不代表当前允许创建绑定任务。
- 模块:计划任务
- 接口:POST
/api/openapi/app/v1/scheduler/tasks - operationId:
create-single-scheduled-task
接口说明
创建仅保存计划,不代表Agent已执行或完成。每次新创建请求产生新任务;当前接口不提供创建幂等键,超时后不要直接重复创建。
接口只消费可信入口的当前用户;需启用Session计划组件且依赖就绪。支持单次与周期计划。
请求头
| 参数/字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| Content-Type | header | string | JSON body时 | application/json |
请求参数
| 参数/字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| — | — | — | — | 无额外参数 |
请求体
| 参数/字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| description | body | string | 否 | 任务描述 |
| delete_after_run | body | boolean | 否 | 默认false;仅at支持;自动计划执行成功后软删除计划,保留流水与会话 |
| name | body | string | 是 | 去首尾空白后1–100个字符 |
| owner | body | 任意JSON | 否 | 旧字段兼容接收但忽略;Owner由IAM身份派生 |
| schedule_by | body | string | 否 | 仅cloud,创建默认cloud;值:cloud |
| status | body | string | 否 | active/paused,创建默认active;未知值拒绝;值:active, paused |
| target | body | object | 是 | 对象结构;字段及条件列于下方 target.* 行。 |
| target.kind | body | string | 是 | trigger仅at/cron/every,target仅cloud_session;值:cloud_session |
| target.payload | body | object | 是 | 对象结构;字段及条件列于下方 target.payload.* 行。 |
| target.payload.agent_id | body | string | 否 | 可选非零UUID,作为已有Agent配置选择 |
| target.payload.mode | body | string | 否 | 档位选择,最多128字节;不暴露海外模型ID |
| target.payload.prompt | body | string | 是 | 文本Prompt不能为空或仅空白 |
| target.payload.session_name | body | string | 否 | 可选,最多255个字符 |
| target.payload.delivery_mode | body | string | 否 | 新建及更新仅允许省略或 isolated,每次触发新建会话;历史执行快照可能保留 bound |
| target.payload.session_id | body | string | 否 | 仅历史绑定快照可能返回;新建及更新必须省略 |
| target.payload.files | body | array | 否 | 附件引用数组,每项含必填 oss_id、可选 name/mime_type;通过现有文件服务复制至工作区 |
| trigger | body | object | 是 | 对象结构;字段及条件列于下方 trigger.* 行。 |
| trigger.kind | body | string | 是 | trigger仅at/cron/every,target仅cloud_session;值:at, cron, every |
| trigger.spec | body | object | 是 | 对象结构;字段及条件列于下方 trigger.spec.* 行。 |
| trigger.spec.expr | body | string | 否 | 仅cron必填;标准5字段,不接受描述符或秒字段 |
| trigger.spec.fire | body | string (date-time) | 否 | 仅at必填;未来RFC3339时间,规范化为UTC毫秒 |
| trigger.spec.interval_ns | body | integer | 否 | every 必填;1分钟至365天,单位纳秒,存储规范化到毫秒 |
| trigger.spec.start_from | body | string (date-time) | 否 | every 必填;RFC3339 起算时间,可在过去;按固定间隔推进至未来 |
| trigger.spec.rest_day | body | object | 否 | 对象结构;字段及条件列于下方 trigger.spec.rest_day.* 行。 |
| trigger.spec.rest_day.enabled | body | boolean | 是 | rest_day只能false;true拒绝;值:false |
| trigger.spec.rest_day.region | body | string | 否 | 保留的地区字段,本期不参与调度。 |
| trigger.spec.rest_day.skip_on | body | string | 否 | 保留的日历策略字段,本期不参与调度。 |
| trigger.spec.tz | body | string | 否 | 仅cron可用;IANA时区,省略默认UTC |
单次与周期示例
单次示例的fire必须替换为实际未来时间。at不额外加秒位错峰,不允许同时传expr或tz。
0 9 * * 1,按每月15日改为0 9 15 * *。cron不同时传fire。
成功响应
HTTP 201
| 参数/字段 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| created_at | response | string (date-time) | 是 | 计划创建时间,RFC3339。 |
| description | response | string | 是 | 用户填写的计划描述;未填写时为空字符串。 |
| delete_after_run | response | boolean | 是 | 默认false;仅at支持;自动计划执行成功后软删除计划,保留流水与会话 |
| id | response | string | 是 | 计划任务 UUID。 |
| name | response | string | 是 | 去首尾空白后1–100个字符 |
| next_fire_at | response | string / null (date-time) | 是 | 完整UTC日期时间;无后续触发时可为null |
| owner | response | object | 是 | 服务端保存的归属身份;不由调用方指定 |
| owner.org_id | response | string | 否 | 归属企业 UUID,未设置时省略。 |
| owner.team_id | response | string | 否 | 归属团队 UUID,未设置时省略。 |
| owner.user_id | response | string | 是 | 归属 IAM 用户 UUID。 |
| schedule_by | response | string | 是 | 仅cloud,创建默认cloud |
| status | response | string | 是 | active/paused,创建默认active;未知值拒绝 |
| target | response | object | 是 | 本记录保存的执行目标配置,子字段见下。 |
| target.kind | response | string | 是 | trigger仅at/cron/every,target仅cloud_session;值:cloud_session |
| target.payload | response | object | 是 | 会话创建所用的运行参数;执行记录中为触发时快照。 |
| target.payload.agent_id | response | string | 否 | 可选非零UUID,作为已有Agent配置选择 |
| target.payload.mode | response | string | 否 | 档位选择,最多128字节;不暴露海外模型ID |
| target.payload.prompt | response | string | 是 | 文本Prompt不能为空或仅空白 |
| target.payload.session_name | response | string | 否 | 可选,最多255个字符 |
| target.payload.delivery_mode | response | string | 否 | 新建及更新仅允许省略或 isolated,每次触发新建会话;历史执行快照可能保留 bound |
| target.payload.session_id | response | string | 否 | 仅历史绑定快照可能返回;新建及更新必须省略 |
| target.payload.files | response | array | 否 | 附件引用数组,每项含必填 oss_id、可选 name/mime_type;通过现有文件服务复制至工作区 |
| trigger | response | object | 是 | 本记录保存的触发规则,子字段见下。 |
| trigger.kind | response | string | 是 | trigger仅at/cron/every,target仅cloud_session;值:at, cron, every |
| trigger.spec | response | object | 是 | 与 trigger.kind 对应的规则参数。 |
| trigger.spec.expr | response | string | 否 | 仅cron必填;标准5字段,不接受描述符或秒字段 |
| trigger.spec.fire | response | string (date-time) | 否 | 仅at必填;保存的RFC3339触发时刻(UTC毫秒),执行后可为过去时间 |
| trigger.spec.interval_ns | response | integer | 否 | every 必填;1分钟至365天,单位纳秒,存储规范化到毫秒 |
| trigger.spec.start_from | response | string (date-time) | 否 | every 必填;RFC3339 起算时间,可在过去;按固定间隔推进至未来 |
| trigger.spec.rest_day | response | object | 否 | 保留的日历策略结构;本期不启用日历过滤。 |
| trigger.spec.rest_day.enabled | response | boolean | 是 | rest_day只能false;true拒绝;值:false |
| trigger.spec.rest_day.region | response | string | 否 | 保留的地区字段;本期不参与调度。 |
| trigger.spec.rest_day.skip_on | response | string | 否 | 保留的跳过日期策略字段;本期不参与调度。 |
| trigger.spec.tz | response | string | 否 | 仅cron可用;IANA时区,省略默认UTC |
| updated_at | response | string (date-time) | 是 | 计划最近更新时间,RFC3339。 |
拒绝与排查
| HTTP | 错误语义 |
|---|---|
| 401 | 缺少或无效的可信IAM用户入口身份;不能通过切换身份参数重试 |
| 404 | 任务不存在或非当前用户;除执行流水外,软删除任务也不可读取 |
| 422 | 无效任务ID、分页、请求体、触发规则或目标参数 |
| 503 | Session计划组件未启用或所需服务不可用 |
固定间隔与独立会话
delete_after_run=true 只允许 at。自动计划执行成功后软删除计划;失败、取消、仅派发成功及手动 run-once 均不触发删除。执行期间重设了触发时间的计划不会被旧执行删除。
附件是文件引用,不是上传接口。新建会话沿用现有结构化 Prompt 复制与失败保留原URI的行为。真实可读性及后台凭据仍依赖文件服务联调。