vserver_ready_for_command ()
This function returns whether the VPS is ready to accept a command or is busy processing previous request.
HTTP Method: | GET | |
---|
Parameters: | sid | session id* |
---|
| vserver_id | unique id of VPS* |
Returns: | HTTP code | 200 (OK) |
---|
| | Function call successful. Returns VPS state. |
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_ready_for_command?sid=%sid%&virtual_id=%virtual_id%"
PHP Library
$api->vserver_ready_for_command(array(
'virtual_id' => %virtual_id%,
));
Example of data output
<?xml version="1.0" encoding="UTF-8"?>
<reply>
<status>
<code>1</code>
<text>Bad parameters (required: sid, vserver_id)</text>
</status>
</reply>