Creating a Flink Jar Job

Function

This API is used to create custom jobs, which currently support the JAR format and run in dedicated queues.

Authorization

Each account has full permissions to call all APIs, but its IAM users need permission assignments to do so. For specific permission requirements, refer to Permissions Policies and Supported Actions.

URI

URI format
POST /v1.0/{project_id}/streaming/flink-jobs

Parameter description

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used for resource isolation. For details about how to obtain a project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Parameter descriptions
Parameter	Mandatory	Type	Description
name	Yes	String	Job name. The value can contain up to 57 characters.
desc	No	String	Job description. Length range: 0 to 512 characters.
queue_name	No	String	Queue name. The value can contain 0 to 128 characters.
cu_number	No	Integer	Number of CUs selected for a job.
manager_cu_number	No	Integer	Number of CUs on the management node selected by the user for a job, which corresponds to the number of Flink job managers. The default value is 1.
parallel_number	No	Integer	Number of parallel operations selected for a job.
checkpoint_enabled	No	Boolean	Whether to enable the automatic job snapshot function. Options: true: Enable this function. false: Do not enable this function. Default value: false.
checkpoint_mode	No	Integer	Snapshot mode. Options: 1: ExactlyOnce, meaning data is consumed only once. 2: AtLeastOnce, meaning data is consumed at least once. Default value: 1.
checkpoint_interval	No	Integer	Snapshot interval. The unit is second. The default value is 10.
log_enabled	No	Boolean	Whether to enable the job log function. Options: true: Enable this function. false: Do not enable this function. Default value: false.
obs_bucket	No	String	OBS bucket where users are authorized to save logs when log_enabled is set to true.
smn_topic	No	String	SMN topic. If a job fails, the system will send a message to users subscribed to this SMN topic.
main_class	No	String	Job entry class.
entrypoint_args	No	String	Job entry parameter. Multiple parameters are separated by spaces.
restart_when_exception	No	Boolean	Whether to enable the function of restart upon exceptions. The default value is false.
entrypoint	No	String	Name of the package uploaded to OBS. You can customize the JAR file where the main job class is. For Flink 1.15 or later, you can only select packages from OBS, instead of DLI. Example: obs://bucket_name/test.jar
dependency_jars	No	Array of strings	Name of the package uploaded to OBS. You can customize other dependency packages of the job. For Flink 1.15 or later, you can only select packages from OBS, instead of DLI. Example: obs://bucket_name/test1.jar, obs://bucket_name/test2.jar
dependency_files	No	Array of strings	Name of the resource package uploaded to OBS. You can customize the dependency files of the job. For Flink 1.15 or later, you can only select packages from OBS, instead of DLI. Example: [obs://bucket_name/file1, obs://bucket_name/file2] You can add the following content to the application to access the corresponding dependency file: In the command, fileName indicates the name of the file to be accessed, and ClassName indicates the name of the class that needs to access the file. ClassName.class.getClassLoader().getResource("userData/fileName")
tm_cus	No	Integer	Number of CUs for each TaskManager. The default value is 1.
tm_slot_num	No	Integer	Number of slots in each TaskManager. The default value is *(parallel_numbertm_cus)/(cu_number-manager_cu_number)**.
feature	No	String	Job feature. Type of the Flink image used by a job. basic: indicates that the basic Flink image provided by DLI is used. custom: indicates that the user-defined Flink image is used.
flink_version	No	String	Flink version. This parameter is valid only when feature is set to basic. You can use this parameter with the feature parameter to specify the version of the DLI basic Flink image used for job running.
execution_agency_urn	No	String	Name of the agency authorized to DLI. This parameter is configurable in Flink 1.15.
image	No	String	Custom image. The format is Organization name/Image name:Image version. This parameter is valid only when feature is set to custom. You can use this parameter with the feature parameter to specify a user-defined Flink image for job running. For details about how to use custom images, see Data Lake Insight User Guide.
resume_checkpoint	No	Boolean	Whether the abnormal restart is recovered from the checkpoint.
resume_max_num	No	Integer	Maximum number of retry times upon exceptions. The unit is times/hour. Value range: -1 or greater than 0. The default value is -1, indicating that the number of times is unlimited.
checkpoint_path	No	String	Storage address of the checkpoint in the JAR file of the user. The path must be unique.
tags	No	Array of objects	Label of a Flink JAR job. For details, see Table 3.
runtime_config	No	String	Customizes optimization parameters when a Flink job is running.
resource_config_version	No	String	Resource configuration version. The value can be v1 or v2. The default value is v1. Compared with the v1 template, the v2 template does not support the setting of the number of CUs. The v2 template supports the setting of Job Manager Memory and Task Manager Memory. v1: applicable to Flink 1.12 and 1.15. v2: applicable to Flink 1.15 and 1.17. You are advised to use the parameter settings of v2.
resource_config	No	Object	Resource configuration of a Flink job. For detailed parameter descriptions, refer to Table 4. When the resource configuration version is v2, the configuration takes effect; when the resource configuration version is v1, the configuration is invalid.

**Table 3** tags parameters
Parameter	Mandatory	Type	Description
key	Yes	String	Tag key. NOTE: A tag key can contain up to 128 characters, cannot start or end with a space, and cannot start with _sys_. Only letters, digits, spaces, and the following special characters are allowed: _.:=+-@
value	Yes	String	Tag value. NOTE: A tag value can contain up to 255 characters and cannot start or end with a space. Only letters, digits, spaces, and the following special characters are allowed: _.:=+-@

**Table 4** resource_config parameters
Parameter	Mandatory	Type	Description
max_slot	No	integer	Number of parallel tasks that a single TaskManager can support. Each task slot can execute one task in parallel. Increasing task slots enhances the parallel processing capacity of the TaskManager but also increases resource consumption. The number of task slots is linked to the CPU count of the TaskManager since each CPU can offer one task slot. By default, a single TM slot is set to 1. The minimum parallelism must not be less than 1.
parallel_number	No	integer	Number of tasks concurrently executed by each operator in a job. The default value is 1.
jobmanager_resource_spec	No	Object	JobManager resource specifications. For details about the parameters, see Table 5.
taskmanager_resource_spec	No	Object	TaskManager resource specifications. For details about the parameters, see Table 6.

**Table 5** jobmanager_resource_spec parameters
Parameter	Mandatory	Type	Description
cpu	No	double	Number of CPU cores available for JobManager. The default value is 1.0 CPU core, with a minimum of no less than 0.5 CPU cores. If the current job is running on a basic edition elastic resource pool (16–64 CUs), it is recommended that the JobManager's CPU value does not exceed 2 to avoid resource scheduling failures during job execution.
memory	No	string	Memory that can be used by JobManager, in MB or GB. The default unit is GB. The default value is 4 GB, and the minimum value is 2 GB.

**Table 6** taskmanager_resource_spec parameters
Parameter	Mandatory	Type	Description
cpu	No	double	Number of CPU cores available for TaskManager. The default value is 1.0 CPU core, with a minimum of no less than 0.5 CPU cores. If the current job is running on a basic edition elastic resource pool (16–64 CUs), it is recommended that the TaskManager's CPU value does not exceed 2 to avoid resource scheduling failures during job execution.
memory	No	string	Memory that can be used by TaskManager, in MB or GB. The default unit is GB. The default value is 4 GB, and the minimum value is 2 GB.

Response Parameters

**Table 7** Response parameters
Parameter	Mandatory	Type	Description
is_success	No	String	Whether the request is successfully executed. Value true indicates that the request is successfully executed.
message	No	String	Message content.
job	No	Object	Information about the job status. For details, see Table 8.

**Table 8** job parameters
Parameter	Mandatory	Type	Description
job_id	Yes	Long	Job ID.
status_name	No	String	Name of job status.
status_desc	No	String	Status description. Causes and suggestions for the abnormal status.

Example Request

Create a Flink Jar job named test, set the job to be executed on testQueue, set the number of CUs used by the job, and enable the job log function.

{
    "name": "test",
    "desc": "job for test",
    "queue_name": "testQueue",
    "manager_cu_number": 1,
    "cu_number": 2,
    "parallel_number": 1,
    "tm_cus": 1,
    "tm_slot_num": 1,
    "log_enabled": true,
    "obs_bucket": "bucketName",
    "smn_topic": "topic",
    "main_class": "org.apache.flink.examples.streaming.JavaQueueStream",
    "restart_when_exception": false,
    "entrypoint": "javaQueueStream.jar",
    "entrypoint_args":"-windowSize 2000 -rate 3",
    "dependency_jars": [
        "myGroup/test.jar",
        "myGroup/test1.jar"
    ],
    "execution_agency_urn": "myAgencyName",
    "dependency_files": [
        "myGroup/test.csv",
        "myGroup/test1.csv"
    ]
}

Example Response

{
  "is_success": true,
  "message": "A Flink job is created successfully.",
  "job": {
    "job_id": 138,
    "status_name": "job_init",
    "status_desc": ""
  }
}

Status Codes

Table 9 describes status codes.

**Table 9** Status codes
Status Code	Description
200	The custom Flink job is created successfully.
400	The input parameter is invalid.

Error Codes

If an error occurs when this API is called, the system does not return the result similar to the preceding example, but returns an error code and error message. For details, see Error Codes.

Parent topic: Flink Job-related APIs

Previous topic: Updating a SQL Job

Next topic: Updating a Flink Jar Job