更新工作流
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClusterId | string | 是 | 集群 ID | xxljob-d6a5243b6fa |
| AppName | string | 是 | 应用名称。 | test-app |
| WorkflowId | long | 是 | 工作流 ID | 1 |
| Name | string | 否 | 工作流名称 | myWorkflow |
| Description | string | 否 | 工作流描述 | my first workflow |
| TimeType | integer | 否 | 调度类型,目前支持以下几种类型:
| 1 |
| TimeExpression | string | 否 | 时间表达式,根据选择的时间类型设置时间表达式。
| 0 0/10 * * * ? |
| Timezone | string | 否 | 时区 说明
默认使用 schedulerx 服务器所在时区
| GMT+8 |
| Calendar | string | 否 | 自定义日历 | workday |
| MaxConcurrency | integer | 否 | 最大并发数 说明
同一个工作流同一时间允许运行的最大实例个数,1 表示不允许重复执行。如果超过并发数,会跳过当前调度。
| 1 |
| ClientToken | string | 否 | 用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。 | D0DE9C33-992A-580B-89C4-B609A292748D |
返回参数
示例
正常返回示例
JSON格式
{
"Code": 200,
"Message": "Parameter error: content is null.",
"RequestId": "AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC",
"Success": true
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter | Parameter error: %s. | 参数错误: %s |
| 401 | IllegalRequest | IllegalRequest: %s. | 非法请求:%s |
| 403 | NoPermission | No permission to perform this operation: %s. | 没有权限去执行该操作:%s |
| 404 | NotFound | Not found: %s. | 资源不存在:%s |
| 500 | InternalError | InternalError: %s. | 系统内部错误:%s |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-12-25 | 新增 OpenAPI | 查看变更详情 |
