调用DescribeFlowJob接口,查询作业信息。

调试

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

请求参数

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

系统规定参数。对于您自行拼凑HTTP或HTTPS URL发起的API请求,该参数为必选参数。取值:DescribeFlowJob。

Id String FJ-BCCAE48B90CC****

作业ID。

ProjectId String FP-257A173659F5****

项目ID。

RegionId String cn-hangzhou

地域ID。

返回数据

名称 类型 示例值 描述
CategoryId String FC-5BD9575E3462****

作业对应的目录ID。

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

作业的描述。

EnvConf String {"key":"value"}

环境变量设置。

FailAct String CONTINUE

失败策略,支持:

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

创建时间。

GmtModified Long 1538017814000

修改时间。

Id String FJ-BCCAE48B90CC****

作业ID。

LastInstanceId String FJI-0BA97D0BB8F3****

最后一次执行的实例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 Array

资源列表。

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

作业类型。支持:SPARK_SQL、SPARK_STREAMING、MR、SQOOP、PIG、FLINK、STREAMING_SQL、IMPALA_SQL、PRESTO_SQL、SPARK、Hive_SQL、Hive、SHELL及SPARK_SHELL。

mode String YARN

模型模式。支持:YARN和LOCAL。

示例

请求示例

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

正常返回示例

XML 格式

<FailAct>STOP</FailAct>
<CategoryId>FC-F2495319DA05*</CategoryId>
<Description>shell</Description>
<RequestId>7D2B1B2E-8D89-49C1-8D31-097C83879D20</RequestId>
<GmtCreate>1538017814000</GmtCreate>
<GmtModified>1538017814000</GmtModified>
<Params>ls -l</Params>
<ParamConf>{}</ParamConf>
<LastInstanceId>FJI-0BA97D0BB8F3****</LastInstanceId>
<MaxRetry>0</MaxRetry>
<MaxRunningTimeSec>0</MaxRunningTimeSec>
<Name>shell_copy</Name>
<Type>SHELL</Type>
<ResourceList>
</ResourceList>
<RetryInterval>15</RetryInterval>
<Id>FJ-C7FB9F1075C7****</Id>
<CustomVariables>[]</CustomVariables>
<AlertConf>{}</AlertConf>

JSON 格式

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

错误码

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