You can call ModifyFlowForWeb operation to modify a custom graphical workflow.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyFlowForWeb

The operation that you want to perform. This parameter is required for API requests that you create by piecing together HTTP or HTTPS URLs. Set the value to ModifyFlowForWeb.

ClusterId String Yes C-F32FB31D8295****

The ID of the cluster. You can call ListClusters You can call this operation to view the ID of a cluster.

CreateCluster Boolean Yes false

Indicates whether the cluster was created from the cluster template.

  • If this parameter is set to true, the ID of the cluster is cluster template ID:CT-XXXXXX.
  • If this parameter is set to false, the ID of the cluster is cluster ID:C-XXXXXX.
Graph String Yes {"nodes":[{"id":"48d474ea","index":0,"spmAnchorId":"0.0.0.i0.766645eb2cmNtQ","attribute":{"type":"START"},"shape":"startControlNode","type":"node","y":250,"size":"80*34","x":500},{"id":"7ba480b3","index":1,"spmAnchorId":"5176.8250060.0.i19.771e28d0IPNQGE","attribute":{"jobType":"SHELL","jobId":"FJ-7BE1062897B19D25","type":"JOB"},"config":{"hostName":""},"label":"fail_job","shape":"shellJobNode","type":"node","y":398.5,"size":"170*34","x":470.5},{"id":"33202d60","index":2,"spmAnchorId":"5176.8250060.0.i23.771e28d0IPNQGE","attribute":{"type":"END"},"shape":"endControlNode","type":"node","y":562.5,"size":"80*34","x":430.5}],"edges":[{"id":"28167ea0","index":3,"source":"48d474ea","sourceAnchor":0,"target":"7ba480b3","targetAnchor":0},{"id":"e8d5ff52","index":4,"source":"7ba480b3","sourceAnchor":1,"target":"33202d60","targetAnchor":0}]}

The information of the directed acyclic graph (DAG) of the workflow.

Id String Yes F-7A39731FE719****

The ID of the workflow. You can call ListFlowInstance View the workflow ID.

ProjectId String Yes FP-257A173659F5****

The ID of the project. You can call ListFlowProject View the ID of the project.

RegionId String Yes cn-hangzhou

The region ID of the instance. You can call DescribeRegions To view the latest list of Alibaba Cloud regions.

Name String No my_flow

The name of the workflow. The name can be up to 64 characters in length. Duplicate names are not allowed in the same project.

Status String No STOP_SCHEDULE

The status of the workflow. Valid values: STOP_SCHEDULE and UNDER_SCHEDULE.

Description String No This is the description of a workflow

The description of the workflow. The description can contain a maximum of 256 characters in length.

Periodic Boolean No true

Specifies whether to enable periodic scheduling.

StartSchedule Long No 1538017814000

The time when the scheduling takes effect. The value is a long integer timestamp. Example: System.currentTimeMillis () Must be less than EndSchedule. This parameter is required if the CronExpr parameter is not left empty.

EndSchedule Long No 1538018814000

The scheduling failure time, which is a long integer timestamp, for example, System.currentTimeMillis. () .

CronExpr String No 0 0 0-23/1 * * ?

The Cron expression of the scheduled time. For more information, see A Cron Expressions .

HostName String No emr-header-1.cluster-123456

Specify the information of the running machine in the format of emr-header-1.cluster-123456.

AlertConf String No {"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"]}]}

The alert notification configuration. eventId currently supports:

  • EMR-210401001 (alert upon workflow failure)
  • EMR-110401002 (Notification of workflow success)
  • EMR-110401015 (alerts for failed workflow nodes)
AlertUserGroupBizId String No -

A deprecated parameter.

AlertDingDingGroupBizId String No -

A deprecated parameter.

ParentFlowList String No [F-123456]

The information of the parent workflow.

ParentCategory String No FC-F2495319DA05****

The ID of the parent directory.

Response parameters

Parameter Type Example Description
Data Boolean true

The execution results are returned, including the following:

  • true: The operation was successful.
  • false: The operation failed.
RequestId String 243D5A48-96A5-4C0C-8966-93CBF65635ED

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifyFlowForWeb
&Id=F-7A39731FE719****
&ProjectId=FP-257A173659F5****
&RegionId=cn-hangzhou
&ClusterId=A23BD131A862****
&CreateCluster=false
&Graph=Graph information
&<common request parameters>

Sample success responses

XML format

<RequestId>243D5A48-96A5-4C0C-8966-93CBF65635ED</RequestId>
<Data>true</Data>

JSON Syntax

{
"RequestId":"243D5A48-96A5-4C0C-8966-93CBF65635ED",
"Data":true
}