Retrieving the List of Available Database Servers

The list operation is used to retrieve the list of database servers available to the plan subscribers.

In this chapter:

Request Packet Structure

Response Packet Structure

Sample

 
Request Packet Structure

A request XML packet retrieving the list of databases available to the plan subscribers includes the list operation node:

<packet>
<webspace>
   <db-servers>
	  <list>
	   ...
	  </list>
   </db-servers>
</webspace>
</packet>

 

The list node is presented by a complex type (webspace.xsd). Its graphical representation is as follows:

db-servers-list

 
Response Packet Structure

The list node of the output XML packet is of the type WebspaceDbServerListOutputType (webspace.xsd)which has the following presentation:

db-servers-webspace-list-resp

 
Sample

The following request retrieves the list of database servers available within the subscription with id 1:

<packet>
  <webspace>
    <db-servers>
      <list>
        <filter>
          <id>1</id>
        </filter>
      </list>
    </db-servers>
  </webspace>
</packet>

Response:

<packet>
  <webspace>
    <db-servers>
      <list>
        <result>
          <status>ok</status>
          <filter-id>1</filter-id>
          <id>1</id>
          <db-server>
            <type>mysql</type>
            <id>1</id>
            <host>localhost</host>
            <port>3306</port>
          </db-server>
          <db-server>
            <type>postgresql</type>
            <id>2</id>
            <host>localhost</host>
            <port>5432</port>
          </db-server>
        </result>
      </list>
    </db-servers>
  </webspace>
</packet>