Server Manager - GetDatabaseInstances

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Server Manager - GetDatabaseInstances retrieves all database instances in the cluster. This web service call can be made as http://your-domain.com/HC7API/ServerManager.asmx?op=GetDatabaseInstances.

Input Parameters

• HostUserName

• HostPassword

• OwnerName

• OptionalParam

• DatabaseType

• Language
   

Output Parameters

• DatabaseServerID      

• DatabaseServerName

• DatabaseInstanceName   

Sample Optional Parameters

<Parameters>

<Parameter Name = "DatabaseType">My SQL</Parameter>

<Parameter Name = "Language">French</Parameter>

</Parameters>

Sample SOAP Request

POST /HC7API/Servermanager.asmx HTTP/1.1

Host: your-domain.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://tempuri.org/GetDatabaseInstances"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Body>

    <GetDatabaseInstances xmlns="http://tempuri.org/">

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <OptionalParam>xml</OptionalParam>

    </GetDatabaseInstances>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

POST /HC7API/Servermanager.asmx/GetDatabaseInstances HTTP/1.1

Host: your-domain.com

Content-Type: application/x-www-form-urlencoded

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=david&OptionalParam=xml

Sample C# Code

public ServerManager.Response GetDatabaseInstances(string strHostUserName, string strHostPassword, string strOwnerName)

{

         try

         {

                    ServerManager.ServerManager oServer= new ServerManager.ServerManager();

                    ServerManager.Response oResponse = new ServerManager.Response();

                     XmlDocument oDoc = new XmlDocument();

                     //Adding root node

                     XmlNode xOptionalParam = oDoc.CreateNode(XmlNodeType.Element,"Parameters","");

                     //Adding sub nodes

                     XmlNode xParameter = oDoc.CreateNode(XmlNodeType.Element,"Parameter","");

                     XmlAttribute xAttribute = oDoc.CreateAttribute("Name");

                     xAttribute.Value = "DatabaseType";

                     xParameter.Attributes.Append(xAttribute);

                     xParameter.InnerText = "MY SQL";

                     xOptionalParam.AppendChild(xParameter);

                     .......

                     .......

                     .......

                     o.Response = oServer.GetDatabaseInstances(strHostUserName, strHostPassword, strOwnerName,

                     OptionalParam)

          }

          catch

          {

          }

          return oResponse;

}

Sample Response

<Response>

    <Method>GetDatabaseInstances</Method>

    <Status>true</Status>    
 <ErrorCode>74900001</ErrorCode>    
 <ErrorDescription>Operation completed successfully.</ErrorDescription>

    <Result>

        <DatabaseInstances xmlns="">

            <RecordRow>

                <DatabaseServerID>1</DatabaseServerID>

                <DatabaseServerName>abc</DatabaseServerName>

                <DatabaseInstanceName>localhost</DatabaseInstanceName>

            </RecordRow>

                 .......

                 .......

                 .......

           </DatabaseInstances>

       </Result>

</Response>