You can call this operation to view the detail of a workflow.

Request parameters

Name Type Required Example Description
Id String Yes F-7A39731FE7196358 The ID of the workflow.
ProjectId String Yes FP-257A173659F59685 The ID of the project.
RegionId String Yes cn-hangzhou The ID of the region.

Response parameters

Name Type Example Description
RequestId String 243D5A48-96A5-4C0C-8966-93CBF65635ED The ID of the request.
Id String F-7A39731FE7196358 The ID of the workflow.
GmtCreate Long 1538017814000 The creation time.
GmtModified Long 1538017814000 The modification time.
Name String my_flow_demo The name of the workflow.
Description String "This is a workflow description." The description of the workflow.
Type String EMR Valid value: EMR.
Status String STOP_SCHEDULE The status of the workflow. Valid values: STOP_SCHEDULE and UNDER_SCHEDULE.
Periodic Boolean true Indicates whether the workflow is run periodically.
StartSchedule Long 1538017814000 The start time of the schedule.
EndSchedule Long 1538018814000 The end time of the schedule.
CronExpr String 0 0 0-23/1 * * ? The cron expression of the schedule.
CreateCluster Boolean false Indicates whether a cluster is to be created. A value of true indicates that a cluster is created using the cluster template. The format of the ClusterID value is CT-XXXXXX. A value of false indicates an existing cluster is used. The format of the ClusterID value is C-XXXXXX.
ClusterId String C-A23BD131A862F184 The ID of the cluster or the cluster template.
HostName String emr-header-1.cluster-123456 The information of the host on which the workflow is run.
Graph String {"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 graphical information of the workflow.
CategoryId String FC-F2495319DA05CEE5 The ID of the workflow category.
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"]}]} The configurations of the alerts and notifications. Valid values of the eventId property include EMR-210401001 (workflow failure), EMR-110401002 (workflow success), and EMR-110401015 (workflow node failure).
AlertUserGroupBizId String ADG-0a00d00abb7743ff9f812f1a997f3d87 The ID of the user group to send alerts.
AlertDingDingGroupBizId String AUG-c917bbfaf6494bbfacdee69c8284967c The ID of the DingTalk group to send alerts.
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:"}}} The structure of the workflow. Valid values of the type property include :start (start), :Cluster (create an on-demand cluster), :action (action), and :end (end). Values of the transitions property are the downstream nodes, separated by commas.
ParentFlowList The list of the parent workflows.
ParentFlowId String F-123456 The ID of the parent workflow.
ParentFlowName String parent_flow The name of the parent workflow.
ProjectId String FP-257A173659F59685 The ID of the project.
ProjectName String my_project Project Name

Examples

  • Sample requests
    
    /? Action=DescribeFlow
    &Id=F-7A39731FE7196358
    &ProjectId=FP-257A173659F59685
    &RegionId=cn-hangzhou
    &<Common request parameters>
  • Successful response examples
    JSON format
    {
    	"CategoryId":"FC-020BA6E39BF0DF35",
    	"ClusterId":"C-23D6879E9BBE1D65",
    	"CreateCluster":false,
    	"Description":"flow",
    	"GmtCreate":1533294723000,
    	"GmtModified":1535449545000,
    	"Graph":{
    		"edges":[
    			{
    				"id":"af91f6b1",
    				"index":2,
    				"source":"48d474ea",
    				"sourceAnchor":0,
    				"target":"f2764af5",
    				"targetAnchor":0
    			},
    			{
    				"id":"3022d5b9",
    				"index":4,
    				"source":"48d474ea",
    				"sourceAnchor":0,
    				"target":"ee4ee659",
    				"targetAnchor":0
    			},
    			{
    				"id":"cfa94eec",
    				"index":6,
    				"source":"f2764af5",
    				"sourceAnchor":1,
    				"target":"75ba7979",
    				"targetAnchor":0
    			},
    			{
    				"id":"00cd608a",
    				"index":7,
    				"source":"ee4ee659",
    				"sourceAnchor":1,
    				"target":"75ba7979",
    				"targetAnchor":0
    			},
    			{
    				"id":"c53a4788",
    				"index":9,
    				"source":"75ba7979",
    				"sourceAnchor":1,
    				"target":"ea5b3e8f",
    				"targetAnchor":0
    			}
    		],
    		"nodes":[
    			{
    				"attribute":{
    					"jobId":"FJ-D9595F5B79ADBAD4",
    					"jobType":"SHELL",
    					"type":"JOB"
    				},
    				"config":{
    					"clusterId":"C-E2544BF486038F9A"
    				},
    				"id":"f2764af5",
    				"index":0,
    				"label":"echo",
    				"shape":"shellJobNode",
    				"size":"170*34",
    				"spmAnchorId":"5176.8250060.0.i158.771e28d0IPNQGE",
    				"type":"node",
    				"x":321.25,
    				"y":394.5
    			},
    			{
    				"attribute":{
    					"type":"START"
    				},
    				"id":"48d474ea",
    				"index":1,
    				"shape":"startControlNode",
    				"size":"80*34",
    				"spmAnchorId":"0.0.0.i0.766645eb2cmNtQ",
    				"type":"node",
    				"x":500,
    				"y":262
    			},
    			{
    				"attribute":{
    					"jobId":"FJ-7BE1062897B19D25",
    					"jobType":"SHELL",
    					"type":"JOB"
    				},
    				"config":{
    					"hostName":""
    				},
    				"id":"ee4ee659",
    				"index":3,
    				"label":"fail_job",
    				"shape":"shellJobNode",
    				"size":"170*34",
    				"spmAnchorId":"5176.8250060.0.i11.6bb528d0eMBmZQ",
    				"type":"node",
    				"x":518.125,
    				"y":456.5
    			},
    			{
    				"attribute":{
    					"jobId":"FJ-D9595F5B79ADBAD4",
    					"jobType":"SHELL",
    					"type":"JOB"
    				},
    				"config":{
    					"clusterId":"C-7CE7BC10276E24BE",
    					"hostName":"emr-header-1.cluster-71886"
    				},
    				"id":"75ba7979",
    				"index":5,
    				"label":"echo",
    				"shape":"shellJobNode",
    				"size":"170*34",
    				"spmAnchorId":"5176.8250060.0.i11.6bb528d0eMBmZQ",
    				"type":"node",
    				"x":250.125,
    				"y":585.5
    			},
    			{
    				"attribute":{
    					"type":"END"
    				},
    				"id":"ea5b3e8f",
    				"index":8,
    				"shape":"endControlNode",
    				"size":"80*34",
    				"spmAnchorId":"5176.8250060.0.i19.6bb528d0eMBmZQ",
    				"type":"node",
    				"x":239.125,
    				"y":700.5
    			}
    		]
    	},
    	"HostName":"",
    	"Id":"F-7A39731FE7196358",
    	"Name":"flow",
    	"ParentFlowList":{
    		"ParentFlow":[]
    	},
    	"Periodic":false,
    	"RequestId":"E909BE04-1989-4751-93E6-1327FFC71EC0",
    	"Status":"STOP_SCHEDULE",
    	"Type":"EMR",
    	"alertDingDingGroupBizId":"",
    	"alertUserGroupBizId":""
    }
  • Error response examples
    JSON format
    {
    	"code":"FLOW_API_FAILED",
    	"message":"Flow does not exist [F-ACB9F1075C7D62A]",
    	"requestId":"243D5A48-96A5-4C0C-8966-93CBF65635ED",
    	"successResponse":false
    }

Error codes

View error codes.