You can call this operation to create a job.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateFlowJob

The operation that you want to perform. Set the value to CreateFlowJob.

Description String Yes This is the description of a job

The description of the job.

Name String Yes my_shell_job

The name of the job.

ProjectId String Yes FP-257A173659F59685

The ID of the project.

RegionId String Yes cn-hangzhou

The ID of the region where your project resides.

Type String Yes SHELL

The type of the job. Valid values: MR, SPARK, HIVE_SQL, HIVE, PIG, SQOOP, SPARK_SQL, SPARK_STREAMING, and SHELL.

Adhoc Boolean No false

Indicates whether the job is a temporary query job.

ClusterId String No C-A23BD131A862F184

The ID of the cluster.

EnvConf String No {"key":"value"}

The environment variables configured for the job.

FailAct String No CONTINUE

The action to take upon an operation failure of the node instance. Valid values:

  • CONTINUE: skips the node instance
  • STOP: stops the workflow instance
MaxRetry Integer No 5

The maximum number of retries to run the node instance if a failure occurs.

  • Valid values: 0 to 5.
Mode String No YARN

The submission mode of the job. Valid values: YARN and LOCAL.

  • YARN: submits the job from a worker node
  • LOCAL: submits the job from a header or gateway node
MonitorConf String No {"inputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic","consumer.group":"kafka_consumer_group"}],"outputs":[{"type":"KAFKA","clusterId":"C-1234567","topics":"kafka_topic"}]}

The monitoring configuration of the job. This parameter only applies to SPARK_STREAMING jobs.

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

The configuration parameters of the job.

Params String No ls -l

The content of the job.

ParentCategory String No FC-5BD9575E34623940

The parent directory ID of the job.

ResourceList.N.Alias String No demo.jar

The alias of the resource.

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

The storage path of the resource. The resource can be stored in OSS and HDFS.

RetryInterval Long No 200

The interval between successive retries to run the node instance. Valid values: 0 to 300. Unit: seconds.

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

The scheduling parameters configured for the job.

  • priority: the priority of the job.
  • userName: the name of the Linux user who submits the job.
  • memory: the memory allocated to the job. Unit: MB.
  • cores: the number of vCPUs allocated to the job.

Response parameters

Parameter Type Example Description
Id String FJ-A23BD131A862F184

The ID of the job.

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

The ID of the request.

Examples

Sample requests


http(s)://[Endpoint]/? Action=CreateFlowJob
&Description=This is the description of a job
&Name=my_shell_job
&ProjectId=FP-257A173659F59685
&RegionId=cn-hangzhou
&ResourceList.1.Path=oss://path/demo.jar
&Type=SHELL
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.