调用 ListFlow 接口查询工作流列表

调试

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

请求参数

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

系统规定参数。取值:ListFlow。

RegionId String cn-hangzhou

区域ID。

ClusterId String C-F32FB31D82954C64

集群ID。

Id String F-A32FB31D82954C64

工作流ID。

JobId String FJ-F32FB31D82954C64

作业ID。

Name String my_flow

工作流名称。

PageNumber Integer 1

页码。

PageSize Integer 20

每页查询数量。

Periodic Boolean true

是否调度。

ProjectId String FP-3535FE0BE5224A47

项目ID。

Status String STOP_SCHEDULE

状态:

  • STOP_SCHEDULE(停止调度)。
  • UNDER_SCHEDULE(调度中)。

返回数据

名称 类型 示例值 描述
Flow

工作流列表。

Flow

工作流列表。

AlertConf String "{\"items\":[{\"enable\":true,\"eventId\":\"EMR-210401001\",\"alertUserGroupIdList\":[\"AUG-52dabfbbca654b52aae05ac5acd9a0f0\"],\"alertDingDingGroupList\":[\"ADG-2c411c452e6b467b9a59fadf21d195ad\"]}]}"

报警配置。

AlertDingDingGroupBizId String 已过期

已过期。

AlertUserGroupBizId String 已过期

已过期。

CategoryId String FC-2CF58396A18923B6

目录ID。

ClusterId String C-F32FB31D82954C64

集群ID。

CreateCluster Boolean false

是否通过集群模板创建集群。

CronExpr String 0 0 0 * * ?

调度Cron时间表达式。

Description String my flow demo

工作流描述。

EndSchedule Long 4102416001000

调度结束时间。

GmtCreate Long 1541561048000

创建时间。

GmtModified Long 1542902401000

修改时间。

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}]}

图形信息。

HostName String emr-header-1.cluster-123456

指定运行的机器信息,格式为emr-header-1.cluster-123456

Id String 7A39731FE7196358

工作流ID。

Name String my_flow_demo

工作流名称。

Periodic Boolean true

是否周期调度。

ProjectId String FP-3535FE0BE5224A47

项目ID。

StartSchedule Long 1541561443000

开始调度时间。

Status String UNDER_SCHEDULE

状态, 支持STOP_SCHEDULEUNDER_SCHEDULE

Type String EMR

目前只支持EMR。

PageNumber Integer 1

页码。

PageSize Integer 20

每页数量。

RequestId String 7DDFF4C7-3AE3-485F-BFA1-BAE0AA3689DD

请求ID。

Total Integer 1

总数。

示例

请求示例


http(s)://[Endpoint]/?Action=ListFlow
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<ListFlowResponse>
  <PageSize>500</PageSize>
	  <RequestId>7DDFF4C7-3AE3-485F-BFA1-BAE0AA3689DD</RequestId>
	  <PageNumber>1</PageNumber>
	  <Total>1</Total>
	  <Flow>
		    <Flow>
			      <StartSchedule>1541561443000</StartSchedule>
			      <Status>UNDER_SCHEDULE</Status>
			      <CategoryId>FC-2CF58396A18923B6</CategoryId>
			      <Description>daily_0</Description>
			      <ClusterId>C-F32FB31D8295****</ClusterId>
			      <GmtModified>1542902401000</GmtModified>
			      <ProjectId>FP-3535FE0BE5224A47</ProjectId>
			      <Periodic>true</Periodic>
			      <CronExpr>0 0 0 * * ?</CronExpr>
			      <Name>daily_0</Name>
			      <Type>EMR</Type>
			      <GmtCreate>1541561048000</GmtCreate>
			      <Id>F-D156B45E06F1****</Id>
			      <EndSchedule>4102416001000</EndSchedule>
			      <HostName></HostName>
			      <CreateCluster>false</CreateCluster>
		    </Flow>
	  </Flow>
	

</ListFlowResponse>

JSON 格式

{
	"Flow":{
		"Flow":[
			{
				"Description":"daily_0",
				"Type":"EMR",
				"CreateCluster":false,
				"CronExpr":"0 0 0 * * ?",
				"GmtCreate":1541561048000,
				"GmtModified":1542902401000,
				"HostName":"",
				"StartSchedule":1541561443000,
				"Name":"daily_0",
				"EndSchedule":4102416001000,
				"Status":"UNDER_SCHEDULE",
				"CategoryId":"FC-2CF58396A18923B6",
				"ClusterId":"C-F32FB31D8295****",
				"Periodic":true,
				"Id":"F-D156B45E06F1****",
				"ProjectId":"FP-3535FE0BE5224A47"
			}
		]
	},
	"PageNumber":1,
	"PageSize":500,
	"RequestId":"7DDFF4C7-3AE3-485F-BFA1-BAE0AA3689DD",
	"Total":1
}

错误码

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