Canceling a Batch Processing Job¶
Function¶
This API is used to cancel a batch processing job.
Note
Batch processing jobs in the Successful or Failed state cannot be canceled.
URI¶
URI format
DELETE /v2.0/{project_id}/batches/{batch_id}
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.
batch_id
Yes
String
ID of a batch processing job. Set the value to the job ID obtained in Creating a Batch Processing Job.
Request¶
None
Response¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
msg | No | String | If the batch processing job is successfully canceled, value deleted is returned. |
Example Request¶
None
Example Response¶
{
"msg": "deleted"
}
Status Codes¶
Table 3 describes the status code.
Status Code | Description |
|---|---|
200 | Deletion succeeded. |
400 | Request error. |
500 | Internal service error. |
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.