Use the get-status operation to retrieve status of Log Rotation service on sites.
A request XML packet retrieving status of Log Rotation service includes the get-status operation node:
<packet version="1.5.0.0">
<log-rotation>
<get-status>
...
</get-status>
</log-rotation>
</packet>
The get-status node is presented by type LogRotationDisableInput (logrotation.xsd
), and its graphical representation is as follows:
logrotation.xsd
).Remarks
You can use different filtering rules in a single packet. Add as many get-status operations as the number of different filtering rules.
<packet version="1.5.0.0">
<log-rotation>
<get-status>
...
</get-status>
...
<get-status>
...
</get-status>
</log-rotation>
</packet>
The get-status node of the output XML packet is presented by type LogRotationGetStatusOutput (logrotation.xsd
) and structured as follows:
common.xsd
).
The following request packet retrieves status of Log Rotation service on site example.com:
<packet>
<log-rotation>
<get-status>
<filter>
<site-name>example.com</site-name>
</filter>
</get-status>
</log-rotation>
</packet>
Response:
<packet>
<log-rotation>
<get-status>
<result>
<status>ok</status>
<filter-id>example.com</filter-id>
<id>33</id>
</result>
</get-status>
</log-rotation>
</packet>
If the site was not found, the response from the server looks as follows:
<packet>
<log-rotation>
<get-status>
<result>
<status>error</status>
<errcode>1013</errcode>
<errtext>site does not exist</errtext>
<filter-id>example.com</filter-id>
</result>
</get-status>
</log-rotation>
</packet>
The following request packet retrieves status of Log Rotation service on sites used by the customers with ID 5 and ID 8:
<packet>
<log-rotation>
<get-status>
<filter>
<owner-id>5</owner-id>
<owner-id>8</owner-id>
</filter>
</get-status>
</log-rotation>
</packet>
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) the response from the server looks as follows:
<packet>
<log-rotation>
<get-status>
<result>
<status>error</status>
<errcode>1015</errcode>
<errtext>customer does not exist</errtext>
<filter-id>5</filter-id>
</result>
</get-status>
<get-status>
<result>
<status>ok</status>
<filter-id>8</filter-id>
<id>17</id>
</result>
</get-status>
<get-status>
<result>
<status>ok</status>
<filter-id>8</filter-id>
<id>29</id>
</result>
</get-status>
</log-rotation>
</packet>