Use the enable operation to enable Log Rotation service on sites.

Request Packet Structure

A request XML packet enabling Log Rotation service includes the enable operation node:

<packet>
    <log-rotation>
        <enable>
            ...
        </enable>
    </log-rotation>
</packet>

The enable node is presented by type LogRotationEnableInput (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 (logrotation.xsd) .

Remarks

You can use different filtering rules in a single packet. Add as many enable operations as the number of different filtering rules.

<packet>
    <log-rotation>
        <enable>
            ...
        </enable>
        ...
        <enable>
            ...
        </enable>
    </log-rotation>
</packet>

Response Packet Structure

The enable node of the output XML packet is presented by type LogRotationEnableOutput (logrotation.xsd) and structured as follows:

• The result node is required. It wraps the response retrieved from the server. Data type: resultFilterType (common.xsd).
• The status node is required. It specifies the execution status of the enable operation. Data type: string. Allowed values: ok | error.
• The errcode node is optional. It returns the error code if the enable operation fails. Data type: unsignedInt.
• The errtext node is optional. It returns the error message if the enable 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 enable operation succeeds, it holds the ID of the site matched by the filtering rule. Data type: integer.

Samples

Enabling Log Rotation service on a single site

The following request packet enables Log Rotation service on site example.com:

<packet>
    <log-rotation>
        <enable>
            <filter>
                <site-name>example.com</site-name>
            </filter>
        </enable>
    </log-rotation>
</packet>

Response:

<packet>
    <log-rotation>
        <enable>
            <result>
                <status>ok</status>
                <filter-id>example.com</filter-id>
                <id>33</id>
            </result>
        </enable>
    </log-rotation>
</packet>

Enabling Log Rotation service on multiple sites

The following request packet enables Log Rotation service on domains used by the customers with ID 5 and ID 8:

<packet>
    <log-rotation>
        <enable>
            <filter>
                <owner-id>5</owner-id>
                <owner-id>8</owner-id>
            </filter>
        </enable>
    </log-rotation>
</packet>

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)):

<packet>
    <log-rotation>
        <enable>
            <result>
                <status>error</status>
                <errcode>1015</errcode>
                <errtext>customer does not exist</errtext>
                <filter-id>5</filter-id>
            </result>
        </enable>
        <enable>
            <result>
                <status>ok</status>
                <filter-id>8</filter-id>
                <id>17</id>
            </result>
        </enable>
        <enable>
            <result>
                <status>ok</status>
                <filter-id>8</filter-id>
                <id>29</id>
            </result>
        </enable>
    </log-rotation>
</packet>