Waiting for engine...
Skip to main content

Change listener status operation

You can use the changeListenerStatus operation to pause, resume, or restart listeners. You can change the status of a single listener or all listeners for a runtime, Runtime cluster, or Runtime cloud.

Note: You can use the Listener Status object to retrieve the status of listeners before or after performing this operation.

Parameters​

The following parameters are required to perform the changeListenerStatus operation:

Parameter
Description

listenerId
(Optional) The ID of a single listener process whose status you want to change.

To change the status of all listeners, omit this parameter.

Note: You can obtain the ID for a listener process by using a QUERY operation on the Process object.

containerId
The ID of the runtime, Runtime cluster, or Runtime cloud to which you deploy the listener or listeners.

action
The action to be performed: pause, resume, restart, pause_all, resume_all, or restart_all.

The pause, resume, and restart actions require the listenerId parameter.

Do not specify the listenerId parameter for pause_all, resume_all, and restart_all actions.

SOAP implementation​

To perform a changeListenerStatus operation, use it from the WSDL. The following example shows a SOAP envelope for pausing a single listener.

Request:

<soapenv:Envelope 
    xmlns:api="http://api.platform.boomi.com/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:par="http://partner.api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security
       xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
          <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">
              ATOMSPHERE_PASSWORD
          </wsse:Password>
        </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:changeListenerStatus>
         <api:listenerId>6a73f710-6743-4e3d-ae66-79a36f0b8170</api:listenerId>
         <api:containerId>23c6f84e-bab8-4280-a7db-4fdaea918d94</api:containerId>
         <api:action>pause</api:action>
      </api:changeListenerStatus>
   </soapenv:Body>
</soapenv:Envelope>

A successful changeListenerStatus call returns an empty changeListenerStatusResponse to indicate acceptance of the request.

On this Page