Management Guide

contents

/mgmt/databases/{id}/servers

/mgmt/databases/{id}/servers — Manage servers assigned to a database

Synopsis

/mgmt/databases/{database-id}/servers/{server-id}/start

/mgmt/databases/{database-id}/servers/{server-id}/stop

Methods

START

Starts the VoltDB database process for the database and on the server specified by the IDs in the URL. You must specify "start" as part of the URL and send the request using the PUT method.

You can only start a server under the following conditions:

  • The server is already assigned to the specified database

  • The database has started and is running

  • The server has stopped, either due to an error condition or a previous STOP action

STOP

Stops the VoltDB database process for the database and on the server specified by the IDs in the URL. You must specify "stop" as part of the URL and send the request using the PUT method.

You can only stop a server under the following conditions:

  • The server is already assigned to the specified database

  • The database has started and is running

  • The VoltDB process for the specified database is running on the server

Arguments

There are no arguments to the START or STOP actions. Also START and STOP are the only actions allowed. To get a list of the servers currently assigned to a database, you must perform a GET on the database object itself. Similarly, to change the assignment of servers to the database, you must perform a PUT on the database object directly.

Examples

The following example stops the VoltDB process for database 83886132 on server 67108911:

curl -X PUT \
http://voltdbmgr:9000/man/api/1.0/mgmt/databases/83886132\
/servers/67108911/stop
contents