UpdateWorkflow - 更新工作流

更新工作流

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID

xxljob-d6a5243b6fa
AppNamestring

应用名称。

test-app
WorkflowIdlong

工作流 ID

1
Namestring

工作流名称

myWorkflow
Descriptionstring

工作流描述

my first workflow
TimeTypeinteger

调度类型,目前支持以下几种类型:

  • -1: none
  • 1:cron
  • 100::api
1
TimeExpressionstring

时间表达式,根据选择的时间类型设置时间表达式。

  • none:无需填写
  • cron:填写标准的 cron 表达式,支持在线验证。
  • api:无需填写
0 0/10 * * * ?
Timezonestring

时区

说明 默认使用 schedulerx 服务器所在时区
GMT+8
Calendarstring

自定义日历

workday
MaxConcurrencyinteger

最大并发数

说明 同一个工作流同一时间允许运行的最大实例个数,1 表示不允许重复执行。如果超过并发数,会跳过当前调度。
1
ClientTokenstring

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。

D0DE9C33-992A-580B-89C4-B609A292748D

返回参数

名称类型描述示例值
object

Schema of Response

Codeinteger

响应码

200
Messagestring

错误信息。

Parameter error: content is null.
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC
Successboolean

是否调用成功。

  • true:调用成功。
  • false:调用失败。
true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "Parameter error: content is null.",
  "RequestId": "AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterParameter error: %s.参数错误: %s
401IllegalRequestIllegalRequest: %s.非法请求:%s
403NoPermissionNo permission to perform this operation: %s.没有权限去执行该操作:%s
404NotFoundNot found: %s.资源不存在:%s
500InternalErrorInternalError: %s.系统内部错误:%s

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2025-12-25新增 OpenAPI查看变更详情