The Cluster Web Service contains operations for creating the node profile and managing nodes in the Endeca Server cluster. It also contains operations for defining and managing data domain profiles, and for checking the status of the cluster and data domains.
After you install and deploy Endeca Server nodes, you can configure Endeca Server node profiles and data domain profiles. Next, use the Manage Web Service to add and manage data domains that will be hosted by the Endeca Server nodes and will use defined data domain profiles.
The Cluster Web Service lets you perform the following operations, where operations are represented by elements in the request:
Request element | Description |
---|---|
setNodeProfile | Define the custom node profile. The custom
node profile lets you set the hardware characteristics for all Endeca Server
cluster nodes, specifying the number of CPUs and the amount of available RAM.
If the custom node profile does not exist, the default node profile is used by
the Endeca Server cluster when it adds new nodes. You can use the
setNodeProfile operation at any time when
deploying new Endeca Server nodes in the cluster, for example, after the first
Endeca Server node has been deployed based on the default node profile.
Once you set a custom node profile, when you deploy new Endeca Server nodes in the cluster, this profile will be used for all Endeca Server nodes, including the current node. It is recommended to configure the custom node profile before creating data domain profiles and data domains (this is because they rely on the capacity of the Endeca Server cluster nodes determined by the node profile). Also, if you change the node profile after the data domains have been created, this may affect the data domains. To define a custom node profile, specify:
|
getNodeProfile | Return the hardware profile of nodes in the Endeca Server cluster as set by setNodeProfile. The request returns the number of CPUs and the amount of available RAM. This operation does not have any arguments. |
deleteNode | Remove a node from the Endeca Server
cluster, specifying its
hostname.
If the node you are attempting to delete is hosting data domains, the Endeca Server cluster attempts to migrate the data domains to other nodes, if the cluster has enough resources for this operation. The request returns a fault if the specified node does not exist in the cluster, or if the data domains hosted on the node cannot be migrated to other nodes due to insufficient resources in the Endeca Server cluster. |
listNodes | Return a list containing the hostname and port of each node in the cluster. This operation does not require any arguments. |
putDataDomainProfile | Configure a new data domain profile, which
defines resources available to a data domain when it is created. Specify these
values:
|
getDataDomainProfile | Return the data domain profile with the specified name. The request returns the same information as specified with putDataDomainProfile. |
deleteDataDomainProfile | Remove a specified data domain profile from the Endeca Server. |
listDataDomainProfiles | Return a list of all defined data domain profiles containing the same information as specified with putDataDomainProfile. |
getClusterHealth | Return the Endeca Server nodes and their status, the host names and ports of the nodes running the Cluster Coordinator and their status, and the data domains and their status. |
getDataDomainHealth | Return the health of the data domain with the specified name, and list the status of the Dgraph nodes in the data domain. |
getNodeHealth | Return the Endeca Server node's host name
and port and the status of the node. Additionally, it lists the status of the
Dgraph nodes hosted on this Endeca Server node (these Dgraph nodes belong to
different data domain clusters).
Requires you to specify the host name of the node. |
usage | Return a list of flags for the Dgraph process. These flags could be used as values in args element of the putDataDomainProfile operation. |
The following examples show the Cluster Web Service request and response for the getDataDomainHealth operation.
<ns1:getDataDomainHealth xmlns:ns1="http://www.endeca.com/endeca-server/cluster/1/0"> <ns1:name>test2</ns1:name> </ns1:getDataDomainHealth>