调用CreateWorkflow创建工作流_分布式任务调度(SchedulerX)-阿里云帮助中心

创建工作流，默认禁用状态，更新完DAG后，需要手动或者通过API启动用工作流，只有专业版才支持。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
Namespace	string	是	命名空间 ID，在控制台的命名空间页面中获取。	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSource	string	否	特殊第三方才需要填写。	schedulerx
GroupId	string	是	应用分组 ID，在控制台的应用管理页面中获取。	testSchedulerx.defaultGroup
Name	string	是	工作流名称	helloworld
Description	string	否	工作流描述	Test
TimeType	integer	是	时间类型，目前支持以下几种时间类型： cron：1 api：100	1
TimeExpression	string	否	时间表达式，根据选择的时间类型设置时间表达式。 cron：填写标准的 cron 表达式，支持在线验证。 api：无时间表达式。	0 0/10 * * * ?
Timezone	string	否	时区	GMT+8
MaxConcurrency	integer	否	最大同时运行工作流实例数量，默认值为 1，即上次触发没有运行结束，即使到了运行时刻也不会进行下次触发。	1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求唯一 ID。	39090022-1F3B-4797-8518-6B61095F1AF0
Code	string	返回码	200
Success	boolean	创建工作流是否成功。取值如下： true：创建工作流成功。 false：创建工作流失败。	true
Message	string	错误信息	timetype is invalid
Data	object	创建工作流的返回值
WorkflowId	long	工作流 ID	92583

示例

正常返回示例

JSON格式

{
  "RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
  "Code": "200",
  "Success": true,
  "Message": "timetype is invalid",
  "Data": {
    "WorkflowId": 92583
  },
  "AccessDeniedDetail": {
    "AuthAction": "",
    "AuthPrincipalDisplayName": "",
    "AuthPrincipalOwnerId": "",
    "AuthPrincipalType": "",
    "EncodedDiagnosticMessage": "",
    "NoPermissionType": "",
    "PolicyType": ""
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-05-30	API 内部配置变更，不影响调用	查看变更详情
2024-03-25	API 内部配置变更，不影响调用	查看变更详情