文档

CreateWorkflow - 创建工作流

更新时间:
一键部署

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

调试

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

调试

授权信息

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

请求参数

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

地域ID。

cn-hangzhou
Namespacestring

命名空间ID,在控制台的命名空间页面中获取。

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSourcestring

特殊第三方才需要填写。

schedulerx
GroupIdstring

应用分组ID,在控制台的应用管理页面中获取。

testSchedulerx.defaultGroup
Namestring

工作流名称

helloworld
Descriptionstring

工作流描述

Test
TimeTypeinteger

时间类型,目前支持以下几种时间类型:

  • cron:1
  • api:100
1
TimeExpressionstring

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

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

时区

GMT+8
MaxConcurrencyinteger

最大同时运行工作流实例数量,默认值为1,即上次触发没有运行结束,即使到了运行时刻也不会进行下次触发。

1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求唯一ID。

39090022-1F3B-4797-8518-6B61095F1AF0
Codestring

返回码

200
Successboolean

创建工作流是否成功。取值如下:

  • true:创建工作流成功。
  • false:创建工作流失败。
true
Messagestring

错误信息

timetype is invalid
Dataobject

创建工作流的返回值

WorkflowIdlong

工作流ID

92583

示例

正常返回示例

JSON格式

{
  "RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
  "Code": "200",
  "Success": true,
  "Message": "timetype is invalid",
  "Data": {
    "WorkflowId": 92583
  }
}

错误码

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

  • 本页导读 (1)