API
Start typing to search…

Start or stop a results database

post https://{hostname}/concerto/services/rest/CloudService/v1/rsdb//action

Either start, stop or terminate a results database. The start and terminate actions are asynchronous and return a 202. A stop command is synchronous and returns a 200. See Asynchronous operations for details. In order to interact with a result database you need the results database ID. See Get an object for more information.

Path Params
integer
required

Uniquely identifies each results database.

Body Params
string
required

Either start, stop, or terminate a results database object. Specify start to deploy a new results database server. You can stop to end the deployment process but leaves the server running. Or you can terminate to tear the server down.

Headers
string
required

All calls to this API require that you pass in the token you get from the Generate a token operation as an X-Auth-Token request header. See Get started for help to initially call the API.

Responses

stop command.

Response body
object
cloudServer
object

Information about a cloud server.

string
required

The cloud provider, either EC2, EC2_CHINA, AZURE, COMPUTE_ENGINE, or RACKSPACE_OPENSTACK.

EC2 EC2_CHINA AZURE COMPUTE_ENGINE RACKSPACE_OPENSTACK

integer
required
≥ 1

Uniquely identifies each server.

string

The type of server instance which describes the memory, CPU, and other server class characteristics. See the cloud provider for detailed information.

string

The CPA used to launch this server.

string

The internal hostname of the server.

string

The external hostname of the server.

string

The cloud provider region.

string

The current state of the server, either PENDING, BUSY, RUNNING, SHUTTING_DOWN, TERMINATED, FAILED, or BIDDING.

PENDING BUSY RUNNING SHUTTING_DOWN TERMINATED FAILED BIDDING

string

The unique identifier used by the cloud provider to describe each instance.

string

The cloud provider zone within the region.

string

The state of the results database. VOLUME_NOT_AVAILABLE means the volume does not exist or is in use by some other instance. VOLUME_NOT_FORMATTED shows that the user should execute a format action on the results database. VOLUME_FORMAT_FAILED shows that something went wrong with the volume formatting. TERMINATING shows that the instance is ending while TERMINATED states that the instance is torn down. The other states show the progress as a database instance starts. It will go from ALLOCATING_DATABASE to ALLOCATED_DATABASE to STARTING_MONITORS to CHECKING and finally to RUNNING.

VOLUME_NOT_AVAILABLE VOLUME_NOT_FORMATTED VOLUME_FORMAT_FAILED TERMINATING TERMINATED ALLOCATING_DATABASE ALLOCATED_DATABASE STARTING_MONITORS CHECKING RUNNING

start or terminate action has been accepted, and is processing. This is an asynchronous process, see Asynchronous operations.

400

Bad request. The URL or JSON request object is invalid.

401

Unauthorized. The security token is missing or invalid. See Get started for help initially running the API.

404

Not found. The requested object doesn't exist.

405

Method Not Allowed. Invalid method used to access resource.

Updated about 1 year ago

Did this page help you?
Language
Authentication
Remember to get your authorization token to run this code.
URL

Updated about 1 year ago

Did this page help you?