调用DescribeFlowJob接口,查询作业信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeFlowJob |
系统规定参数。取值:DescribeFlowJob。 |
ProjectId | String | 是 | FP-3535FE0BE5228*** |
项目ID。您可以调用ListFlowProjects查看项目的ID。 |
Id | String | 是 | FJ-1A2FB31D8295**** |
作业ID。您可以调用ListFlowJobs查看作业ID。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Type | String | SPARK |
作业的类型,可能的取值有:SPARK,SPARK_STREAMING,ZEPPELIN |
LastInstanceId | String | FJI-0BA97D0BB8F3**** |
最后一次执行的实例ID。 |
EnvConf | String | {"key":"value"} |
环境变量设置。 |
RetryInterval | Long | 200 |
重试间隔 0~300(秒)。 |
Mode | String | YARN |
模型模式,取值如下: YARN:将作业包装成一个Launcher提交至YARN中执行,LOCAL:作业直接在机器上以进程方式运行。 |
GmtModified | Long | 1538017813000 |
最后修改时间。 |
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类型作业支持监控配置。 |
Params | String | oss://bucket_name/jar_to_run.jar |
作业内容。 |
RequestId | String | 1549175a-6d14-4c8a-89f9-5e28300f6d7e |
请求ID。 |
Description | String | 这是一个作业描述。 |
作业的描述。 |
RetryPolicy | String | 无 |
重试策略,保留参数。 |
Adhoc | String | false |
是否临时查询。 |
Name | String | Job_name_example |
作业名称。 |
MaxRetry | Integer | 3 |
最大重试次数。 |
MaxRunningTimeSec | Long | 0 |
保留参数。 |
FailAct | String | STOP |
失败策略,可能的取值:CONTINUE(提过本次作业),STOP(停止作业) |
CustomVariables | String | {"scope": "project"} |
自定义变量。 |
EditLockDetail | String | 无 |
保留参数。 |
ParamConf | String | {"date":"${yyyy-MM-dd}"} |
参数设置。 |
RunConf | String | {"priority":1,"userName":"hadoop","memory":2048,"cores":1} |
运行配置,取值如下:priority(优先级),userName(任务的Linux提交用户),memory(内存,单位为MB),cores(核数) |
KnoxUser | String | my_knox_user_name |
Knox的用户名,执行Zeppelin Notebook时必须提供。 |
KnoxPassword | String | my_knox_password |
Knox的用户密码,执行Zeppelin Notebook时必须提供。 |
GmtCreate | Long | 1538017814000 |
创建时间。 |
CategoryId | String | FC-5BD9575E3462**** |
作业所在目录ID。 |
Id | String | FJ-BCCAE48B90CC**** |
作业ID。 |
AlertConf | String | 无 |
报警配置。 |
ResourceList | Array of Resource |
资源列表。 |
|
Resource | |||
Path | String | 无 |
保留参数。 |
Alias | String | 无 |
保留参数。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeFlowJob
&ProjectId=FP-3535FE0BE5228***
&Id=FJ-1A2FB31D8295****
&RegionId=cn-hangzhou
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeFlowJobResponse>
<Type>SPARK</Type>
<LastInstanceId>FJI-0BA97D0BB8F3****</LastInstanceId>
<EnvConf>{"key":"value"}</EnvConf>
<RetryInterval>200</RetryInterval>
<Mode>YARN</Mode>
<GmtModified>1538017813000</GmtModified>
<MonitorConf>{"inputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic","consumer.group":"kafka_consumer_group"}],"outputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic"}]}</MonitorConf>
<Params>oss://bucket_name/jar_to_run.jar</Params>
<RequestId>1549175a-6d14-4c8a-89f9-5e28300f6d7e</RequestId>
<Description>这是一个作业描述。</Description>
<RetryPolicy>无</RetryPolicy>
<Adhoc>false</Adhoc>
<Name>Job_name_example</Name>
<MaxRetry>3</MaxRetry>
<MaxRunningTimeSec>0</MaxRunningTimeSec>
<FailAct>STOP</FailAct>
<CustomVariables>{"scope": "project"}</CustomVariables>
<EditLockDetail>无</EditLockDetail>
<ParamConf>{"date":"${yyyy-MM-dd}"}</ParamConf>
<RunConf>{"priority":1,"userName":"hadoop","memory":2048,"cores":1}</RunConf>
<KnoxUser>my_knox_user_name</KnoxUser>
<KnoxPassword>my_knox_password</KnoxPassword>
<GmtCreate>1538017814000</GmtCreate>
<CategoryId>FC-5BD9575E3462****</CategoryId>
<Id>FJ-BCCAE48B90CC****</Id>
<AlertConf>无</AlertConf>
<ResourceList>
<Path>无</Path>
<Alias>无</Alias>
</ResourceList>
</DescribeFlowJobResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Type" : "SPARK",
"LastInstanceId" : "FJI-0BA97D0BB8F3****",
"EnvConf" : "{\"key\":\"value\"}",
"RetryInterval" : 200,
"Mode" : "YARN",
"GmtModified" : 1538017813000,
"MonitorConf" : "{\"inputs\":[{\"type\":\"KAFKA\",\"clusterId\":\"C-1234567\",\"topics\":\"kafka_topic\",\"consumer.group\":\"kafka_consumer_group\"}],\"outputs\":[{\"type\":\"KAFKA\",\"clusterId\":\"C-1234567\",\"topics\":\"kafka_topic\"}]}",
"Params" : "oss://bucket_name/jar_to_run.jar",
"RequestId" : "1549175a-6d14-4c8a-89f9-5e28300f6d7e",
"Description" : "这是一个作业描述。",
"RetryPolicy" : "无",
"Adhoc" : false,
"Name" : "Job_name_example",
"MaxRetry" : 3,
"MaxRunningTimeSec" : 0,
"FailAct" : "STOP",
"CustomVariables" : "{\"scope\": \"project\"}",
"EditLockDetail" : "无",
"ParamConf" : "{\"date\":\"${yyyy-MM-dd}\"}",
"RunConf" : "{\"priority\":1,\"userName\":\"hadoop\",\"memory\":2048,\"cores\":1}",
"KnoxUser" : "my_knox_user_name",
"KnoxPassword" : "my_knox_password",
"GmtCreate" : 1538017814000,
"CategoryId" : "FC-5BD9575E3462****",
"Id" : "FJ-BCCAE48B90CC****",
"AlertConf" : "无",
"ResourceList" : {
"Path" : "无",
"Alias" : "无"
}
}
错误码
访问错误中心查看更多错误码。
访问错误中心查看更多错误码。