# 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 <a id="getInfo">Get general Alluxio Master service information</a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>raw_configuration</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>boolean </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/AlluxioMasterInfo">AlluxioMasterInfo</a>| ## /master/logLevel ### POST <a id="logLevel"></a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>logName</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>level</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | ## /master/webui_browse ### GET <a id="getWebUIBrowse"></a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>path</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>offset</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>end</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>limit</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | ## /master/webui_config ### GET <a id="getWebUIConfiguration"></a> #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | ## /master/webui_data ### GET <a id="getWebUIData"></a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>offset</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>limit</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | ## /master/webui_init ### GET <a id="getWebUIInit"></a> #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | ## /master/webui_logs ### GET <a id="getWebUILogs"></a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>path</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>offset</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>end</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> <tr> <th>limit</th> <td>query</td> <td>no</td> <td></td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | ## /master/webui_masters ### GET <a id="getWebUIMasters"></a> #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | ## /master/webui_metrics ### GET <a id="getWebUIMetrics"></a> #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | ## /master/webui_mounttable ### GET <a id="getWebUIMountTable"></a> #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | ## /master/webui_overview ### GET <a id="getWebUIOverview"></a> #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | ## /master/webui_workers ### GET <a id="getWebUIWorkers"></a> #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | # Definitions ## <a name="/definitions/AlluxioMasterInfo">AlluxioMasterInfo</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>revision</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>startTimeMs</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>uptimeMs</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>metrics</td> <td> object </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>lostWorkers</td> <td> array[<a href="#/definitions/WorkerInfo">WorkerInfo</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>mountPoints</td> <td> object </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>rpcAddress</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>tierCapacity</td> <td> object </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>ufsCapacity</td> <td> <a href="#/definitions/Capacity">Capacity</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>workers</td> <td> array[<a href="#/definitions/WorkerInfo">WorkerInfo</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>capacity</td> <td> <a href="#/definitions/Capacity">Capacity</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>configuration</td> <td> object </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>version</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Capacity">Capacity</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>total</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>used</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/LocalityTier">LocalityTier</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>tierName</td> <td> string </td> <td>optional</td> <td>Name of the tier</td> <td>host</td> </tr> <tr> <td>value</td> <td> string </td> <td>optional</td> <td>Value of the tier name</td> <td>localhost</td> </tr> </table> ## <a name="/definitions/MountPointInfo">MountPointInfo</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>mountId</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>shared</td> <td> boolean </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>readOnly</td> <td> boolean </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>ufsUri</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>ufsCapacityBytes</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>ufsUsedBytes</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>ufsType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>properties</td> <td> object </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TieredIdentity">TieredIdentity</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>tiers</td> <td> array[<a href="#/definitions/LocalityTier">LocalityTier</a>] </td> <td>optional</td> <td>Tiers included in the tier identity</td> <td></td> </tr> </table> ## <a name="/definitions/WorkerInfo">WorkerInfo</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>revision</td> <td> string </td> <td>optional</td> <td>Git revision at the time of building the worker</td> <td></td> </tr> <tr> <td>startTimeMs</td> <td> integer (int64) </td> <td>optional</td> <td>Start time of the worker in epoch time in milliseconds</td> <td></td> </tr> <tr> <td>lastContactSec</td> <td> integer (int32) </td> <td>optional</td> <td>Seconds since the worker's last contact</td> <td></td> </tr> <tr> <td>capacityBytesOnTiers</td> <td> object </td> <td>optional</td> <td>The max capacity of each of the worker's tiers in bytes</td> <td></td> </tr> <tr> <td>capacityBytes</td> <td> integer (int64) </td> <td>optional</td> <td>Size of the worker's local storage in bytes</td> <td></td> </tr> <tr> <td>usedBytes</td> <td> integer (int64) </td> <td>optional</td> <td>Number of bytes used of the worker's local storage</td> <td></td> </tr> <tr> <td>usedBytesOnTiers</td> <td> object </td> <td>optional</td> <td>The number of bytes currently used on each of the worker's tiers</td> <td></td> </tr> <tr> <td>blockCount</td> <td> integer (int64) </td> <td>optional</td> <td>Number of worker block count</td> <td></td> </tr> <tr> <td>state</td> <td> string </td> <td>optional</td> <td>Operation state of the worker</td> <td>In Service</td> </tr> <tr> <td>address</td> <td> <a href="#/definitions/WorkerNetAddress">WorkerNetAddress</a> </td> <td>optional</td> <td>Address of the worker</td> <td></td> </tr> <tr> <td>id</td> <td> integer (int64) </td> <td>optional</td> <td>Worker id, used to identify the worker internally</td> <td></td> </tr> <tr> <td>version</td> <td> string </td> <td>optional</td> <td>The project version of the worker</td> <td></td> </tr> </table> ## <a name="/definitions/WorkerNetAddress">WorkerNetAddress</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>containerHost</td> <td> string </td> <td>optional</td> <td>Host name of the physical node if running in a container</td> <td></td> </tr> <tr> <td>rpcPort</td> <td> integer (int32) </td> <td>optional</td> <td>Port of the worker's Rpc server for metadata operations</td> <td></td> </tr> <tr> <td>dataPort</td> <td> integer (int32) </td> <td>optional</td> <td>Port of the worker's server for data operations</td> <td></td> </tr> <tr> <td>webPort</td> <td> integer (int32) </td> <td>optional</td> <td>Port which exposes the worker's web UI</td> <td></td> </tr> <tr> <td>domainSocketPath</td> <td> string </td> <td>optional</td> <td>The domain socket path used by the worker, disabled if empty</td> <td></td> </tr> <tr> <td>tieredIdentity</td> <td> <a href="#/definitions/TieredIdentity">TieredIdentity</a> </td> <td>optional</td> <td>The worker's tier identity</td> <td></td> </tr> <tr> <td>host</td> <td> string </td> <td>optional</td> <td>Host name of the worker</td> <td></td> </tr> </table>