Get List of CDN Storage Servers

To get the list of all CDN storage servers in the cloud, use the following request:

GET /storage_servers.xml
GET /storage_servers.json

XML Request Example

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

JSON Request Example

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

XML Output Example

<storage_servers type="array">
<add_to_marketplace type="boolean">false</add_to_marketplace>
<admin_note nil="true"/>
<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">2012-08-07T05:41:02-10:00</created_at>
<customer_network_id nil="true"/>
<edge_server_type nil="true"/>
<enable_autoscale nil="true"/>
<enable_monitis type="boolean">false</enable_monitis>
<firewall_notrack type="boolean">false</firewall_notrack>
<hypervisor_id type="integer">12</hypervisor_id>
<id type="integer">4891</id>
<initial_root_password_encrypted type="boolean">false</initial_root_password_encrypted>
<local_remote_access_port type="integer">5903</local_remote_access_port>
<locked type="boolean">false</locked>
<memory type="integer">512</memory>
<min_disk_size type="integer">5</min_disk_size>
<note nil="true"/>
<recovery_mode type="boolean">false</recovery_mode>
<remote_access_password nil="true"/>
<strict_virtual_machine_id nil="true"/>
<suspended type="boolean">false</suspended>
<template_id type="integer">8</template_id>
<template_label>OnApp CDN hypervisor</template_label>
<updated_at type="datetime">2012-08-08T23:37:20-10:00</updated_at>
<user_id type="integer">1</user_id>
<vip nil="true"/>
<xen_id type="integer">69</xen_id>
<ip_addresses type="array"><ip_address>
<created_at type="datetime">2012-04-03T06:08:07-10:00</created_at>
<customer_network_id nil="true"/>
<disallowed_primary type="boolean">false</disallowed_primary>
<gateway></gateway><hypervisor_id nil="true"/>
<id type="integer">12</id>
<ip_address_pool_id nil="true"/>
<network_id type="integer">1</network_id>
<pxe type="boolean">false</pxe>
<updated_at type="datetime">2012-07-13T00:58:21-10:00</updated_at>
<user_id nil="true"/>
<free type="boolean">false</free>
<total_disk_size type="integer">5</total_disk_size>
<cpu_priority type="integer">1</cpu_priority>


add_to_marketplace – true if this storage server is added to the marketplace; otherwise false

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

allow_resize_without_reboot – true if adjusting resource allocation without reboot is possible; otherwise false

allowed_hot_migrate – true if hot migration is allowed; otherwise false

allowed_swap – true if swap is allowed; otherwise false

booted – true if the server is booted; otherwise false

built - true if the server is already built; otherwise false

cpu_shares – the CPU priority percentage

cpus – number of CPU cores allocated to this storage server

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

edge_server_type - type of the CDN storage server

enable_autoscale – false; not available for edge servers

enable_monitis - deprecated attribute; will be removed in upcoming release

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

id – the edge server ID in OnApp CP database

identifier – the edge server identifier

initial_root_password – the server root password

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

label – an arbitrary name of the edge server

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 edge server

min_disk_size – minimum disk space required by the template

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

operating_system – type of operating system

operating_system_distro – the distribution of the operating system

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

remote_access_password – the password for remote access

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 server

suspended – true if suspended; otherwise false

template_id – the ID of the template, on which the edge server is based

template_label – label of the template on which the server is based; currently – OnApp CDN compute resource

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

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

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

xen_id – the edge server ID set by the virtualization engine

ip_addresses – an array of assigned IP addresses with the following parameters:

  • address – IP address
  • broadcast – broadcast address
  • created_at — the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
  • customer_network_id
  • disallowed_primary – true if not allowed to be used as primary (for VS build), otherwise false
  • gateway – gateway address
  • id –the ID of the IP address
  • ip_address_pool_id - ID of the IP address pool

  • network_address – the address of the network
  • network_id –the ID of the network
  • updated_at – the date when the Network was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format
  • free – true if free, otherwise false
  • netmask – netmask for the IP address

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

edge_status - status of the storage server

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