UpdateAutomationScheduledTask - 更新定时任务

更新时间:
复制 MD 格式

适用版本

中心版、Region版

服务接入点与授权信息

产品

资源

所需权限

组织管理

自动化定时任务

读写

请求语法

中心版

PUT https://{domain}/oapi/v1/platform/organizations/{organizationId}/automation/scheduled-tasks/{name}

Region版

PUT https://{domain}/oapi/v1/platform/automation/scheduled-tasks/{name}

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

是

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

  • 是:中心版

  • 否:Region版

组织 ID。

name

string

path

是

任务名称。

-

object

body

否

channels

array[string]

body

否

报告投递渠道;不选则任务仅执行不投递。

enabled

boolean

body

否

是否启用;创建时缺省 true,更新时缺省保持不变。

mailSubject

string

body

否

邮件主题(纯文本,不支持模板绑定);缺省跟随任务标题。

prompt

string

body

是

AI 提示词。

汇总昨日需求进展并生成晨报

recipients

array[string]

body

否

收件人列表,作用于所有已选渠道;缺省时创建取调用者本人、更新保持各渠道现状;不允许显式空列表。

schedule

object

body

是

cron

string

body

否

自定义 5 段 cron 表达式;frequency=custom 时必填。

30 9 * * 1-5

dayOfMonth

integer

body

否

每月几号(1-31);frequency=monthly 时必填。

dayOfWeek

integer

body

否

周几(0-6,0 为周日);frequency=weekly 时必填。

frequency

string

body

是

调度频率,可能的值:[daily weekly monthly weekdays hourly everyMinutes custom]。

daily

intervalMinutes

integer

body

否

间隔分钟数(1-59);frequency=everyMinutes 时必填。

minute

integer

body

否

每小时第几分钟(0-59);frequency=hourly 时必填。

time

string

body

否

触发时刻 HH:mm;frequency 为 daily/weekly/monthly/weekdays 时必填。

09:30

title

string

body

是

任务标题,同时是默认邮件主题。

研发晨报

请求示例

中心版

curl -X 'PUT' \
  'https://{domain}/oapi/v1/platform/organizations/{organizationId}/automation/scheduled-tasks/{name}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "channels": [
            
        ],
        "enabled": false,
        "mailSubject": "",
        "prompt": "汇总昨日需求进展并生成晨报",
        "recipients": [
            
        ],
        "schedule": {
            "cron": "30 9 * * 1-5",
            "dayOfMonth": 0,
            "dayOfWeek": 0,
            "frequency": "daily",
            "intervalMinutes": 0,
            "minute": 0,
            "time": "09:30"
        },
        "title": "研发晨报"
    }'

Region版

curl -X 'PUT' \
  'https://{domain}/oapi/v1/platform/automation/scheduled-tasks/{name}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "channels": [
            
        ],
        "enabled": false,
        "mailSubject": "",
        "prompt": "汇总昨日需求进展并生成晨报",
        "recipients": [
            
        ],
        "schedule": {
            "cron": "30 9 * * 1-5",
            "dayOfMonth": 0,
            "dayOfWeek": 0,
            "frequency": "daily",
            "intervalMinutes": 0,
            "minute": 0,
            "time": "09:30"
        },
        "title": "研发晨报"
    }'

返回参数

参数

类型

描述

示例值

-

object

channels

array[string]

已选择的报告投递渠道。

createdAt

string

创建时间。

enabled

boolean

是否启用。

true

mailSubject

string

独立配置的邮件主题;跟随任务标题时省略。

manageable

boolean

任务表单能否完整管理该任务;为 false 时仅可读(可通过启停/删除操作,不可表单更新)。

true

mode

string

AI 执行模式:report(生成报告)或 command(执行指令),可能的值:[report command]。

report

name

string

任务名称(服务端生成的稳定标识),组织内唯一。

sched-1a2b3c4d

prompt

string

AI 提示词。

recipients

array[string]

各渠道一致时回显的收件人列表;渠道间收件人不一致或未选渠道时省略。

schedule

object

cron

string

实际生效的 cron 表达式。

30 9 * * *

dayOfMonth

integer

每月几号;结构化回显字段,cron 可被表单表达时给出。

dayOfWeek

integer

周几(0-6,0 为周日)。

frequency

string

结构化频率;cron 无法被表单表达时省略,可能的值:[daily weekly monthly weekdays hourly everyMinutes custom]。

daily

intervalMinutes

integer

间隔分钟数。

minute

integer

每小时第几分钟。

text

string

调度的中文描述。

每天 09:30

time

string

触发时刻 HH:mm。

timezone

string

时区。

Asia/Shanghai

title

string

任务标题。

研发晨报

unmanageableReason

string

manageable=false 时的原因码,如 custom_condition / unsupported_dag_shape / divergent_recipients。

updatedAt

string

更新时间。

version

integer

规则版本号,每次更新自增。

返回示例

{
    "channels": [
        
    ],
    "createdAt": "",
    "enabled": true,
    "mailSubject": "",
    "manageable": true,
    "mode": "report",
    "name": "sched-1a2b3c4d",
    "prompt": "",
    "recipients": [
        
    ],
    "schedule": {
        "cron": "30 9 * * *",
        "dayOfMonth": 0,
        "dayOfWeek": 0,
        "frequency": "daily",
        "intervalMinutes": 0,
        "minute": 0,
        "text": "每天 09:30",
        "time": "",
        "timezone": "Asia/Shanghai"
    },
    "title": "研发晨报",
    "unmanageableReason": "",
    "updatedAt": "",
    "version": 0
}

错误码

访问错误码中心查看 API 相关错误码。