调用ListFlowJob接口查询作业列表。

调试

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

请求参数

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

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

ProjectId String FP-257A173659F5****

项目ID。

RegionId String cn-hangzhou

地域ID。

Adhoc Boolean false

是否为临时查询。

Id String FJ-BCCAE48B90CCB37B

作业ID。

Name String my_shell_job

作业名称。

PageNumber Integer 1

页码。

PageSize Integer 20

每页数量。

Type String SHELL

作业类型。目前支持:MR、SPARK、HIVE_SQL、HIVE、PIG、SQOOP、SPARK_SQL、SPARK_STREAMING、SHELL。

返回数据

名称 类型 示例值 描述
JobList

作业列表。

Job

作业列表。

Adhoc String false

是否为临时查询。

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

报警配置。

CategoryId String FC-5BD9575E34623940

目录ID。

CustomVariables String "{\"scope\":\"PROJECT\",\"entityId\":\"FP-80C2FDDBF35D9CC5\",\"variables\":[{\"name\":\"v1\",\"value\":\"1\",\"properties\":{\"password\":true}}]}"

自定义变量。

Description String 这是一个数据开发作业描述

作业描述。

EnvConf String {"key":"value"}

环境变量设置。

FailAct String STOP

失败策略,支持:

  • CONTINUE(跳过)。
  • STOP(停止工作流)。
GmtCreate Long 1538017814000

创建时间。

GmtModified Long 1538017814000

修改时间。

Id String FJ-BCCAE48B90CCB37B

作业ID。

LastInstanceDetail String ""

已过期。

MaxRetry Integer 5

最大重试次数。

MonitorConf String {"inputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic","consumer.group":"kafka_consumer_group"}],"outputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic"}]}

监控配置,只有SPARK_STREAMING类型作业支持。

Name String my_shell_job

作业名称。

ParamConf String {"date":"${yyyy-MM-dd}"}

参数设置。

Params String ls -l

作业内容。

ResourceList

资源列表。

Resource

资源列表。

Alias String demo.jar

资源别名。

Path String oss://path/demo.jar

资源路径。

RetryInterval Long 200

重试间隔 0-300(秒)。

RunConf String {"priority":1,"userName":"hadoop","memory":2048,"cores":1}

运行设置。

Type String SHELL

作业类型,目前支持:MR、SPARK、HIVE_SQL、HIVE、PIG、SQOOP、SPARK_SQL、SPARK_STREAMING、SHELL。

mode String YARN

模型模式,支持:YARN、LOCAL。

PageNumber Integer 1

页码。

PageSize Integer 20

每页数量。

RequestId String 7D2B1B2E-8D89-49C1-8D31-097C83879D20

请求ID。

Total Integer 11

总数。

示例

请求示例


http(s)://[Endpoint]/?Action=ListFlowJob
&ProjectId=FP-257A173659F5****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<ListFlowJobResponse>
  <PageSize>2</PageSize>
	  <RequestId>B83F5335-C8BF-47E9-9DE2-AC1C5E1B3D39</RequestId>
	  <PageNumber>1</PageNumber>
	  <Total>6</Total>
	  <JobList>
		    <Job>
			      <FailAct>STOP</FailAct>
			      <CategoryId>FC-BF013F34DE395AFC</CategoryId>
			      <Description>success</Description>
			      <GmtModified>1542957519000</GmtModified>
			      <Params>
				sleep 10;
			exit 0;</Params>
			      <MaxRetry>0</MaxRetry>
			      <Name>success</Name>
			      <ResourceList></ResourceList>
			      <Type>SHELL</Type>
			      <GmtCreate>1542957478000</GmtCreate>
			      <Adhoc>false</Adhoc>
			      <RetryInterval>15</RetryInterval>
			      <Id>FJ-31BD66C7BC50****</Id>
		    </Job>
		    <Job>
			      <FailAct>STOP</FailAct>
			      <CategoryId>FC-54C10B119442DC0C</CategoryId>
			      <Description>fail</Description>
			      <GmtModified>1542958715000</GmtModified>
			      <Params>
				sleep 10;
			exit 1;</Params>
			      <MaxRetry>0</MaxRetry>
			      <Name>fail</Name>
			      <ResourceList></ResourceList>
			      <Type>SHELL</Type>
			      <GmtCreate>1542957560000</GmtCreate>
			      <Adhoc>false</Adhoc>
			      <RetryInterval>15</RetryInterval>
			      <Id>FJ-A200F16108CA****7</Id>
		    </Job>
	  </JobList>
	

</ListFlowJobResponse>

JSON 格式

{
	"PageNumber":1,
	"JobList":{
		"Job":[
			{
				"FailAct":"STOP",
				"Description":"success",
				"Type":"SHELL",
				"GmtCreate":1542957478000,
				"GmtModified":1542957519000,
				"Name":"success",
				"MaxRetry":0,
				"CategoryId":"FC-BF013F34DE395AFC",
				"RetryInterval":15,
				"ResourceList":{
					"Resource":[]
				},
				"Params":"sleep 10;\nexit 0;",
				"Id":"FJ-31BD66C7BC50****",
				"Adhoc":false
			},
			{
				"FailAct":"STOP",
				"Description":"fail",
				"Type":"SHELL",
				"GmtCreate":1542957560000,
				"GmtModified":1542958715000,
				"Name":"fail",
				"MaxRetry":0,
				"CategoryId":"FC-54C10B119442DC0C",
				"RetryInterval":15,
				"ResourceList":{
					"Resource":[]
				},
				"Params":"sleep 10;\nexit 1;",
				"Id":"FJ-A200F16108CA****",
				"Adhoc":false
			}
		]
	},
	"PageSize":2,
	"RequestId":"B83F5335-C8BF-47E9-9DE2-AC1C5E1B3D39",
	"Total":6
}

错误码

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