PHP Class Scalr\Api\Service\User\V1beta0\Controller\Servers

Author: Vlad Dobrovolskiy ([email protected])
Inheritance: extends Scalr\Api\Rest\Controller\ApiController
Show file Open project: scalr/scalr

Public Methods

Method Description
describeAction ( ) Retrieves the list of the roles that are available on the Environment scope
fetchAction ( string $serverId ) : Scalr\Api\DataType\ResultEnvelope Fetches detailed info about one server
getServer ( string $serverId ) : Server Gets specified Server
rebootAction ( string $serverId ) : Scalr\Api\DataType\ResultEnvelope Reboots instance
resumeAction ( string $serverId ) : Scalr\Api\DataType\ResultEnvelope Resumes instance
suspendAction ( string $serverId ) : Scalr\Api\DataType\ResultEnvelope Stops instance
terminateAction ( string $serverId ) : Scalr\Api\DataType\ResultEnvelope Terminates instance

Private Methods

Method Description
getDefaultCriteria ( ) : array Gets Default search criteria for the Environment scope

Method Details

describeAction() public method

Retrieves the list of the roles that are available on the Environment scope
public describeAction ( )

fetchAction() public method

Fetches detailed info about one server
public fetchAction ( string $serverId ) : Scalr\Api\DataType\ResultEnvelope
$serverId string UUID of the server
return Scalr\Api\DataType\ResultEnvelope

getServer() public method

Gets specified Server
public getServer ( string $serverId ) : Server
$serverId string UUID of the server
return Scalr\Model\Entity\Server Returns the Server Entity on success

rebootAction() public method

Reboots instance
public rebootAction ( string $serverId ) : Scalr\Api\DataType\ResultEnvelope
$serverId string UUID of the server
return Scalr\Api\DataType\ResultEnvelope

resumeAction() public method

Resumes instance
public resumeAction ( string $serverId ) : Scalr\Api\DataType\ResultEnvelope
$serverId string UUID of the server
return Scalr\Api\DataType\ResultEnvelope

suspendAction() public method

Stops instance
public suspendAction ( string $serverId ) : Scalr\Api\DataType\ResultEnvelope
$serverId string UUID of the server
return Scalr\Api\DataType\ResultEnvelope

terminateAction() public method

Terminates instance
public terminateAction ( string $serverId ) : Scalr\Api\DataType\ResultEnvelope
$serverId string UUID of the server
return Scalr\Api\DataType\ResultEnvelope