调用CreateFlowJob接口,创建作业。

调试

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

请求参数

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

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

Description String Job description

作业的描述。

Name String my_shell_job

作业的名称。

ProjectId String FP-257A173659F5****

项目ID。您可以调用ListFlowProject查看项目的ID。

RegionId String cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

ResourceList.N.Path String oss://path/demo.jar

资源的路径, 支持OSS和HDFS两种。

Type String SHELL

作业类型,取值如下:

  • MR
  • SPARK
  • HIVE_SQL
  • HIVE
  • PIG
  • SQOOP
  • SPARK_SQL
  • SPARK_STREAMING
  • SHELL
FailAct String CONTINUE

失败策略,取值如下:

  • CONTINUE:跳过本次作业
  • STOP:停止作业
MaxRetry Integer 5

最大重试次数,取值0~5。

RetryPolicy String

重试策略,保留参数。

MaxRunningTimeSec Long 0

保留参数。

RetryInterval Long 200

重试间隔0~300(秒)。

Params String ls -l

作业内容。

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

参数设置。

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

自定义变量。

EnvConf String {"key":"value"}

环境变量设置。

说明 整个JSON字符串的最大长度为1024字节。
RunConf String {"priority":1,"userName":"hadoop","memory":2048,"cores":1}

运行配置,取值如下:

  • priority: 优先级
  • userName: 任务Linux提交用户
  • memory: 内存,单位为MB
  • cores:核数
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类型作业支持监控配置。

Mode String YARN

模型模式,取值如下:

  • YARN:将作业包装成一个Launcher提交至YARN中执行。
  • LOCAL:作业直接在机器上以进程方式运行。
ParentCategory String FC-5BD9575E3462****

父目录ID。您可以调用DescribeFlowCategory查看。

ResourceList.N.Alias String demo.jar

资源的别名。

Adhoc Boolean false

是否临时查询。

ClusterId String C-A23BD131A862****

集群ID。您可以调用ListClusters查看集群的ID。

AlertConf String

保留参数。

返回数据

名称 类型 示例值 描述
Id String FJ-A23BD131A862****

作业ID。

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

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateFlowJob
&Description=Job description
&Name=my_shell_job
&ProjectId=FP-257A173659F5****
&RegionId=cn-hangzhou
&ResourceList.1.Path=oss://path/demo.jar
&Type=SHELL
&<公共请求参数>

正常返回示例

XML格式

<RequestId>2670BCFB-925D-4C3E-9994-8D12F7A9F538</RequestId>
<Id>FJ-BBCAE48B90CC****</Id>

JSON格式

{
    "RequestId": "2670BCFB-925D-4C3E-9994-8D12F7A9F538",
    "Id": "FJ-BBCAE48B90CC****"
}