Node Offboard object

As a Cloud or Runtime cluster owner, use the Node Offboard object to programatically delete nodes from a Cloud or Runtime cluster cluster.

The Node Offboard object performs similarly to how you might use the Delete button on the Cluster Status panel in Runtime Management to remove a node. You must have Runtime Management privileges to use the Node Offboard object.

Structure

<NodeOffboard atomId="">
  <nodeId></nodeId>
</NodeOffboard>

Field	Type	Description
atomId	string	A unique, -generated identifier assigned to the Runtime cluster or Runtime cloud. In the  user interface, this ID appears on the Runtime Information panel of Runtime Management.
nodeId	string	The ID of the Runtime cluster or Cloud node that is intended for deletion. In the  user interface, this ID appears on the Cluster Status panel of Runtime Management.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Not Supported	Not Supported	Supported	Not Supported	Not Supported	Not Supported

Using the CREATE operation

• The Node Offboard API employs a POST (or CREATE) method to delete a node. After you successfully perform the CREATE operation, the node's status immediately changes to Deleting on the Cluster Status panel of the interface.

SOAP implementation

• CREATE operation

  Request:

  <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:par="http://partner.api.platform.boomi.com/" xmlns:api="http://api.platform.boomi.com/">
     <soapenv:Header/>
     <soapenv:Body>
        <par:create>
  		<object xsi:type="api:NodeOffboard" atomId="3456789a-bcde-f012-3456-789abcdef012" xmlns:api="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  			<api:nodeId>node1</api:nodeId>
  		</object>
           <accountId>account-123456</accountId>
        </par:create>
     </soapenv:Body>
  </soapenv:Envelope>

  Response:

  <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
     <S:Body>
        <ns4:createResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" xmlns:ns4="http://partner.api.platform.boomi.com/">
           <result xsi:type="bns:NodeOffboard" atomId="3456789a-bcde-f012-3456-789abcdef012">
              <bns:nodeId>node1</bns:nodeId>
           </result>
        </ns4:createResponse>
     </S:Body>
  </S:Envelope>