调用ModifyFlow接口修改工作流。

调试

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

调试

请求参数

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

系统规定参数。对于您自行拼凑HTTP或HTTPS URL发起的API请求，该参数为必选参数。取值：ModifyFlow。
Id String 是 F-7A39731FE719****

工作流ID。您可以调用ListFlowInstance查看工作流ID。

ProjectId String 是 FP-3535FE0BE522****

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

RegionId String 是 cn-hangzhou

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

Name String 否 my_flow

工作流名称，长度限制为64个字符，并且同一个项目中不允许重名。
Status String 否 UNDER_SCHEDULE

工作流状态。
Description String 否 my flow description

工作流描述，长度限制为156个字符。
Periodic Boolean 否 true

是否周期调度。
StartSchedule Long 否 1542783867503

开始时间，长整型时间戳。例如，System.currentTimeMillis()。开始时间的限制如下：

  • 开始时间必须小于EndSchedule。
  • 当CronExpr不为空时， 此项必填。
EndSchedule Long 否 1542783967503

调度失效时间，长整型时间戳，例如，System.currentTimeMillis()。
CronExpr String 否 0 0 0-23/1 * * ?

时间周期调度的Cron表达式，请参见Cron表达式。

CreateCluster Boolean 否 false

是否创建集群：

  • 为true时，ClusterId为集群模板id CT-XXXXXX。
  • 为false时，ClusterId为集群id C-XXXXXX。
ClusterId String 否 C-F32FB31D8295****

集群ID。
HostName String 否 emr-header-1.cluster-12345

工作流运行所在的机器Hostname，支持Master和Gateway机器。Hostname格式为emr-header-1.cluster-12345，您可登录机器使用hostname命令查看对应的值。

Application String 否 {"nodeDefMap":{":start:":{"name":":start:","type":":start:","transitions":["cluster"]},"cluster":{"id":"CT-0C74281682CF03B4","name":"cluster","type":":Cluster:","transitions":["job1"]},"job1":{"jobId":"FJ-242AB240DBAF4195","name":"job1","type":":action:","transitions":["end"]},"end":{"name":"end","type":":end:"}}}

工作流构造信息，有一组节点定义nodeDefMap组成。多个时以逗号分隔。

  • type：类型包括开始节点（:start:）、构建按需集群节点（:Cluster:）、动作节点（:action:）和结束节点（:end:）。
  • transitions：下游的节点。
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 否 已过期

已过期。
AlertDingDingGroupBizId String 否 已过期

已过期。
ParentFlowList String 否 F-62ECFC6E1BF6EAD2,F-1E6528634E67B615,F-7E0A84332E9D9A89

依赖的上游工作流ID列表，以逗号分隔。
ParentCategory String 否 FC-FC396F988E07C06F

父目录ID，空则默认为root目录。

返回数据

名称类型示例值描述
名称 类型 示例值 描述
Data Boolean true

返回结果：

  • true：表示修改成功。
  • false：表示修改失败。
RequestId String ECC2D0D1-B6D5-468D-B698-30E8805EB574

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyFlow
&Id=F-7A39731FE719****
&ProjectId=FP-3535FE0BE522****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式 

<RequestId>ECC2D0D1-B6D5-468D-B698-30E8805EB574</RequestId>
<Data>true</Data>

JSON 格式 

{
"RequestId":"ECC2D0D1-B6D5-468D-B698-30E8805EB574",
"Data":true
}