调用 DescribeFlowJob 接口查询作业信息

调试

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

请求参数

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

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

Id String FJ-BCCAE48B90CCB37B

作业ID。

ProjectId String FP-257A173659F59685

项目ID。

RegionId String cn-hangzhou

地域ID。

返回数据

名称 类型 示例值 描述
Adhoc String true

是否临时查询。

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 CONTINUE

失败策略,支持:

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

创建时间。

GmtModified Long 1538017814000

修改时间。

Id String FJ-BCCAE48B90CCB37B

作业ID。

LastInstanceId String FJI-ACCAE48B90CCB37B

最后一次执行的实例ID。

MaxRetry Integer 5

最大重试次数,0

  • 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

作业内容。

RequestId String 1549175a-6d14-4c8a-89f9-5e28300f6d7e

请求ID。

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}

运行配置:

  • priority:优先级。
  • userName:提交作业的 Linux 用户。
  • memory:内存 单位为 MB。
  • cores:核数。
Type String SHELL

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

mode String YARN

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

示例

请求示例


http(s)://[Endpoint]/?Action=DescribeFlowJob
&Id=FJ-BCCAE48B90CCB37B
&ProjectId=FP-257A173659F59685
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<DescribeFlowJobResponse>
  <FailAct>STOP</FailAct>
	  <CategoryId>FC-F2495319DA05CEE5</CategoryId>
	  <Description>shell</Description>
	  <RequestId>7D2B1B2E-8D89-49C1-8D31-097C83879D20</RequestId>
	  <GmtCreate>1538017814000</GmtCreate>
	  <GmtModified>1538017814000</GmtModified>
	  <Params>ls -l</Params>
	  <MaxRetry>0</MaxRetry>
	  <Name>shell_copy</Name>
	  <Type>SHELL</Type>
	  <ResourceList></ResourceList>
	  <RetryInterval>15</RetryInterval>
	  <Id>FJ-C7FB9F1075C7****</Id>
	
</DescribeFlowJobResponse>

JSON 格式

{
	"FailAct":"STOP",
	"Description":"shell",
	"Type":"SHELL",
	"GmtCreate":1538017814000,
	"GmtModified":1538017814000,
	"Name":"shell_copy",
	"MaxRetry":0,
	"CategoryId":"FC-F2495319DA05CEE5",
	"RetryInterval":15,
	"ResourceList":{
		"Resource":[]
	},
	"RequestId":"7D2B1B2E-8D89-49C1-8D31-097C83879D20",
	"Params":"ls -l",
	"Id":"FJ-C7FB9F1075C7****"
}

错误码

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