The list operation is used to retrieve the list of database servers available to the plan subscribers.
A request XML packet retrieving the list of databases available to the plan subscribers includes the list operation node:
<packet>
<service-plan>
<db-servers>
<list>
...
</list>
</db-servers>
</service-plan>
</packet>
The list node is presented by a complex type (domain_template.xsd)
. Its graphical representation is as follows:
domain_template.xsd
). See the Available Filters section for details on this node.
The list node of the output XML packet is of complex type (domain_template.xsd)
which has the following presentation:
common.xsd
). common.xsd
).domain_template.xsd
).The following request retrieves the list of database servers available in the service plan with id 1:
<packet>
<service-plan>
<db-servers>
<list>
<filter>
<id>1</id>
</filter>
</list>
</db-servers>
</service-plan>
</packet>
A positive response got from the server after retrieving the list of database servers available to plan subscribers can look as follows:
<packet>
<service-plan>
<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>
</service-plan>
</packet>