Running Jobs in Batches¶

Function¶

This API is used to trigger batch job running.

URI¶

URI format
POST /v1.0/{project_id}/streaming/jobs/run
Parameter description
Table 1 URI parameters¶
Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

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

Request¶

**Table 2** Request parameters¶
Parameter	Mandatory	Type	Description
job_ids	Yes	Array of Long	Batch job ID. You can obtain the job ID by calling the API for creating a job or the API for querying a job.
resume_savepoint	No	Boolean	Whether to restore a job from the latest savepoint. If resume_savepoint is set to true, the job is restored from the latest savepoint. If resume_savepoint is set to false, the job is started normally, not from a specific savepoint. The default value is false.

Response¶

**Table 3** Response parameters¶
Parameter	Mandatory	Type	Description
Array elements	No	Array of Objects	The response message returned is as follows: For details, see Table 4.

**Table 4** Array element parameters¶
Parameter	Mandatory	Type	Description
is_success	No	Boolean	Whether the request is successfully executed. Value true indicates that the request is successfully executed.
message	No	String	Message content.

Example Request¶

Run the jobs whose IDs are 131, 130, 138, and 137 and allow the jobs to be restored from their latest savepoints.

{
    "job_ids": [131,130,138,137],
    "resume_savepoint": true
}

Example Response¶

[
    {
        "is_success": "true",
        "message": "The request for submitting DLI jobs is delivered successfully."
    },
    {
        "is_success": "true",
        "message": "The request for submitting DLI jobs is delivered successfully."
    },
    {
        "is_success": "true",
        "message": "The request for submitting DLI jobs is delivered successfully."
    },
    {
        "is_success": "true",
        "message": "The request for submitting DLI jobs is delivered successfully."
    }
]

Status Codes¶

Table 5 describes status codes.

**Table 5** Status codes¶
Status Code	Description
200	Jobs are successfully run in batches.
400	The input parameter is invalid.

Error Codes¶

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

last updated: 2024-11-20 15:34 UTC - commit: c856450509a511f9057fb9577287974ed6fce406