vserver_detail ()
Returns all available information about VPS.
| HTTP Method: | GET | |
|---|---|---|
| Parameters: | sid | session id* |
| vserver_id | unique id of VPS** | |
| order_id | unique identifier of VPS order** | |
| Returns: | HTTP code | 200 (OK) |
| Function call successful. Reply portion reply contains detailed information about the VPS. |
Parameters marked with * are mandatory
One and only one of parameters marked with ** must be submited. These parameters are mutually exclusive.
One and only one of parameters marked with ** must be submited. These parameters are mutually exclusive.
Return errors
| Error code | HTTP response code | Description |
|---|---|---|
| 1 | 400 (Bad request) | Function was not performed, because all required parameters were not entered. Reply portion reply is empty. |
| 3 | 403 (Forbidden) | Function call failed, invalid sid parameter. Create new sid using /api/login function. Reply portion reply is empty. |
| 5 | 403 (Forbidden) | Function has not been performed, because it is probably an attempt to manipulate VPS that is not in your administration. Reply portion reply is empty. |
CURL
curl "https://admin.systems90.cz/api/vserver_detail?sid=%sid%&virtual_id=%virtual_id%"
PHP Library
$api->vserver_detail(array(
'vserver_id' => %virtual_id%,
));
Example of data output
<?xml version="1.0" encoding="UTF-8"?>
<reply>
<status>
<code>0</code>
<text>OK</text>
</status>
<vserver>
<vserver_id>399</vserver_id>
<server_status>Running</server_status>
<name>virtual_399</name>
<custom_name>Linux server</custom_name>
<hostname>test.hosting90.tld</hostname>
<plan_id>117</plan_id>
<boost>0</boost>
<cpu_cores>2</cpu_cores>
<disk_space>80</disk_space>
<ipv4>130.193.12.187</ipv4>
<ipv4_netmask>255.255.255.0</ipv4_netmask>
<ipv4_gateway>130.193.12.254</ipv4_gateway>
<ipv4_dns>130.193.9.36, 130.193.9.46</ipv4_dns>
<ipv6>2a03:b780:0001:0000:216:3eff:fe00:7bb</ipv6>
<ipv6_gateway>2a03:b780:1::ffff:ffff:ffff:ffff</ipv6_gateway>
<ipv6_dns>---</ipv6_dns>
<mac>00:16:3e:00:07:bb</mac>
<vnc_active>yes</vnc_active>
<vnc_ip>130.193.13.187</vnc_ip>
<vnc_port>5900</vnc_port>
<vnc_password>Ca3SZpe</vnc_password>
<traffic>
<ipv4_in>0.02</ipv4_in>
<ipv4_out>0.00</ipv4_out>
<ipv6_in>0.00</ipv6_in>
<ipv6_out>0.00</ipv6_out>
<limit>2048</limit>
</traffic>
<shaper>
<limit_in>0</limit_in>
<limit_out></limit_out>
</shaper>
<nwfilter>1</nwfilter>
<blocked_network>0</blocked_network>
<disable_default_network>0</disable_default_network>
<memory>4194304</memory>
<managed>yes</managed>
<node>hc-vh22</node>
<order_id>4582</order_id>
<iso>
<iso_id/>
<description/>
</iso>
<additional_ip_addresses>
<ip_address>
<ip_address_id>194</ip_address_id>
<ip>130.193.10.43</ip>
<netmask>255.255.255.0</netmask>
<gateway>130.193.10.254</gateway>
<hostname/>
</ip_address>
<ip_address>
<ip_address_id>474</ip_address_id>
<ip>130.193.10.245</ip>
<netmask>255.255.255.0</netmask>
<gateway>130.193.10.254</gateway>
<hostname/>
</ip_address>
</additional_ip_addresses>
<ipv6_subnets/>
<expiration/>
<licenses/>
<rtc>utc</rtc>
<hdd_mode>scsi</hdd_mode>
<hdd_cache>none</hdd_cache>
<watchdog>none</watchdog>
<hyperv_extensions>1</hyperv_extensions>
<graphics>qxl</graphics>
<network>virtio</network>
<rtc_tickpolicy>catchup</rtc_tickpolicy>
<action_lock>0</action_lock>
</vserver>
</reply>