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

Querying a Batch Job Status

Function

This API is used to obtain the execution status of a batch processing job.

Debugging

You can debug this API in API Explorer.

URI

  • URI format

    GET /v2.0/{project_id}/batches/{batch_id}/state

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

    batch_id

    Yes

    ID of a batch processing job.

Request

None

Response

Table 2 Response parameter description

Parameter

Mandatory

Type

Description

id

No

String

ID of a batch processing job, which is in the universal unique identifier (UUID) format.

state

No

String

Status of a batch processing job. For details, see Table 7 in Creating a Batch Processing Job.

Example

  • Example request 
    None
  • Example response (successful request) 
    {"id":"0a324461-d9d9-45da-a52a-3b3c7a3d809e","state":"Success"}

Status Codes

Table 3 describes the status code.

Table 3 Status codes

Status Code

Description

200

The query is successful.

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.