Get List of VSs
Da Wiki Neen.
(Differenze fra le revisioni)
| Riga 78: | Riga 78: | ||
Where: | Where: | ||
| − | add_to_marketplace — empty for VSs; used for edge servers only | + | *add_to_marketplace — empty for VSs; used for edge servers only |
| − | + | *admin_note — an optional note of the administrator | |
| − | admin_note — an optional note of the administrator | + | *allow_resize_without_reboot — true if resize without reboot is possible; otherwise false |
| − | + | *allowed_hot_migrate — true if the template, on which the VS is based, supports hot migration; otherwise false | |
| − | allow_resize_without_reboot — true if resize without reboot is possible; otherwise false | + | *allowed_swap — true if swap disk is allowed (depends on the template the VS is based on); otherwise false |
| − | + | *booted — true if the VS is running, otherwise false | |
| − | allowed_hot_migrate — true if the template, on which the VS is based, supports hot migration; otherwise false | + | *built — true if the VS is built, otherwise false |
| − | + | *cpus — the number of allocated CPU cores | |
| − | allowed_swap — true if swap disk is allowed (depends on the template the VS is based on); otherwise false | + | *cpu_shares — CPU priority in percent's |
| − | + | *created_at — the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format | |
| − | booted — true if the VS is running, otherwise false | + | *enable_autoscale — true if autoscaling is allowed for this Vs |
| − | + | *hostname — the name of your host | |
| − | built — true if the VS is built, otherwise false | + | *hypervisor_id — the ID of the hypervisor used by this VS |
| − | + | *id — the VS ID | |
| − | cpus — the number of allocated CPU cores | + | *identifier — the VS identifier |
| − | + | *initial_root_password — the VS root password | |
| − | cpu_shares — CPU priority in percent's | + | *initial_root_password_encrypted - true, if the root password is encrypted, otherwise false. |
| − | + | *ip_addresses — an array of ip addresses with their details assigned to this VS | |
| − | created_at — the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format | + | *label — the VS label |
| − | + | *local_remote_access_port — the port ID used for console access | |
| − | enable_autoscale — true if autoscaling is allowed for this Vs | + | *locked — true if the VS is locked; otherwise false |
| − | + | *max_memory — maximum amount of RAM which can be allocated to the VS by the hypervisor | |
| − | hostname — the name of your host | + | *memory — the RAM size allocated to this VS |
| − | + | *min_disk_size — the minimum disk size required to build a VS from a specified template | |
| − | hypervisor_id — the ID of the hypervisor used by this VS | + | *primary_disk_min_iops - minimum number of IO operations per second for primary disk (this is a SolidFire related parameter) |
| − | + | *swap_disk_min_iops - minimum number of IO operations per second for swap disk (this is a SolidFire related parameter) | |
| − | id — the VS ID | + | *note — an optional reminder for this VS made by a user account |
| − | + | *network_address – the address of the network | |
| − | identifier — the VS identifier | + | *operating_system — operating system used by the VS |
| − | + | *operating_system_distro — the distribution of the OS from which this VS is built | |
| − | initial_root_password — the VS root password | + | *recovery_mode — true if recovery mode allowed. Otherwise false |
| − | + | *remote_access_password — the password for the remote access | |
| − | initial_root_password_encrypted - true, if the root password is encrypted, otherwise false. | + | *state – parameter reserved for future use |
| − | + | *strict_virtual_machine_id — the ID of a virtual server that will never reside on the same hypervisor with this VS | |
| − | ip_addresses — an array of ip addresses with their details assigned to this VS | + | *suspended — true if VS is suspended, otherwise false |
| − | + | *template_id — the ID of the template the VS is based on | |
| − | label — the VS label | + | *template_label — the name of the template from which this VS is built |
| − | + | *total_disk_size — the total disk size in GB of all disks assigned to VS | |
| − | local_remote_access_port — the port ID used for console access | + | *updated_at — the date when the VS was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format |
| − | + | *user_id — the ID of a user assigned to this VS | |
| − | locked — true if the VS is locked; otherwise false | + | *vip — true if the VS has VIP status (gives migration priority) |
| − | + | *xen_id — the VS ID set by the virtualization engine | |
| − | max_memory — maximum amount of RAM which can be allocated to the VS by the hypervisor | + | |
| − | + | ||
| − | memory — the RAM size allocated to this VS | + | |
| − | + | ||
| − | min_disk_size — the minimum disk size required to build a VS from a specified template | + | |
| − | + | ||
| − | primary_disk_min_iops - minimum number of IO operations per second for primary disk (this is a SolidFire related parameter) | + | |
| − | + | ||
| − | swap_disk_min_iops - minimum number of IO operations per second for swap disk (this is a SolidFire related parameter) | + | |
| − | + | ||
| − | note — an optional reminder for this VS made by a user account | + | |
| − | + | ||
| − | network_address – the address of the network | + | |
| − | + | ||
| − | operating_system — operating system used by the VS | + | |
| − | + | ||
| − | operating_system_distro — the distribution of the OS from which this VS is built | + | |
| − | + | ||
| − | recovery_mode — true if recovery mode allowed. Otherwise false | + | |
| − | + | ||
| − | remote_access_password — the password for the remote access | + | |
| − | + | ||
| − | state – parameter reserved for future use | + | |
| − | + | ||
| − | strict_virtual_machine_id — the ID of a virtual server that will never reside on the same hypervisor with this VS | + | |
| − | + | ||
| − | suspended — true if VS is suspended, otherwise false | + | |
| − | + | ||
| − | template_id — the ID of the template the VS is based on | + | |
| − | + | ||
| − | template_label — the name of the template from which this VS is built | + | |
| − | + | ||
| − | total_disk_size — the total disk size in GB of all disks assigned to VS | + | |
| − | + | ||
| − | updated_at — the date when the VS was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format | + | |
| − | + | ||
| − | user_id — the ID of a user assigned to this VS | + | |
| − | + | ||
| − | vip — true if the VS has VIP status (gives migration priority) | + | |
| − | + | ||
| − | xen_id — the VS ID set by the virtualization engine | + | |
<br><br> | <br><br> | ||
Versione delle 17:25, 20 feb 2014
To get the list of VS, use the following request:
GET /virtual_machines.xml
GET /virtual_machines.json
XML Output example
<?xml version="1.0" encoding="UTF-8"?> <virtual_machines> <virtual_machine> <add_to_marketplace nil="true"></add_to_marketplace> <admin_note nil="true"></admin_note> <allow_resize_without_reboot type="boolean">true</allow_resize_without_reboot> <allowed_hot_migrate type="boolean">true</allowed_hot_migrate> <allowed_swap type="boolean">true</allowed_swap> <booted type="boolean">true</booted> <built type="boolean">true</built> <cpu_shares type="integer">1</cpu_shares> <cpus type="integer">1</cpus> <created_at type="datetime">2011-11-01T17:11:58+03:00</created_at> <enable_autoscale type="boolean">true</enable_autoscale> <enable_monitis type="boolean">true</enable_monitis> <hostname>autobackup</hostname> <hypervisor_id type="integer">2</hypervisor_id> <id type="integer">373</id> <identifier>iskngs9dve0hdg</identifier> <initial_root_password>791791</initial_root_password> <initial_root_password_encrypted type="boolean">false</initial_root_password_encrypted> <label>YR_autobackup</label> <local_remote_access_port type="integer">5903</local_remote_access_port> <locked type="boolean">false</locked> <max_memory type="integer">2048</max_memory> <memory type="integer">128</memory> <min_disk_size type="integer">5</min_disk_size> <primary_disk_min_iops>600</primary_disk_min_iops> <swap_disk_min_iops>600</swap_disk_min_iops> <note nil="true"></note> <operating_system>linux</operating_system> <operating_system_distro>rhel</operating_system_distro> <recovery_mode type="boolean">false</recovery_mode> <remote_access_password>os3ajolb1buj</remote_access_password> <state>new</state> <strict_virtual_machine_id nil="true"></strict_virtual_machine_id> <suspended type="boolean">false</suspended> <template_id type="integer">8</template_id> <template_label>CentOS 5.6 x86</template_label> <update_billing_stat type="boolean">false</update_billing_stat> <updated_at type="datetime">2011-11-04T13:22:25+03:00</updated_at> <user_id type="integer">5</user_id> <vip nil="true"></vip> <xen_id type="integer">12</xen_id> <ip_addresses type="array"> <ip_address> <created_at type="datetime">2011-10-10T12:31:12+03:00</created_at> <disallowed_primary type="boolean">false</disallowed_primary> <id type="integer">2</id> <network_id type="integer">1</network_id> <updated_at type="datetime">2011-11-01T17:39:13+03:00</updated_at> <user_id nil="true"></user_id> <free type="boolean">false</free> <address>109.123.105.180</address> <gateway>109.123.105.177</gateway> <network_address>109.123.105.176</network_address> <broadcast>109.123.105.191</broadcast> <netmask>255.255.255.240</netmask> </ip_address> </ip_addresses> <total_disk_size type="integer">6</total_disk_size> </virtual_machine> ... <virtual_machine></virtual_machine> ... </virtual_machine>
Where:
- add_to_marketplace — empty for VSs; used for edge servers only
- admin_note — an optional note of the administrator
- allow_resize_without_reboot — true if resize without reboot is possible; otherwise false
- allowed_hot_migrate — true if the template, on which the VS is based, supports hot migration; otherwise false
- allowed_swap — true if swap disk is allowed (depends on the template the VS is based on); otherwise false
- booted — true if the VS is running, otherwise false
- built — true if the VS is built, otherwise false
- cpus — the number of allocated CPU cores
- cpu_shares — CPU priority in percent's
- created_at — the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
- enable_autoscale — true if autoscaling is allowed for this Vs
- hostname — the name of your host
- hypervisor_id — the ID of the hypervisor used by this VS
- id — the VS ID
- identifier — the VS identifier
- initial_root_password — the VS root password
- initial_root_password_encrypted - true, if the root password is encrypted, otherwise false.
- ip_addresses — an array of ip addresses with their details assigned to this VS
- label — the VS label
- local_remote_access_port — the port ID used for console access
- locked — true if the VS is locked; otherwise false
- max_memory — maximum amount of RAM which can be allocated to the VS by the hypervisor
- memory — the RAM size allocated to this VS
- min_disk_size — the minimum disk size required to build a VS from a specified template
- primary_disk_min_iops - minimum number of IO operations per second for primary disk (this is a SolidFire related parameter)
- swap_disk_min_iops - minimum number of IO operations per second for swap disk (this is a SolidFire related parameter)
- note — an optional reminder for this VS made by a user account
- network_address – the address of the network
- operating_system — operating system used by the VS
- operating_system_distro — the distribution of the OS from which this VS is built
- recovery_mode — true if recovery mode allowed. Otherwise false
- remote_access_password — the password for the remote access
- state – parameter reserved for future use
- strict_virtual_machine_id — the ID of a virtual server that will never reside on the same hypervisor with this VS
- suspended — true if VS is suspended, otherwise false
- template_id — the ID of the template the VS is based on
- template_label — the name of the template from which this VS is built
- total_disk_size — the total disk size in GB of all disks assigned to VS
- updated_at — the date when the VS was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format
- user_id — the ID of a user assigned to this VS
- vip — true if the VS has VIP status (gives migration priority)
- xen_id — the VS ID set by the virtualization engine
