Stopping Jobs in Batches¶
Function¶
This API is used to stop running jobs in batches.
URI¶
URI format
POST /v1.0/{project_id}/streaming/jobs/stop
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.
Request¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
job_ids | Yes | Array of Long | Job ID. |
trigger_savepoint | No | Boolean | Whether to create a savepoint for a job to store the job status information before stopping it. The data type is Boolean.
|
Response¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
Array elements | No | Array of Objects | The response message returned is as follows: For details, see Table 4. |
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¶
Stop the jobs whose IDs are 128 and 137.
{
"job_ids": [128, 137],
"trigger_savepoint": false
}
Example Response¶
[{"is_success":"true",
"message": "The request for stopping DLI jobs is delivered successfully."}]
Status Codes¶
Table 5 describes status codes.
Status Code | Description |
|---|---|
200 | The request of stopping a job is sent successfully. |
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.