Skip to content
This repository has been archived by the owner on Apr 23, 2020. It is now read-only.

REST Cluster

Randgalt edited this page Oct 5, 2012 · 14 revisions

APIs concerning the ZooKeeper ensemble instances. See REST Entities for descriptions of any arguments/results.

status

Returns the status of the entire cluster. NOTE: this will cause Exhibitor to make a REST call to each of the servers.

Method GET
URL exhibitor/v1/cluster/status
Argument n/a
Response ServerStatus[]

remoteGetStatus

Returns the system state of the given instance in the ensemble.

Method GET
URL exhibitor/v1/cluster/state/{hostname}
Argument n/a
Response ClusterState

remoteSetControlPanelSetting

Turn on/off a control panel switch of the given instance in the ensemble.

Method GET
URL exhibitor/v1/cluster/set/{type}/{value}/{hostname}
Argument n/a
Response Result
type
“restarts” Instance restarts
“unlistedRestarts” Unlisted instance restarts
“cleanup” The log file cleanup task
“backups” The log file backup task

value is a JSON boolean

remoteStopStartZooKeeper

Restart the given instance in the ensemble.

Method GET
URL exhibitor/v1/cluster/restart/{hostname}
Argument n/a
Response Result

remoteStopZooKeeper

Stop the given instance in the ensemble.

Method GET
URL exhibitor/v1/cluster/stop/{hostname}
Argument n/a
Response Result

remoteStartZooKeeper

Start the given instance in the ensemble.

Method GET
URL exhibitor/v1/cluster/start/{hostname}
Argument n/a
Response Result

remoteGetFourLetterWord

Return the result of the ZooKeeper four letter word on the given instance in the ensemble.

Method GET
URL exhibitor/v1/cluster/4ltr/{word}/{hostname}
Argument n/a
Response JSON string

remoteGetLog

Return the Exhibitor log from the given instance in the ensemble.

Method GET
URL exhibitor/v1/cluster/log/{hostname}
Argument n/a
Response JSON string

getStatus

Returns the system state of the local instance.

Method GET
URL exhibitor/v1/cluster/state
Argument n/a
Response ClusterState

setControlPanelSetting

Turn on/off a control panel switch of the local instance.

Method GET
URL exhibitor/v1/cluster/set/{type}/{value}
Argument n/a
Response Result

See remoteSetControlPanelSetting for type/value description.

stopStartZooKeeper

Restart the local instance.

Method GET
URL exhibitor/v1/cluster/restart
Argument n/a
Response Result

stopZooKeeper

Stop the local instance.

Method GET
URL exhibitor/v1/cluster/stop
Argument n/a
Response Result

startZooKeeper

Start the local instance.

Method GET
URL exhibitor/v1/cluster/start
Argument n/a
Response Result

getFourLetterWord

Return the result of the ZooKeeper four letter word on the local instance.

Method GET
URL exhibitor/v1/cluster/4ltr/{word}
Argument n/a
Response JSON string

getLog

Return the Exhibitor log from the local instance.

Method GET
URL exhibitor/v1/cluster/log
Argument n/a
Response JSON string

getCluster

Return the server list from the Shared Configuration

Method GET
URL exhibitor/v1/cluster/list
Argument n/a
Response Servers

shutdown

Shutdown the Exhibitor instance

Method GET
URL exhibitor/v1/ui/shutdown
Argument n/a
Response n/a
Clone this wiki locally