CreateWorkflow - 创建工作流

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
edas:CreateSchedulerxWorkflowCreatecreate
*全部资源
*

请求参数

名称类型必填描述示例值
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
  },
  "AccessDeniedDetail": {
    "AuthAction": "",
    "AuthPrincipalDisplayName": "",
    "AuthPrincipalOwnerId": "",
    "AuthPrincipalType": "",
    "EncodedDiagnosticMessage": "",
    "NoPermissionType": "",
    "PolicyType": ""
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-10-21OpenAPI 返回结构发生变更查看变更详情
2024-05-30API 内部配置变更,不影响调用查看变更详情
2024-03-25API 内部配置变更,不影响调用查看变更详情