VDSmanager API/VDS Owner
From ISPWiki
|
See also
VDS Owner
Main
System information
Function: vds.sysinfo
Result: the list of elements
- name - Parameter.
- value - Value.
IP-addresses
Function: vdsip
Result: the list of elements
- ip - IP-address.
- name - Domain name.
Function: vdsip.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("ip" element of "vdsip" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("ip" element of "vdsip" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- ip - IP-address.
- name - Domain name.
Running processes
Function: vdsproc
Result: the list of elements
- pid - PID.
- uid - UID.
- cpu - CPU %.
- mem - Memory (kb).
- time - Uptime .
- cmd - Command.
Function: vdsproc.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "pid" element of "vdsproc" function.
Result: successful operation or error message
Private files
Function: vdsfiles
Result: the list of elements
- name - Name.
- size - Size.
- time - Modified.
- state - Status.
Function: vdsfiles.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "vdsfiles" function.
Result: successful operation or error message
Function: vdsfiles.upload
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- type - File type. If the link value is selected the parameters are allowed to use: 'url','name' and the parameters are denied: 'file'
- url - URL.
- name - File name.
- filename - Local file.
Backups
Function: vdsbackup
Result: the list of elements
- name - Name.
- restoring - .
Function: vdsbackup.restore
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "vdsbackup" function.
Result: successful operation or error message
Tools
Rebooting VPS
Function: reboot
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Reinstalling VPS
Function: reinstall
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- disktempl - Disk template.
Connect ISO
Function: vds.attachcd
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- iso - List of the ISO images .
Boot priority
Function: vds.bootprio
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- priority - Boot priority . (One or more values space-delimited)
Switch to ISPmanager
Function: vdsispmgr
Statistics
Resource allocation problems
Function: statrejects
Result: the list of elements
- name - Date.
- rejp - Processes .
- rejf - File descriptors .
- rejm - Memory .
- rejs - Swap .
System usage report
Function: statusage
Result: the list of elements
- name - Date.
- cpuu - CPU, %.
- memu - Memory, %.
- procu - Processes, %.
- fileu - File descriptors, %.
VPS current usage
Function: currentusage
Result: the list of elements
- name - Date/Time.
- cpuu - CPU %.
- memu - Memory %.
- procu - Processes %.
- fileu - File descriptors %.
Current resource allocation problems
Function: currentreject
Result: the list of elements
- name - Date/time .
- memr - Memory .
- procr - Processes .
- filer - File descriptors .
- Use the "featurelist" API function to get the list of active features.
