Get List of CDN Edge Servers

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

GET /edge_servers.xml
GET /edge_servers.json

XML Request example

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

JSON Request example:

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


To get the list of HTTP edge servers

XML Request example:

curl -i -X GET -u user:userpass http://onapp.test/edge_servers.xml?type=http

JSON Request example:

curl -i -X GET -u user:userpass http://onapp.test/edge_servers.json?type=http


To get the list of streaming edge servers:

XML Request example:

curl -i -X GET -u user:userpass http://onapp.test/edge_servers.xml?type=streaming

JSON Request example:

curl -i -X GET -u user:userpass http://onapp.test/edge_servers.json?type=streaming

XML Output example

<edge_servers type="array">
<edge_server>
<add_to_marketplace type="boolean">true</add_to_marketplace>
<admin_note nil="true"/>
<allowed_hot_migrate type="boolean">false</allowed_hot_migrate>
<allowed_swap type="boolean">true</allowed_swap>
<booted type="boolean">false</booted>
<built type="boolean">true</built>
<cpu_shares type="integer">7</cpu_shares>
<cpu_sockets nil="true"/>
<cpu_threads nil="true"/>
<cpu_units type="integer">140</cpu_units>
<cpus type="integer">1</cpus>
<created_at type="datetime">2015-02-10T14:19:45+02:00</created_at>
<customer_network_id nil="true"/>
<deleted_at nil="true"/>
<edge_server_type>streaming</edge_server_type>
<enable_autoscale nil="true"/>
<enable_monitis type="boolean">false</enable_monitis>
<firewall_notrack type="boolean">true</firewall_notrack>
<hypervisor_id type="integer">25</hypervisor_id>
<id type="integer">3781</id>
<identifier>kcs0o46otoxbr0</identifier>
<initial_root_password>3yV4Orl1B1Le</initial_root_password>
<initial_root_password_encrypted type="boolean">false</initial_root_password_encrypted>
<label>qawsedrf</label>
<local_remote_access_ip_address>109.123.91.36</local_remote_access_ip_address>
<local_remote_access_port nil="true"/>
<locked type="boolean">false</locked>
<memory type="integer">2054</memory>
<min_disk_size type="integer">20</min_disk_size>
<note nil="true"/>
<operating_system>linux</operating_system>
<operating_system_distro>ubuntu</operating_system_distro>
<preferred_hvs type="array"/>
<recovery_mode type="boolean">false</recovery_mode>
<remote_access_password>GPRdQyq28jVR</remote_access_password>
<service_password nil="true"/>
<state>delivered</state>
<storage_server_type nil="true"/>
<strict_virtual_machine_id nil="true"/>
<suspended type="boolean">false</suspended>
<template_id type="integer">11</template_id>
<template_label>debian-6.0-x64-1.14-xen.kvm.kvm_virtio.tar.gz</template_label>
<updated_at type="datetime">2015-03-05T10:18:53+02:00</updated_at>
<user_id type="integer">4</user_id>
<vip nil="true"/>
<xen_id nil="true"/>
<ip_addresses type="array">
<ip_address>
<address>109.123.91.154</address>
<broadcast>109.123.91.191</broadcast>
<created_at type="datetime">2014-01-14T14:19:52+02:00</created_at>
<customer_network_id nil="true"/>
<disallowed_primary type="boolean">false</disallowed_primary>
<gateway>109.123.91.129</gateway>
<hypervisor_id nil="true"/>
<id type="integer">25</id>
<ip_address_pool_id nil="true"/>
<network_address>109.123.91.128</network_address>
<network_id type="integer">1</network_id>
<pxe type="boolean">false</pxe>
<updated_at type="datetime">2014-11-06T17:10:35+02:00</updated_at>
<user_id nil="true"/>
<free type="boolean">false</free>
<netmask>255.255.255.192</netmask>
</ip_address>
</ip_addresses>
<monthly_bandwidth_used>0</monthly_bandwidth_used>
<total_disk_size type="integer">20</total_disk_size>
<price_per_hour type="float">20540.0</price_per_hour>
<price_per_hour_powered_off type="float">0.0</price_per_hour_powered_off>
<support_incremental_backups type="boolean">true</support_incremental_backups>
<cpu_priority type="integer">7</cpu_priority>
<edge_status>Active</edge_status>
<cdn_reference type="integer">276964394</cdn_reference>
</edge_server>


Explanation of the data returned:

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

admin_note – an optional reminder for this VS 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

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

created_at – the date when the CDN edge server 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 VS was deleted

edge_server_type - true if this is the edge server 

enable_autoscale – false; not available for edge servers

enable_monitis - deprecated attribute; will be removed in upcoming release

firewall_notrack - true if the NOTRACK rule is set in iptables

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

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

recovery_mode – true if the server 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

storage_server_type - true if this is a storage server

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 their details assigned to this edge server:

  • address – baremetal server IP
  • 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
  • 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 - VS monthly bandwidth in KB

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

price_per_hour - server's price per hour

price_per_hour_powered_off - price per hour when server is powered off

support_incremental_backups - 1, if virtual server 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 edge server status

cdn_reference - the identifier in database