You can call this operation to view the list of workflows.

Request parameters

Parameter Type Required Example Description
ClusterId String No C-F32FB31D82954C64 The ID of the cluster.
Id String No F-A32FB31D82954C64 The ID of the workflow.
RegionId String Yes cn-hangzhou The region location ID.
JobId String No FJ-F32FB31D82954C64 The ID of the job.
Name String No my_flow The name of the workflow.
PageNumber Integer No 1 The page number to request.
PageSize Integer No 20 The number of records requested to shown on each page.
Periodic Boolean No true Indicates whether the workflows are scheduled periodically.
ProjectId String No FP-3535FE0BE5224A47 The ID of the project.
Status String No STOP_SCHEDULE The status of the workflows. Valid values: STOP_SCHEDULE and UNDER_SCHEDULE.

Response parameters

Name Type Example Description
RequestId String 7DDFF4C7-3AE3-485F-BFA1-BAE0AA3689DD The ID of the request.
PageNumber Integer 1 The page number.
PageSize Integer 20 The number of records on each page.
Total Integer 1 The total number of records.
Flow The list of the workflows.
Id String 7A39731FE7196358 The ID of the workflow.
GmtCreate Long 1541561048000 The creation time.
GmtModified Long 1542902401000 The modification time.
Name String my_flow_demo The name of the workflow.
Description String my flow demo The description of the workflow.
Type String EMR Valid value: EMR.
Status String UNDER_SCHEDULE The status of the workflow. Valid values: STOP_SCHEDULE and UNDER_SCHEDULE.
Periodic Boolean true Indicates whether the workflow is scheduled periodically.
StartSchedule Long 1541561443000 The start time of the schedule.
EndSchedule Long 4102416001000 The
The end time of the schedule. String 0 0 0 * * ? The cron expression of the schedule.
CreateCluster Boolean false Indicates whether the cluster is created using a cluster template.
ClusterId String C-F32FB31D82954C64 The ID of the cluster.
ProjectId String FP-3535FE0BE5224A47 The ID of the project.
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.
AlertUserGroupBizId String Expired The ID of the user group to send alerts.
AlertDingDingGroupBizId String Expired The ID of the DingTalk group to send alerts.
CategoryId String FC-2CF58396A18923B6 The ID of the category.

Examples

  • Sample requests
    
    /? Action=ListFlow
    &RegionId=cn-hangzhou
    &ClusterId=C-F32FB31D82954C64
    &Id=F-A32FB31D82954C64
    &JobId=FJ-F32FB31D82954C64
    &Name=my_flow
    &PageNumber=1
    &PageSize=20
    &Periodic=true
    &ProjectId=FP-3535FE0BE5224A47
    &Status=STOP_SCHEDULE
    &<Common request parameters>
  • Successful response examples
    JSON format
    {
    	"Flow":{
    		"Flow":[{
    			"CategoryId":"FC-2CF58396A18923B6",
    			"ClusterId":"C-F32FB31D82954C64",
    			"CreateCluster":false,
    			"CronExpr":"0 0 0 * * ?",
    			"Description":"daily_0",
    			"EndSchedule":4102416001000,
    			"GmtCreate":1541561048000,
    			"GmtModified":1542902401000,
    			"HostName":"",
    			"Id":"F-D156B45E06F1CA8E",
    			"Name":"daily_0",
    			"Periodic":true,
    			"ProjectId":"FP-3535FE0BE5224A47",
    			"StartSchedule":1541561443000,
    			"Status":"UNDER_SCHEDULE",
    			"Type":"EMR"
    		}]
    	},
    	"PageNumber":1,
    	"PageSize":500,
    	"RequestId":"7DDFF4C7-3AE3-485F-BFA1-BAE0AA3689DD",
    	"Total":1
    }
    &<Common request parameters>
  • Error response examples
    JSON format
    {
    	"code":"FLOW_API_FAILED",
    	"message":"Project does not exist [FP-3535FE0BE5224A4]",
    	"requestId":"93F6F3CF-B2AE-411A-948F-0F7293058CF5",
    	"successResponse":false
    }

Error codes

View error codes.