Get List of Accelerators

To view all accelerators in the cloud with their details, use the following request:

GET /accelerators.xml
GET /accelerators.json

XML Request Example

curl -i -X GET -u user:userpass http://onapp.test/accelerators.xml

JSON Request Example

curl -i -X GET -u user:userpass http://onapp.test/accelerators.json

XML Output Example

<accelerators type="array">
<admin_note nil="true"/>
<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>
<cores_per_socket type="integer">0</cores_per_socket>
<cpu_shares type="integer">1</cpu_shares>
<cpu_sockets nil="true"/>
<cpu_threads nil="true"/>
<cpu_units type="integer">10</cpu_units>
<cpus type="integer">1</cpus>
<created_at type="datetime">2015-09-16T14:41:39+03:00</created_at>
<customer_network_id nil="true"/>
<deleted_at nil="true"/>
<enable_autoscale nil="true"/>
<enable_monitis type="boolean">false</enable_monitis>
<firewall_notrack type="boolean">true</firewall_notrack>
<hot_add_cpu nil="true"/>
<hot_add_memory nil="true"/>
<hypervisor_id type="integer">1</hypervisor_id>
<id type="integer">323</id>
<initial_root_password_encrypted type="boolean">false</initial_root_password_encrypted>
<instance_package_id nil="true"/>
<iso_id nil="true"/>
<local_remote_access_port type="integer">5900</local_remote_access_port>
<locked type="boolean">false</locked>
<memory type="integer">2048</memory>
<min_disk_size type="integer">20</min_disk_size>
<note nil="true"/>
<preferred_hvs type="array"/>
<recovery_mode type="boolean">false</recovery_mode>
<service_password nil="true"/>
<strict_virtual_machine_id nil="true"/>
<suspended type="boolean">false</suspended>
<template_id type="integer">23</template_id>
<template_label>OnApp CDN Appliance</template_label>
<updated_at type="datetime">2015-09-23T17:58:03+03:00</updated_at>
<user_id type="integer">79</user_id>
<vip nil="true"/>
<xen_id type="integer">92</xen_id>
<ip_addresses type="array">
<created_at type="datetime">2013-11-14T15:48:37+03:00</created_at>
<customer_network_id nil="true"/>
<disallowed_primary type="boolean">false</disallowed_primary>
<hypervisor_id nil="true"/>
<id type="integer">3</id>
<ip_address_pool_id nil="true"/>
<network_id type="integer">1</network_id>
<pxe type="boolean">false</pxe>
<updated_at type="datetime">2015-09-14T12:16:16+03:00</updated_at>
<user_id nil="true"/>
<free type="boolean">false</free>
<monthly_bandwidth_used type="integer">1095630</monthly_bandwidth_used>
<total_disk_size type="integer">20</total_disk_size>
<price_per_hour type="float">0.0</price_per_hour>
<price_per_hour_powered_off type="float">0.0</price_per_hour_powered_off>
<support_incremental_backups type="boolean">false</support_incremental_backups>
<cpu_priority type="integer">1</cpu_priority>
<cdn_reference type="integer">410772127</cdn_reference>

Explanation of the data returned:

admin_note – an optional reminder for this accelerator created by an administrator

allowed_hot_migrate – true if hot migration is allowed; otherwise false

allowed_swap – true if swap is allowed; otherwise false

booted – true if the accelerator is booted; otherwise false

built - true if the accelerator is built; otherwise false

cores_per_socket - the number of cores per socket for accelerator

cpu_shares – the CPU priority percentage

cpu_sockets - the amount of CPU sockets per core. This parameter can be set for KVM compute resources only by those users who have Enable CPU topology permission granted

cpu_threads - the amount of CPU threads per core. This parameter can be set for KVM compute resources only by those users who have Enable CPU topology permission granted

cpu_units - the amount of CPU units per core if the CPU priority is replaced with CPU units in user bucket

cpus – number of CPU cores allocated to this accelerator

created_at – the date when the accelerator was created in the [YYYY][MM][DD]T[hh][mm][ss]Z format

customer_network_id - ID of a customer network

deleted_at - time when the accelerator was deleted

enable_autoscale – false; not available for accelerators

enable_monitis - deprecated attribute; will be removed in upcoming release

firewall_notrack - true if the NOTRACK rule is set in iptables

hot_add_cpu - false; not available for accelerators

hot_add_memory - false; not available for accelerators

hypervisor_id – the ID of the compute resource, on which the accelerator is deployed

id – the accelerator ID in OnApp CP database

identifier – the accelerator identifier

initial_root_password – the accelerator root password

initial_root_password_encrypted – true, if the accelerator root password is encrypted, otherwise false

instance package_id - false; not available for accelerators

iso_id  - false; not available for accelerators 

label – an arbitrary name of the accelerator

local_remote_access_ip_address - the IP address used for console access

local_remote_access_port – the port ID used for console access

locked – true if locked; otherwise false

memory – the amount of RAM resources allocated to this accelerator

min_disk_size – minimum disk space required by the template

note - an optional reminder for this accelerator made by a user account

operating_system – type of operating system

operating_system_distro – the distribution of the operating system

preferred_hvs - the array of preferable compute resources based on compute zone that meet some accelerator configuration settings

recovery_mode – true if the accelerator is booted in the recovery mode; otherwise false

remote_access_password – the password for remote access

service_password - service account password

state – deprecated attribute; will be removed in upcoming release

strict_virtual_machine_id - the ID of a virtual server (or edge server) that will never reside on the same compute resource with this accelerator

suspended – true if suspended; otherwise false

template_id – the ID of the template, on which the accelerator is based

template_label – label of the template on which the accelerator is based

time zone - the time zone set for the accelerator

updated_at – the date when the accelerator was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format

user_id – the ID of the user, who is the accelerator owner

vip – true if the accelerator has VIP status for migration; otherwise false

xen_id – the accelerator ID set by the virtualization engine

ip_addresses – an array of assigned IP addresses with their details assigned to this accelerator:

  • address – IP address
  • broadcast – a logical address at which all devices connected to a multiple-access communications network are enabled to receive datagrams.
  • created_at – time when the IP address was created in the [YYYY][MM][DD]T[hh][mm][ss]Z format
  • customer_network_id - customer network ID
  • disallowed_primary – true if not allowed to be used as primary (for baremetal server), otherwise false
  • gateway - gateway address
  • hypervisor_id - the ID of a compute resource the IP address is associated with
  • id –the ID of the IP address
  • ip_address_pool_id - ID of the IP address pool the IP address is associated with
  • network_address - IP address of the network
  • network_id - the ID of the network
  • pxe - true, if this compute resource address can be used for cloudbooting a compute resource
  • updated at - time when the IP address was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format
  • user_id - the ID of the user this IP address is assigned to
  • free – true if free, otherwise false
  • netmask — netmask for the IP address

monthly_bandwidth_used - accelerator monthly bandwidth in KB

total_disk_size – total disk space in GB of primary and swap disks

price_per_hour - accelerator's price per hour

price_per_hour_powered_off - price per hour when accelerator is powered off

support_incremental_backups - 1, if accelerator supports incremental backups, and 0 if it does not

cpu_priority  - this is a new parameter reserved for further use; currently will have the same value as cpu_shares

edge_status - the CDN server status

cdn_reference - the identifier in database