Deleting Jobs in Batches¶
Function¶
This API is used to batch delete jobs at any state.
URI¶
URI format
POST /v1.0/{project_id}/streaming/jobs/delete
Parameter description
¶ 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 | [Long] | Job ID. |
Response¶
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 | System prompt. If execution succeeds, the parameter setting may be left blank. |
Example Request¶
Delete the jobs whose IDs are 12 and 232.
{
"job_ids":[12,232]
}
Example Response¶
[{
"is_success": "true",
"message": "The job is deleted successfully.",
}]
Status Codes¶
Table 4 describes status codes.
Status Code | Description |
---|---|
200 | The job is deleted 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.