UpdateAutomationScheduledTaskEnabled - 启用或暂停定时任务-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

获取服务接入点：替换 API 请求语法中的 {domain} 。
获取个人访问令牌。
获取organizationId：仅中心版需要。请前往组织管理后台的基本信息页面获取组织 ID 。

产品	资源	所需权限
组织管理	自动化定时任务	读写

请求语法

中心版

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

Region版

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

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是：中心版否：Region版	组织 ID。
name	string	path	是	任务名称。
-	object	body	否
enabled	boolean	body	是	true 启用，false 暂停。

请求示例

中心版

curl -X 'PUT' \
  'https://{domain}/oapi/v1/platform/organizations/{organizationId}/automation/scheduled-tasks/{name}/enabled' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "enabled": false
    }'

Region版

curl -X 'PUT' \
  'https://{domain}/oapi/v1/platform/automation/scheduled-tasks/{name}/enabled' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "enabled": false
    }'

返回参数

参数	类型	描述	示例值
-	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 相关错误码。