Help Center> Data Lake Insight> API Reference> APIs Related to Spark jobs> Batch Processing-related APIs> Canceling a Batch Processing Job
View PDF

Canceling a Batch Processing Job

Function

This API is used to cancel a batch processing job.

Debugging

You can debug this API in API Explorer.

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.

Request

None

Response

Table 2 Response parameter

Parameter

Mandatory

Type

Description

msg

No

String

If the batch processing job is successfully canceled, value deleted is returned.

Example

  • Example request 
    None
  • Example response (successful request) 
    {
    "msg": "deleted"
}

Status Codes

Table 3 describes the status code.

Table 3 Status codes

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 Code.