Retrieving Supported Recursion Types
The get-supported-recursion operation retrieves the types of recursive requests, supported by the local DNS server. For more information on types of requests, please refer to the Managing DNS recursion section.
Request Packet Structure
A request XML packet, that retrieves the supported types of recursion, includes the get-supported-recursion operation node:
<packet version="1.6.7.0">
<dns>
<get-supported-recursion/>
</dns>
</packet>
The graphical representation of the get-supported-recursion node is as follows:
Note: The interactive schema navigator for all request packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_input.svg.
Response Packet Structure
The get-supported-recursion node is presented by type
DNSGetSupportedRecursionOutputType (dns_output.xsd
) and is
structured as follows:
Note: The interactive schema navigator for all response packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_output.svg.
- The result node is required. It wraps the information got from
the server. Data type: resultType (
common.xsd
). - The status node is required. It specifies the execution status of the get-supported-recursion operation. Data type: string. Allowed values: ok | error.
- The errcode node is optional. It is used to return the error code when the get-supported-recursion operation fails. Data type: unsignedInt.
- The errtext node is optional. It is used to return the error message if the get-supported-recursion operation fails. Data type: string.
- The value node is optional. It is used to return the supported types of recursion if the get-supported-recursion operation succeeds. Data type: string.
Samples
This request packet retrieves the types of recursive requests supported by the server.
<packet version="1.6.7.0">
<dns>
<get-supported-recursion/>
</dns>
</packet>
Response:
<packet version="1.6.7.0">
<dns>
<get-supported-recursion>
<result>
<status>ok</status>
<value>on</value>
<value>localnets</value>
<value>local</value>
</result>
</get-supported-recursion>
</dns>
</packet>