The clusterReconfigureServer Method

Parameter

 Type

Required

Description

serverId

String

Yes

The server ID.

doRestart

Boolean

No

Specify if the re-configured server should be restarted after the re-configure action. The default is FALSE.

HTTP Code

 Error Code

Description

404

noSuchServer

There is no server with the provided server ID.

500

cantConnectToServer

Zend Server is unable to connect to the specified server.

500

invalidServerResponse

An invalid or unexpected response from the server.

503

temporarilyLocked

The server cannot be re-configured because it is currently in the middle of another operation (e.g. being disabled).

405

notImplementedByEdition

The method cannot executed by this edition of Zend Server.

500

serverNotLicensed

Zend Server does not have a valid license.

500

restartFailed

Restarting the server failed.

Request (headers removed for clarity)

POST /ZendServer/Api/clusterReconfigureServer
serverID=5

Response

HTTP/1.0 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName>angel.eyes</apiKeyName>
		<method>clusterReconfigureServer</method>
	</requestData>
	<responseData>
		<serverInfo>
			<id>5</id>
			<name>www-02</name>
			<address>www-02.local</address>
			<status>pendingRestart</status>
			<messageList />
			<debugModeEnabled>true</debugModeEnabled>
		</serverInfo>
	</responseData>
</zendServerAPIResponse>