This API is used to cancel a batch processing job.
Batch processing jobs in the Successful or Failed state cannot be canceled.
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. |
None
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
msg |
No |
String |
If the batch processing job is successfully canceled, value deleted is returned. |
None
{ "msg": "deleted" }
Table 3 describes the status code.
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 Code.