Page tree
Skip to end of metadata
Go to start of metadata
This parameter has been added in the 3.1 version.

Use the following API call to get status for a particular virtual server:

GET /virtual_machines/:virtual_machine_id/status.xml
GET /virtual_machines/:virtual_machine_id/status.json

XML Request example

curl -i -X GET -H 'Accept: application/xml' -H 'Content-type: application/xml' -u user:password --url http://onapp.test/virtual_machines/:virtual_machine_id/status.xml

JSON Request example

curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u user:password --url http://onapp.test/virtual_machines/:virtual_machine_id/status.json

XML Output example

<virtual_machines type="array">
  <virtual_machine>
    <id type="integer">48</id>
    <identifier>b266b5h5et39iy</identifier>
    <hostname>qaaoxp</hostname>
    <template_id type="integer">111</template_id>
    <built type="boolean">true</built>
    <locked type="boolean">false</locked>
    <booted type="boolean">true</booted>
    <operating_system>windows</operating_system>
    <suspended type="boolean">false</suspended>
    <enable_autoscale type="boolean">false</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

#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))
  • No labels