Get Statuses for all Virtual Servers
To get statuses for all virtual servers, use the following request:
GET /virtual_machines/status.xml
GET /virtual_machines/status.json
XML Request example
curl -i -X GET -H 'Accept: application/xml' -H 'Content-type: application/xml' -u user:userpass --url http://onapp.test/virtual_machines/status.xml
JSON Request example
curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u user:userpass --url http://onapp.test/virtual_machines/status.json
XML Output example
<virtual_machines type="array"> <virtual_machine> <id type="integer">1</id> <identifier>oku1sief887rqm</identifier> <hostname>vl.test</hostname> <template_id type="integer">1</template_id> <built type="boolean">true</built> <locked type="boolean">false</locked> <booted type="boolean">true</booted> <operating_system>linux</operating_system> <suspended type="boolean">false</suspended> <enable_autoscale type="boolean">true</enable_autoscale> <state>new</state> </virtual_machine> ... </virtual_machines>
Where:
id - virtual server ID
identifier — the VS identifier
hostname — the name of your host
template_id — the ID of the template the VS is based on
built — true if the VS is built, otherwise false
locked — true if the VS is locked; otherwise false
booted — true if the VS is running, otherwise false
operating_system — operating system used by the VS
suspended — true if VS is suspended, otherwise false
enable_autoscale — true if autoscaling is allowed for this VS
state – virtual server state