The get operation is used to change settings of Log Rotation.
Request Packet Structure
A request XML packet retrieving Log Rotation settings includes the get operation node:
The get node is presented by type LogRotationGetInput (
logrotation.xsd), and its graphical representation is as follows:
- The filter node is required. Specifies the filtering rule. For more information, refer to the Available Filters section. Data type: logRotationFilterType (
You can use different filtering rules in a single packet. Add as many get operations as the number of different filtering rules.
Response Packet Structure
The get node of the output XML packet is presented by type LogRotationGetOutput (
logrotation.xsd) and structured as follows:
- The result node is required. It wraps the response retrieved from the server. Data type: resultFilterType (
- The status node is required. It specifies the execution status of the get operation. Data type: string. Allowed values: ok | error.
- The errcode node is optional. It returns the error code if the get operation fails. Data type: unsignedInt.
- The errtext node is optional. It returns the error message if the get operation fails. Data type: string.
- The filter-id node is required. It returns a filtering rule parameter. For more information, refer to the Available Filters section. Data type:anySimple.
- The id node is optional. If the get operation succeeds, it holds the ID of the site matched by the filtering rule. Data type: integer.
- The settings node is optional. It specifies Log Rotation settings. For details, refer to the Log Rotation Settings section. Data type: LogRotationSettingsType (
Retrieving settings of a single site
The following request packet retrieves Log Rotation settings of site example.com:
If the site was not found, the response from the server looks as follows:
If a packet sender has no rights to manage physical hosting, the response looks as follows:
If the site is not hosted physically, the response from the server looks as follows:
Retrieving settings of multiple domains
The following request packet retrieves Log Rotation settings of sites used by the customers with ID 5 and ID 8:
Response (if the customer with ID 5 was not found on the server and the customer with ID 8 runs two domains (ID 17 and 29)):