This page last changed on Feb 24, 2009 by bmccoy.

The following methods are available to interact with the Elastic Bamboo functionality. For more information on Elastic Bamboo concepts and usage please refer to Working with Elastic Bamboo. All methods on this page require authentication by a user with administration privileges.


List Running Instances

Provide a list of any running elastic instances.

Arguments:

Parameter Name Description
auth Authentication token retrieved via the login method

URL:

/api/rest/listRunningInstances.action

Successful Response:

<response>
    <instance>
        <id>i-ee54c287</id>
        <state>RUNNING</state>
        <uptime>94430</uptime>
    </instance>
</response>
Element Description Value Range
id The elastic instance ID This ID is provided by Amazon when the instance is started up. It can be null
state The state of the elastic instance STARTING (instance pending) / IDENTIFIED (instance pending with identification details available) / RUNNING / SHUTTING_DOWN / TERMINATED / FAILED_TO_START (error state) / UNKNOWN (error state)
uptime The length of time the instances has been running (according to AWS) Duration in milliseconds

Start Elastic Instances

Start a given number of elastic instances (and the corresponding elastic agents).

Arguments:

Parameter Name Description
auth Authentication token retrieved via the login method
numAgentsToCreate Number of instance you would like to start

URL:

/api/rest/startElasticInstances.action

Example:

/api/rest/startElasticInstances.action?auth=6Tsb5E6G6o&numAgentsToCreate=2

Successful Response:

<response/>

Stop Elastic Instances

Request termination of an Elastic Instance. Any builds running on the instance will be abandoned.

Arguments:

Parameter Name Description
auth Authentication token retrieved via the login method
instanceId The ID for the instance to be stopped

URL:

/rest/api/StopElasticAgents.action

Example:

/rest/api/StopElasticAgents.action?auth=6Tsb5E6G6o&instanceId=i-ee54c287

Successful Response:

<response/>

Stop All Elastic Instances

Terminates all running Elastic Instances. Any builds running on the instance will be abandoned.

Arguments:

Parameter Name Description
auth Authentication token retrieved via the login method

URL:

/api/rest/listRunningInstances.action

Successful Response:

<response/>
Document generated by Confluence on Mar 09, 2009 17:07