# Alluxio Worker REST API Documentation HTTP://[Alluxio Worker Hostname]/api/v1 The Alluxio Workers are processes which provide clients access to the data exposed by the Alluxio System. # APIs ## /worker/info ### GET <a id="getInfo">Get general Alluxio Worker 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/AlluxioWorkerInfo">AlluxioWorkerInfo</a>| ## /worker/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 | - | ## /worker/webui_blockinfo ### GET <a id="getWebUIBlockInfo"></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>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 | - | ## /worker/webui_config ### GET <a id="getWebUIConfiguration"></a> #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | ## /worker/webui_init ### GET <a id="getWebUIInit"></a> #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | ## /worker/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 | - | ## /worker/webui_metrics ### GET <a id="getWebUIMetrics"></a> #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | ## /worker/webui_overview ### GET <a id="getWebUIOverview"></a> #### Request ##### Parameters #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | default | successful operation | - | # Definitions ## <a name="/definitions/AlluxioWorkerInfo">AlluxioWorkerInfo</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>tierPaths</td> <td> object </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>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>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>