CreateWorkflow - 创建工作流-微服务引擎(MSE)-阿里云帮助中心

创建工作流

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。	xxljob-b6ec1xxxx
AppName	string	是	应用名称。	xxl-job-executor-sample
Name	string	是	工作流名称	my-workflow
Description	string	否	工作流描述	my first workflow for data analyse
TimeType	integer	否	时间类型： -1: none 1：cron 100:：api	1
TimeExpression	string	否	时间表达式，根据选择的时间类型设置时间表达式。 none：无需填写 cron：填写标准的 cron 表达式，支持在线验证。 api：无需填写	0 0 4 ? * Mon/1
Calendar	string	否	cron 类型可以选择填写自定义日历。	workday
Timezone	string	否	时区	GMT+8
MaxConcurrency	integer	否	工作流并发数	1
Status	integer	否	工作流状态，默认为禁用状态。 0: 禁用 1: 启用	0
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。	123456789

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	integer	响应码	200
Message	string	错误信息	Parameter check error
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	5EF879D0-3B43-5AD1-9BF7-52418F9C5E73
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true
Data	object	返回数据。
WorkflowId	long	工作流 ID	10

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "Parameter check error",
  "RequestId": "5EF879D0-3B43-5AD1-9BF7-52418F9C5E73",
  "Success": true,
  "Data": {
    "WorkflowId": 10
  }
}

错误码

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	查看变更详情