Document toolboxDocument toolbox

Job requests

Overview

All query requests that forward their results to data storage systems like HDFS, Kafka, or S3 are assigned job IDs so that they can be monitored and managed. The job ID for a query is contained in the notification message returned to the query sender when the request is launched. This ID is used to monitor the status of the query or to manage it.

The request action is specified by appending the following paths to the endpoint URL:

Endpoints and methods

Description

Endpoints and methods

Description

get /job/{jobId} see below

Returns the current status of the query and some other basic information.

get /jobs see below

Returns the status of all the queries launched in the domain that are currently running.

get /job/stop/{jobId} see below

Stops a currently running query.

get /job/start/{jobId} see below

Starts a query that was previously stopped.

get /job/remove/{jobId} see below

Removes a query.

Endpoints and methods

GET /job/{jobId}

Returns the current status of the query and some other basic information.

GET /jobs

This returns the status of all the queries that the account has launched and which are currently running.

GET /job/stop/{jobId}

This stops a currently running query. Once stopped, a lastDatetime value is saved so that when the job is started again, it will pick up where it left off. The lastDatetime parameter is contained in the object returned in the response.

GET /job/start/{jobId}

This starts a query that was previously stopped. The query will continue from the time saved as the lastDatetime.

GET /job/remove/{jobId}

Removes a query.