Web API Reference Guide > Available API Methods > Server and Cluster Management Methods > The clusterDisableServer Method

The clusterDisableServer Method

This method disables a cluster member. This process may be asynchronous if Session Clustering is used. If this is the case, the initial operation returns an HTTP 202 response. As long as the server is not fully disabled, further calls to this method are idempotent. On a Zend Server with no valid license, this operation fails.

Version: 1.0

Required Permissions: full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:

Parameter

 Type

Required

Description

serverId

String

Yes

The server ID

Expected Response Code:

Response Type: serverInfo with the status of the server being disabled. The status is either shuttingDown or disabled. On a Zend Server with no valid license, this operation fails.

Possible Action Specific Error Codes:

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 disabled because another server in the cluster is performing a graceful startup/shutdown.

405

notImplementedByEdition

The method is not implemented by this edition of Zend Server.

500

serverNotLicensed

Zend Server is not licensed.

Example

Usage Example

Request (headers removed for clarity)

POST /ZendServer/Api/clusterDisableServer

serverId=5

Response

HTTP/1.0 200 OK

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

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.0">

<requestData>

<apiKeyName>angel.eyes</apiKeyName>

<method>clusterDisableServer</method>

</requestData>

<responseData>

<serverInfo>

<id>5</id>

<name>www-02</name>

<address>www-02.local</address>

<status>disabled</status>

<messageList />

<debugModeEnabled>true</debugModeEnabled>

</serverInfo>

</responseData>

</zendServerAPIResponse>

Important Note:

For Zend Server on Mac or Linux, this action is also available via the command line using CLI Tools. For more information see CLI Tools.

 

Read Also

  Available API Methods    
  Server and Cluster Management Methods