Jobs Service OpenAPI Spec

• Job
  • putCancel Job
  • postSubmit a Job
  • getGet Job

API docs by Redocly

OpenHouse APIs (v0.0.1)

Download OpenAPI specification:Download

License: Apache 2.0 Terms of Service

API description for OpenHouse API

Job

Cancel Job

Cancels the job given jobId

path Parameters

jobId required

string Job ID

Responses

Generated server url

http://localhost:8080/jobs/{jobId}/cancel

Submit a Job

Submits a Job and returns a Job resource.

Request Body schema: application/json

required

jobName required	string^[a-zA-Z0-9-_]+$ Name of a job, doesn't need to be unique
clusterId required	string^[a-zA-Z0-9-_]+$ Unique identifier for the cluster
	object (JobConf) Job config

Responses

Generated server url

http://localhost:8080/jobs

Request samples

• Payload

Content type

application/json

{

• "jobName": "my_job",
• "clusterId": "my_cluster",
• "jobConf": "{'jobType': 'RETENTION', 'table': 'db.tb'}"

}

Response samples

• 201
• 400

Content type

application/json

{

• "jobId": "my_job_8347adee-65b7-4e05-86fc-196af04f4e68",
• "jobName": "my_job",
• "clusterId": "my_cluster",
• "state": "SUCCEEDED",
• "creationTimeMs": 1651002318265,
• "startTimeMs": 1651002318265,
• "finishTimeMs": 1651002318265,
• "lastUpdateTimeMs": 1651002318265,
• "jobConf": "{'jobType': 'RETENTION', 'table': 'db.tb'}",
• "executionId": "string"

}

Get Job

Returns a Job resource identified by jobId.

path Parameters

jobId required

string Job ID

Responses

Generated server url

http://localhost:8080/jobs/{jobId}

Response samples

• 200
• 404

Content type

application/json

{

• "jobId": "my_job_8347adee-65b7-4e05-86fc-196af04f4e68",
• "jobName": "my_job",
• "clusterId": "my_cluster",
• "state": "SUCCEEDED",
• "creationTimeMs": 1651002318265,
• "startTimeMs": 1651002318265,
• "finishTimeMs": 1651002318265,
• "lastUpdateTimeMs": 1651002318265,
• "jobConf": "{'jobType': 'RETENTION', 'table': 'db.tb'}",
• "executionId": "string"

}