com.atlassian.confluence.content.render.xhtml.migration.exceptions.UnknownMacroMigrationException: The macro 'next_previous_link3' is unknown.
Status Monitoring APIs
- Former user (Deleted)
Owned by Former user (Deleted)
Last updated: Aug 20, 2018
Listing all registered workers
Overview
| Description | Lists all the workers registered in the Status Dashboard. |
|---|---|
| API Context | /monitoring/apis/workers |
| HTTP Method | GET |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/monitoring/apis/workers" -H "accept: application/json" -u admin:admin -k
Sample output
Response
Adding a worker
Overview
| Description | Adds a worker node to the Status Dashboard. |
|---|---|
| API Context | /monitoring/apis/workers |
| HTTP Method | POST |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
curl command syntax
Sample curl command
curl -X POST "https://localhost:9643/monitoring/apis/workers" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"host\": \"localhost\", \"port\": \"9443\"}" -u admin:admin -k
Sample output
Response
Deleting a worker
Overview
| Description | Deletes the specified worker from the Status Dashboard. |
|---|---|
| API Context | /monitoring/apis/workers/{workerId} |
| HTTP Method | DELETE |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter Description
| Parameter | Description |
|---|---|
{workerId}
| The ID of the worker node that needs to be removed from the Status Dashboard. |
curl command syntax
Sample curl command
curl -X DELETE "https://localhost:9643/monitoring/apis/workers/localhost_9095" -H "accept: application/json" -u admin:admin -k
Sample output
Response
Fetching the general details of a worker
Overview
| Description | Fetches the general details of the specified worker. |
|---|---|
| API Context |
/monitoring/apis/workers/{workerId}/system-details
|
| HTTP Method | POST |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter Description
| Parameter | Description |
|---|---|
{workerId}
| The ID of the worker node of which the general details need to be fetched. |
curl command syntax
Sample curl command
curl -X POST "https://localhost:9643/monitoring/apis/workers/localhost_9444/system-details" -H "accept: application/json" -u admin:admin -k
Sample output
Response
Testing the connection of a worker
Overview
| Description | Tests the connection of the specified user. |
|---|---|
| API Context | /monitoring/apis/workers/{workerId}/status |
| HTTP Method | POST |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter Description
| Parameter | Description |
|---|---|
{workerId} | The ID of the worker node of which the connection needs to be tested. |
curl command syntax
Sample curl command
curl -X POST "https://localhost:9643/monitoring/apis/workers/localhost_9444/status" -H "accept: application/json" -u admin:admin -k
Sample output
Response
Fetching the history statistics details of a worker
Overview
| Description | Fetches the history statistics details of the specified worker. |
|---|---|
| API Context | /monitoring/apis/workers/{workerId}/history?period=’2 hr’,type=cpu,memory,latency |
| HTTP Method | GET |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter Description
| Parameter | Description |
|---|---|
{workerId} | The ID of the worker node of which the history statistics details need to be fetched. |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/monitoring/apis/workers/localhost_9444/history?period=5min" -H "accept: application/json" -u admin:admin -k
Sample output
Response
Fetching the details of all the Siddhi applications of a specific worker
Overview
| Description | Fetches details relating to all the Siddhi applications of a specific worker. |
|---|---|
| API Context | /monitoring/apis/workers/{workerId}/siddhi-apps |
| HTTP Method | GET |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter Description
| Parameter | Description |
|---|---|
{workerId}
| The ID of the worker node for which the details of the Siddhi applications assigned need to be fetched. |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/monitoring/apis/workers/localhost_9444/siddhi-apps" -H "accept: application/json" -u admin:admin -k
Sample output
Response
Getting the text view and the flow of a Siddhi application
Overview
| Description | Fetches the text view and the flow of a specified Siddhi application. |
|---|---|
| API Context | /monitoring/apis/workers/{workerId}/siddhi-apps/{appName} |
| HTTP Method | GET |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter Description
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/monitoring/apis/workers/localhost_9095/siddhi-apps/TestSiddhiApp" -H "accept: application/json" -u admin:admin -k
Sample output
Response
Enabling/disabling Siddhi application statistics
Overview
| Description | Enables/disables statistics for the Siddhi applications of a specified worker node. |
|---|---|
| API Context | /monitoring/apis/workers/{workerId}/siddhi-apps |
| HTTP Method | PUT |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter Description
| Parameter | Description |
|---|---|
{workerId} | The ID of the worker node with the Siddhi applications for which statistics need to be enabled/disabled. |
curl command syntax
Sample curl command
curl -X PUT "https://localhost:9643/monitoring/apis/workers/localhost_9444/siddhi-apps/TestSiddhiApp/statistics" -H "accept: application/json" -H "Content-Type:application/json" -d "{statsEnable: false}" -u admin:admin -k -v
Sample output
Response
Fetching the history statistics details of a Siddhi application
Overview
| Description | Fetches the history statistics details of a specified Siddhi application. |
|---|---|
| API Context | /monitoring/apis/workers/{workerId}/siddhi-apps/{appName}/statistics |
| HTTP Method | GET |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter Description
| Parameter | Description |
|---|---|
{workerId} | The ID of the worker node with the Siddhi application of which the history statistics details need to be fetched. |
{appName}
| The name of the Siddhi application of which the history statistics details need to be fetched. |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/monitoring/apis/workers/localhost_9444/siddhi-apps/TestSiddhiApp/history?period=5min" -H "accept: application/json" -u admin:admin -k
Sample output
Response
Fetching the component list and the component current metrics
Overview
| Description | Fetches the component list and component current metrics of a specified Siddhi application. |
|---|---|
| API Context | /monitoring/apis/workers/{workerId}/siddhi-apps/{appName}/components |
| HTTP Method | GET |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter Description
| Parameter | Description |
|---|---|
{workerId} | The ID of the worker node with the Siddhi application of which the component list and component current metrics need to be fetched. |
{appName} | The Siddhi application of which the component list and component current metrics need to be fetched. |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/monitoring/apis/workers/localhost_9444/siddhi-apps/TestSiddhiApp/components" -H "accept: application/json" -u admin:admin -k -v
Sample output
Response
Fetching the history statistics details of a Siddhi application component
Overview
| Description | Fetches the history statistics details for a specified component of a specified Siddhi application. |
|---|---|
| API Context |
|
| HTTP Method | GET |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter Description
| Parameter | Description |
|---|---|
{workerId} | The ID of the worker node with the Siddhi application for which the history statistic details of a specific component needs to be fetched. |
{appName} | The Siddhi application with the component of which history statistics details need to be fetched. |
{componentType} | The type of the Siddhi component of which history statistics details need to be fetched. The component type can be queries, streams, tables, windows and aggregations. For more information, see Siddhi Application Overview - Common components of a Siddhi application . |
{componentId} | The ID of the Siddhi component of which history statistics details need to be fetched. |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/monitoring/apis/workers/localhost_9444/siddhi-apps/TestSiddhiApp/components/Streams/FooStream/history?period=5min" -H "accept: application/json" -u admin:admin -k
Sample output
Response
Fetching the user roles of a specific user
Overview
| Description | Fetches the user roles of a specific user. |
|---|---|
| API Context | /monitoring/apis/workers/roles?permissionSuffix=manager |
| HTTP Method | GET |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/monitoring/apis/workers/roles?permissionSuffix=metrics.manager" -H "accept: application/json" -u admin:admin -k
Sample output
Response
Reading dashboard configuration details of the currently running dashboard server
Overview
| Description | Reads the dashboard configuration details of the currently running dashboard server. |
|---|---|
| API Context | /monitoring/apis/workers/config |
| HTTP Method | GET |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/monitoring/apis/workers/config" -H "accept: application/json" -u admin:admin -k
Sample output
Response
Fetching the HA status
Overview
| Description | Returns the status of the given node in the HA cluster in which it is deployed (i.e., whether the node is the active node or the passive node). |
|---|---|
| API Context | /monitoring/apis/workers/{workerId}/ha-status |
| HTTP Method | GET |
| Request/Response format | application/json |
| Authentication | Basic |
| Username | admin |
| Password | admin |
| Runtime | Dashboard |
Parameter Description
| Parameter | Description |
|---|---|
{workerId} | The ID of the worker node of which the HA status needs to be checked. |
curl command syntax
Sample curl command
curl -X GET "https://localhost:9643/monitoring/apis/workers/localhost_9444/ha-status" -H "accept: application/json" -u admin:admin -k -v
Sample output
Response
, multiple selections available,
com.atlassian.confluence.content.render.xhtml.migration.exceptions.UnknownMacroMigrationException: The macro 'next_previous_links2' is unknown.