Use the get-local operation to retrieve info on local database servers of the specified type. You can retrieve preferences of multiple local database servers in a single packet.
Request Packet Structure
A request XML packet retrieving a local database server info includes the get-local operation node:
The get-local node has the following graphical representation:
- The filter node is required. It specifies the filtering rule. Data type: none.
- The type node is optional. It specifies the type of local database servers. Data type: string. Allowed values: mssql | mysql | postgresql.
Note: If the filter node is left blank (<filter/>), the operation will return info on all local database servers.
A single operation can retrieve the data of multiple database servers. Add as many different type parameters as the number of local database servers info on which you want to retrieve.
Response Packet Structure
- The get-local node of the output XML packet is structured as follows:
- The result node is required. It wraps the response retrieved from the server. Data type: DatabaseServerResultType (
- The status node is required. It specifies the execution status of the get-local operation. Data type: string. Allowed values: ok | error.
- The errtext node is optional. It returns the error message if the get-local operation fails. Data type: string.
- The errcode node is optional. Is returns the error code if the get-local operation fails. Data type: integer.
- The type node is required. It returns the type of the database server. Data type: string.
- The id node is optional. It returns the ID of the database server. Data type: integer.
Retrieving info on a single database server
This request packet retrieves info on the MySQL local database server.
If the type of database server was invalid, the response from the server looks as follows:
Retrieving info on multiple database servers
This request packet retrieves info on all local database servers.