调用CreateFlow接口,创建工作流。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateFlow

系统规定参数。取值:CreateFlow

RegionId String cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

ProjectId String FP-ED2F3E844FE3****

项目ID。您可以调用ListFlowProject查看项目的ID。

Name String myFlow

目录名称。您可以调用ListFlowProject查看

Description String 这是一个项目描述

项目描述。

StartSchedule Long 1538017814000

开始调度时间,长整型时间戳.。例如:System.currentTimeMillis()。

  • 必须小于EndSchedule。
  • 当CronExpr不为空时,此项必填。
EndSchedule Long 1538018814000

调度失效时间,长整型时间戳,例如System.currentTimeMillis()。

CronExpression String 0 0 0-23/1 * * ?

时间周期调度的cron表达式。

CreateCluster Boolean false

是否通过集群模板创建集群,true表示通过集群模板创建集群,ClusterId应设置为集群模板 ID(CT-xxx),否则为已有集群 ID(C-xxx)。

ClusterId String C-A23BD131A862****

集群ID。您可以调用ListClusters查看集群的ID。

HostName String emr-header-1.cluster-123456

节点实例运行所在主机的名称。您可以调用ListFlow或登录主机使用hostname命令查看。

Namespace String

保留字段。

Application String

APP

AlertConf String {"items":[{"enable":true,"eventId":"EMR-210401001","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]},{"enable":true,"eventId":"EMR-110401015","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]},{"enable":true,"eventId":"EMR-110401002","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]}]}

报警通知配置,eventId目前支持以下告警:

  • EMR-210401001(工作流失败报警)。
  • EMR-110401002(工作流成功通知)。
  • EMR-110401015(工作流节点失败报警)。
AlertUserGroupBizId String ADG-0a00d00abb7743ff9f812f1a997f3d87

报警用户组信息。

AlertDingDingGroupBizId String 已过期

报警钉钉群信息。

ParentFlowList String F-62ECFC6E1BF6EAD2,F-1E6528634E67B615,F-7E0A84332E9D9A89

依赖的上游工作流列表,以逗号分隔。您可以调用ListFlowInstance查看工作流ID。

ParentCategory String F-62ECFC6E1BF6EAD2,F-1E6528634E67B615,F-7E0A84332E9D9A89

F-62ECFC6E1BF6EAD2,F-1E6528634E67B615,F-7E0A84332E9D9A89

ClientToken String 123e4567-e89b-12d3-a456-42665544****

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。

返回数据

名称 类型 示例值 描述
Id String F-7A39731FE719****

新创建的工作流ID。

RequestId String 243D5A48-96A5-4C0C-8966-93CBF65635ED

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateFlow
&RegionId=cn-hangzhou
&ProjectId=FP-ED2F3E844FE3****
&Name=myFlow
&Description=这是一个项目描述
&StartSchedule=1538017814000
&EndSchedule=1538018814000
&CronExpression=0 0 0-23/1 * * ?
&CreateCluster=false
&ClusterId=C-A23BD131A862****
&HostName=emr-header-1.cluster-123456
&Namespace=无
&Application=无
&AlertConf={"items":[{"enable":true,"eventId":"EMR-210401001","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]},{"enable":true,"eventId":"EMR-110401015","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]},{"enable":true,"eventId":"EMR-110401002","alertUserGroupIdList":["AUG-b79bb29bb6e14ddd89674a242623851b"],"alertDingDingGroupList":["ADG-af1f9689d6194e2dbd89927d5c515172"]}]}
&AlertUserGroupBizId=ADG-0a00d00abb7743ff9f812f1a997f3d87
&AlertDingDingGroupBizId=已过期
&ParentFlowList=F-62ECFC6E1BF6EAD2,F-1E6528634E67B615,F-7E0A84332E9D9A89
&ParentCategory=F-62ECFC6E1BF6EAD2,F-1E6528634E67B615,F-7E0A84332E9D9A89
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateFlowResponse>
    <Id>F-7A39731FE719****</Id>
    <RequestId>243D5A48-96A5-4C0C-8966-93CBF65635ED</RequestId>
</CreateFlowResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Id" : "F-7A39731FE719****",
  "RequestId" : "243D5A48-96A5-4C0C-8966-93CBF65635ED"
}

错误码

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

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