getClusterNodes
The getClusterNodes method retrieves server details on all nodes (servers) in the cluster, regardless of which node (server) was contacted.
Request Parameters
None
Response Parameters (return element children)
result
A result code such as internal.request.complete that describes the result. See Error Codes in the
Developer's Guide for details.
Developer's Guide for details.
clusterNodes
Each node in the cluster has a ClusterNode element in the response
address - IP address of the node
alias - an alpha-numeric identifier for the node
hostname - the URL of the node's host server
primary - Boolean, true if primary node, false otherwise
primaryNode - IP address of the primary node associated with this node, if node is primary, same as address ClusterNodes element
secondary - Boolean, true if secondary node, false otherwise
type - cluster.node.type.primary if primary node and cluster.node.type.secondary if secondary node
address - IP address of the node
alias - an alpha-numeric identifier for the node
hostname - the URL of the node's host server
primary - Boolean, true if primary node, false otherwise
primaryNode - IP address of the primary node associated with this node, if node is primary, same as address ClusterNodes element
secondary - Boolean, true if secondary node, false otherwise
type - cluster.node.type.primary if primary node and cluster.node.type.secondary if secondary node
Example Request and Response
Request
Response
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Header> <wsa:Action xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">urn:getClusterNodes</wsa:Action> <wsa:MessageID xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">uuid:e4208583-4135-416d-ad49-1a8c8f2fc593</wsa:MessageID> <wsa:ReplyTo xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> <wsa:Address>http://server/servlet/WSACallBackHandler</wsa:Address> <wsa:PortType xmlns:ns1="http://example.org">ns1:LocalPart</wsa:PortType> </wsa:ReplyTo> <wsa:To xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> https://server/platform-services/services/ClusterNodesService.ClusterNodesServiceHttpSoap11Endpoint/</wsa:To> </SOAP-ENV:Header> <SOAP-ENV:Body> <getClusterNodes xmlns="server_url"/> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
<?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> <wsa:To>http://server/servlet/WSACallBackHandler</wsa:To> <wsa:MessageID>urn:uuid:9796D0EE77E740553B1299274308237</wsa:MessageID> <wsa:Action>urn:getClusterNodesResponse</wsa:Action> <wsa:RelatesTo>uuid:57e67be6-412d-42e6-ad4e-01f24b35ed54</wsa:RelatesTo> </soapenv:Header> <soapenv:Body> <ns:getClusterNodesResponse xmlns:ns="http://server_url"> <ns:return xmlns:ax214="http://server_url/xsd" xmlns:ax213="http://server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax213:ClusterNodesResponse"> <ax213:result>internal.request.complete</ax213:result> <ax213:clusterNodes xsi:type="ax213:ClusterNode"> <ax213:address>server_address</ax213:address> <ax213:alias>bldr-vcm238</ax213:alias> <ax213:hostname>server_address</ax213:hostname> <ax213:primary>true</ax213:primary> <ax213:primaryNode>server_address</ax213:primaryNode> <ax213:secondary>false</ax213:secondary> <ax213:type>cluster.node.type.primary</ax213:type> </ax213:clusterNodes> <ax213:clusterNodes xsi:type="ax213:ClusterNode"> <ax213:address>server_address</ax213:address> <ax213:alias>bldr-vcm239</ax213:alias> <ax213:hostname>server.address</ax213:hostname> <ax213:primary>false</ax213:primary> <ax213:primaryNode>server_address</ax213:primaryNode> <ax213:secondary>true</ax213:secondary> <ax213:type>cluster.node.type.secondary</ax213:type> </ax213:clusterNodes> <ax213:clusterNodes xsi:type="ax213:ClusterNode"> <ax213:address>server_address</ax213:address> <ax213:alias/><ax213:hostname>bldr-vcm253</ax213:hostname> <ax213:primary>false</ax213:primary> <ax213:primaryNode>server_address</ax213:primaryNode> <ax213:secondary>true</ax213:secondary> <ax213:type>cluster.node.type.secondary</ax213:type> </ax213:clusterNodes> </ns:return> </ns:getClusterNodesResponse> </soapenv:Body> </soapenv:Envelope>
getMyClusterNode
The method retrieves information for the node (server) in the cluster that was contacted.
Request Parameters
None
Response Parameters (return element children)
ClusterNodes
address - IP address of the node
alias - an alpha-numeric identifier for the node
hostname - the URL of the node's host server
primary - Boolean, true if primary node, false otherwise
primaryNode - IP address of the primary node associated with this node, if node is primary, same as address ClusterNodes element
secondary - Boolean, true if secondary node, false otherwise
type - cluster.node.type.primary if primary node and cluster.node.type.secondary if secondary node
alias - an alpha-numeric identifier for the node
hostname - the URL of the node's host server
primary - Boolean, true if primary node, false otherwise
primaryNode - IP address of the primary node associated with this node, if node is primary, same as address ClusterNodes element
secondary - Boolean, true if secondary node, false otherwise
type - cluster.node.type.primary if primary node and cluster.node.type.secondary if secondary node
Example Request and Response
Request
Response
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Header> <wsa:Action xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> urn:getMyClusterNode</wsa:Action> <wsa:MessageIDxmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> uuid:cd3169b4-9595-4b60-bbfa-ae768423dbea</wsa:MessageID> <wsa:ReplyTo xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> <wsa:Address>http://server/servlet/WSACallBackHandler</wsa:Address> <wsa:PortType xmlns:ns1="http://example.org">ns1:LocalPart</wsa:PortType> </wsa:ReplyTo> <wsa:To xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> https://server/platform-services/services/ClusterNodesService.ClusterNodesServiceHttpSoap11Endpoint/</wsa:To> </SOAP-ENV:Header> <SOAP-ENV:Body> <getMyClusterNode xmlns="http://server_url"/> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
<?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"> <wsa:To>http://server/servlet/WSACallBackHandler</wsa:To> <wsa:MessageID>urn:uuid:8109AEDEE509351D941299799673199</wsa:MessageID> <wsa:Action>urn:getMyClusterNodeResponse</wsa:Action> <wsa:RelatesTo>uuid:feb14e8c-ca0a-448a-bf91-447effb66eb1</wsa:RelatesTo> </soapenv:Header> <soapenv:Body> <ns:getMyClusterNodeResponse xmlns:ns="http://server_url"> <ns:return xmlns:ax214="http://server_url/xsd" xmlns:ax213="http://server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax213:ClusterNodesResponse"> <ax213:result>internal.request.complete</ax213:result> <ax213:clusterNodes xsi:type="ax213:ClusterNode"> <ax213:address>server</ax213:address> <ax213:alias>bldr-vcm238</ax213:alias> <ax213:hostname>server_address</ax213:hostname> <ax213:primary>true</ax213:primary> <ax213:primaryNode>server</ax213:primaryNode> <ax213:secondary>false</ax213:secondary> <ax213:type>cluster.node.type.primary</ax213:type> </ax213:clusterNodes> </ns:return> </ns:getMyClusterNodeResponse> </soapenv:Body> </soapenv:Envelope>