Alluxio Master REST API Documentation
HTTP://[Alluxio Master Hostname]/api/v1
The Alluxio Master is the central metadata service of the Alluxio System.
APIs
/master/info
GET
Get general Alluxio Master service information
Request
Parameters
Name |
Located in |
Required |
Description |
Default |
Schema |
raw_configuration |
query |
no |
|
- |
boolean |
Response
Content-Type: application/json
/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 |
- |
/master/webui_browse
GET
Request
Parameters
Name |
Located in |
Required |
Description |
Default |
Schema |
path |
query |
no |
|
- |
string |
offset |
query |
no |
|
- |
string |
end |
query |
no |
|
- |
string |
limit |
query |
no |
|
- |
string |
Response
Content-Type: application/json
Status Code |
Reason |
Response Model |
default |
successful operation |
- |
/master/webui_config
GET
Request
Parameters
Response
Content-Type: application/json
Status Code |
Reason |
Response Model |
default |
successful operation |
- |
/master/webui_data
GET
Request
Parameters
Name |
Located in |
Required |
Description |
Default |
Schema |
offset |
query |
no |
|
- |
string |
limit |
query |
no |
|
- |
string |
Response
Content-Type: application/json
Status Code |
Reason |
Response Model |
default |
successful operation |
- |
/master/webui_init
GET
Request
Parameters
Response
Content-Type: application/json
Status Code |
Reason |
Response Model |
default |
successful operation |
- |
/master/webui_logs
GET
Request
Parameters
Name |
Located in |
Required |
Description |
Default |
Schema |
path |
query |
no |
|
- |
string |
offset |
query |
no |
|
- |
string |
end |
query |
no |
|
- |
string |
limit |
query |
no |
|
- |
string |
Response
Content-Type: application/json
Status Code |
Reason |
Response Model |
default |
successful operation |
- |
/master/webui_masters
GET
Request
Parameters
Response
Content-Type: application/json
Status Code |
Reason |
Response Model |
default |
successful operation |
- |
/master/webui_metrics
GET
Request
Parameters
Response
Content-Type: application/json
Status Code |
Reason |
Response Model |
default |
successful operation |
- |
/master/webui_mounttable
GET
Request
Parameters
Response
Content-Type: application/json
Status Code |
Reason |
Response Model |
default |
successful operation |
- |
/master/webui_overview
GET
Request
Parameters
Response
Content-Type: application/json
Status Code |
Reason |
Response Model |
default |
successful operation |
- |
/master/webui_workers
GET
Request
Parameters
Response
Content-Type: application/json
Status Code |
Reason |
Response Model |
default |
successful operation |
- |
Definitions
name |
type |
required |
description |
example |
revision |
string
|
optional |
- |
|
metrics |
object
|
optional |
- |
|
workers |
array[WorkerInfo]
|
optional |
- |
|
capacity |
Capacity
|
optional |
- |
|
lostWorkers |
array[WorkerInfo]
|
optional |
- |
|
mountPoints |
object
|
optional |
- |
|
tierCapacity |
object
|
optional |
- |
|
ufsCapacity |
Capacity
|
optional |
- |
|
rpcAddress |
string
|
optional |
- |
|
startTimeMs |
integer (int64)
|
optional |
- |
|
uptimeMs |
integer (int64)
|
optional |
- |
|
configuration |
object
|
optional |
- |
|
version |
string
|
optional |
- |
|
name |
type |
required |
description |
example |
total |
integer (int64)
|
optional |
- |
|
used |
integer (int64)
|
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 |
ufsUsedBytes |
integer (int64)
|
optional |
- |
|
ufsType |
string
|
optional |
- |
|
ufsCapacityBytes |
integer (int64)
|
optional |
- |
|
shared |
boolean
|
optional |
- |
|
ufsUri |
string
|
optional |
- |
|
mountId |
integer (int64)
|
optional |
- |
|
readOnly |
boolean
|
optional |
- |
|
properties |
object
|
optional |
- |
|
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 |
|