Alluxio Job Service REST API Documentation
HTTP://[Alluxio Job Master or Job Worker Hostname]/api/v1
The Alluxio Job Master is a component of the Job Service that coordinates Alluxio Job Workers to execute distributed tasks scheduled by the Alluxio system.
The Alluxio Job Worker is a component of the Job Service that executes various I/O intensive tasks scheduled by the Alluxio system.
APIs
/job_master/info
GET
Get general job master service information
Request
Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| raw_configuration |
query |
no |
Returns raw configuration values if true, false be default. |
- |
boolean |
Response
Content-Type: application/json
/job_master/logLevel
POST
Request
Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| logName |
query |
no |
|
- |
string |
| level |
query |
no |
|
- |
string |
Response
Content-Type: application/json
| Status Code |
Reason |
Response Model |
| default |
successful operation |
- |
/job_worker/info
GET
Get general job worker service information
Request
Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| raw_configuration |
query |
no |
Returns raw configuration values if true, false be default |
- |
boolean |
Response
Content-Type: application/json
/job_worker/logLevel
POST
Request
Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| logName |
query |
no |
|
- |
string |
| level |
query |
no |
|
- |
string |
Response
Content-Type: application/json
| Status Code |
Reason |
Response Model |
| default |
successful operation |
- |
/master/job/cancel
POST
Request
Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| jobId |
query |
no |
|
- |
integer (int64) |
Response
Content-Type: application/json
| Status Code |
Reason |
Response Model |
| default |
successful operation |
- |
/master/job/get_status
GET
Gets the status of a job
Request
Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| jobId |
query |
no |
|
- |
integer (int64) |
Response
Content-Type: application/json
| Status Code |
Reason |
Response Model |
| 200 |
successful operation |
JobInfo |
/master/job/list
GET
Request
Parameters
| Name |
Located in |
Required |
Description |
Default |
Schema |
| status |
query |
no |
|
- |
Array[string] (multi) |
| name |
query |
no |
|
- |
string |
Response
Content-Type: application/json
| Status Code |
Reason |
Response Model |
| default |
successful operation |
- |
/master/job/run
POST
Request
Content-Type: application/json
Parameters
Response
Content-Type: application/json
| Status Code |
Reason |
Response Model |
| default |
successful operation |
- |
/master/job/service_name
GET
Request
Parameters
Response
Content-Type: application/json
| Status Code |
Reason |
Response Model |
| default |
successful operation |
- |
/master/job/service_version
GET
Request
Parameters
Response
Content-Type: application/json
| Status Code |
Reason |
Response Model |
| default |
successful operation |
- |
Definitions
| name |
type |
required |
description |
example |
| workers |
array[WorkerInfo]
|
optional |
List of Job Workers that have registered with the Job Master |
|
| startTimeMs |
integer (int64)
|
optional |
Job Master's start time in epoch time |
|
| uptimeMs |
integer (int64)
|
optional |
Number of milliseconds the Job Master has been running |
|
| configuration |
object
|
optional |
Configuration of the Job Master |
|
| version |
string
|
optional |
Version of the Job Master |
|
| name |
type |
required |
description |
example |
| startTimeMs |
integer (int64)
|
optional |
Job Worker's start time in epoch time |
|
| uptimeMs |
integer (int64)
|
optional |
Number of milliseconds the Job Worker has been running |
|
| configuration |
object
|
optional |
Configuration of the Job Worker |
|
| version |
string
|
optional |
Version of the Job Worker |
|
| name |
type |
required |
description |
example |
| errorMessage |
string
|
optional |
- |
|
| errorType |
string
|
optional |
- |
|
| affectedPaths |
array[string]
|
optional |
- |
|
| parentId |
integer (int64)
|
optional |
- |
|
| children |
array[JobInfo]
|
optional |
- |
|
| description |
string
|
optional |
- |
|
| status |
string
|
optional |
- |
|
| lastUpdated |
integer (int64)
|
optional |
- |
|
| name |
string
|
optional |
- |
|
| id |
integer (int64)
|
optional |
- |
|
| result |
Serializable
|
optional |
- |
|
| name |
type |
required |
description |
example |
| tierName |
string
|
optional |
Name of the tier |
host |
| value |
string
|
optional |
Value of the tier name |
localhost |
| name |
type |
required |
description |
example |
| name |
type |
required |
description |
example |
| tiers |
array[LocalityTier]
|
optional |
Tiers included in the tier identity |
|
| name |
type |
required |
description |
example |
| revision |
string
|
optional |
Git revision at the time of building the worker |
|
| lastContactSec |
integer (int32)
|
optional |
Seconds since the worker's last contact |
|
| capacityBytes |
integer (int64)
|
optional |
Size of the worker's local storage in bytes |
|
| usedBytes |
integer (int64)
|
optional |
Number of bytes used of the worker's local storage |
|
| capacityBytesOnTiers |
object
|
optional |
The max capacity of each of the worker's tiers in bytes |
|
| usedBytesOnTiers |
object
|
optional |
The number of bytes currently used on each of the worker's tiers |
|
| blockCount |
integer (int64)
|
optional |
Number of worker block count |
|
| startTimeMs |
integer (int64)
|
optional |
Start time of the worker in epoch time in milliseconds |
|
| state |
string
|
optional |
Operation state of the worker |
In Service |
| version |
string
|
optional |
The project version of the worker |
|
| id |
integer (int64)
|
optional |
Worker id, used to identify the worker internally |
|
| address |
WorkerNetAddress
|
optional |
Address of the worker |
|
| name |
type |
required |
description |
example |
| containerHost |
string
|
optional |
Host name of the physical node if running in a container |
|
| rpcPort |
integer (int32)
|
optional |
Port of the worker's Rpc server for metadata operations |
|
| dataPort |
integer (int32)
|
optional |
Port of the worker's server for data operations |
|
| webPort |
integer (int32)
|
optional |
Port which exposes the worker's web UI |
|
| domainSocketPath |
string
|
optional |
The domain socket path used by the worker, disabled if empty |
|
| tieredIdentity |
TieredIdentity
|
optional |
The worker's tier identity |
|
| host |
string
|
optional |
Host name of the worker |
|