vserver_vlan_detail ()
This function returns detail of specific VLAN.
HTTP Method: | GET | |
---|
Parameters: | sid | session id* |
---|
| name | VLAN name* |
Returns: | HTTP code | 200 (OK) |
---|
| | Function call successful. Reply portion reply contains detail of specific VLAN. |
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 call failed, you are probably trying to manipulate VLAN that is not under your account. Reply portion reply is empty.
|
CURL
curl "https://admin.hosting90.eu/api/vserver_vlan_detail?sid=%sid%&vlan_id=%vlan_id%"
PHP Library
$api->vserver_vlan_detail(array(
'vlan_id' => %vlan_id%,
));
Example of data output
<?xml version="1.0" encoding="UTF-8"?>
<reply>
<status>
<code>0</code>
<text>OK</text>
</status>
<vlan_detail>
<vlan_id>5670</vlan_id>
<name>TEST</name>
<internal_name>vlan5670</internal_name>
<mac_base>10:00:00:5E</mac_base>
<members />
<type>default</type>
</vlan_detail>
</reply>