Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Children Display
alltrue
styleh3
pageSuperb Cloud API

GET /virtual_machines/:virtual_machine_id/network_interfaces

Gets network interfaces allocated to specified VS

Sections:

Table of Contents
maxLevel4
minLevel2
includeResponse.*|JSON.*|XML.*|Explanation.*

Response Parameters

label - network interface name

created_at - the timestamp in the database when this network interface was created

updated_at - the timestamp in the database when this network interface was updated

primary - true if this network interface is primary, otherwise false

id - the ID of this network interface

mac_address – network interface MAC address

rate_limit - port speed in Mbps

identifier - the identifier in the database of this network interface

network_join_id - the ID of the network join to which this network interface belongs

virtual_machine_id - the ID of a virtual server to which this network interface is attached

JSON Request example

Code Block
languagebash
themeRDark
 GET /virtual_machines/:virtual_machine_id/network_interfaces.json 

JSON Response

Code Block
themeRDark
 [
    {
        "network_interface": {
            "created_at": "2015-08-27T19:34:49+00:00",
            "default_firewall_rule": "ACCEPT",
            "id": 509,
            "identifier": "ydurfmxpnlmyrf",
            "label": "eth0",
            "mac_address": "00:16:3e:60:6e:9b",
            "network_join_id": 2,
            "primary": true,
            "rate_limit": 1,
            "updated_at": "2015-08-28T01:08:30+00:00",
            "usage": null,
            "usage_last_reset_at": null,
            "usage_month_rolled_at": null,
            "virtual_machine_id": 511
        }
    }
]

XML Request example

Code Block
languagebash
themeRDark
 GET /virtual_machines/:virtual_machine_id/network_interfaces.xml

XML Response example

Code Block
languagexml
themeRDark
 <?xml version="1.0" encoding="UTF-8"?>
<network_interfaces type="array">
<network_interface>
<label>eth0</label>
<usage nil="true"></usage>
<created_at type="datetime">2011-03-18T17:45:07+07:00</created_at>
<updated_at type="datetime">2011-04-08T18:57:20+07:00</updated_at>
<primary type="boolean">true</primary>
<usage_month_rolled_at nil="true"></usage_month_rolled_at>
<id type="integer">502</id>
<mac_address>00:16:3e:50:35:52</mac_address>
<usage_last_reset_at nil="true"></usage_last_reset_at>
<default_firewall_rule>DROP</default_firewall_rule>
<rate_limit type="integer">0</rate_limit>
<virtual_machine_id type="integer">518</virtual_machine_id>
<network_join_id type="integer">4</network_join_id>
<identifier>pdfjrtpkday9e1</identifier>
</network_interface>
...
<network_interface></network_interface>
...
</network_interfaces>