The clusterGetServerStatus Method

Parameter

 Type

Required

Description

servers

Array

No

A list of server IDs. If specified, the status is returned for these servers only. If not specified, the status of all the servers is returned.

force

String

No

'true','false' - default

HTTP Code

 Error Code

Description

404

 noSuchServer

One or more of the provided server IDs does not exist in the cluster.

405

notImplementedByEdition

This method is only available on Zend Server Professional and Enterprise editions.

500

serverNotLicensed

Zend Server is not licensed.

Request (URI broken for readability)

 GET /ZendServer/Api/clusterGetServerStatus? 
 servers%5B0%5D=12&servers%5B1%5D=15

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.0">
	<requestData>
		<apiKeyName>angel.eyes</apiKeyName>
		<method>clusterGetServersStatus</method>
	</requestData>
	<responseData>
		 <serversList>
		      <serverInfo>
		        <id>12</id>
		        <name>www-01</name>
		        <address>https://www-01.local:10082/ZendServer</address>
		        <status>OK</status>
    <debugModeEnabled>true</debugModeEnabled>
		        <messageList/>
		      </serverInfo>
		      <serverInfo>
		        <id>15</id>
		        <name>www-02</name>
		        <address>https://www-02.local:10082/ZendServer</address>
		        <status>pendingRestart</status>
		        <messageList>
		          <warning>This server is waiting a PHP restart</warning>
		        </messageList>
    <debugModeEnabled>true</debugModeEnabled>
		      </serverInfo>
		   </serversList>
	</responseData>
</zendServerAPIResponse>