List Cluster Members
The members endpoint returns a JSON file with a list of members in the cluster and their settings.
Description | Returns a list of the nodes that are members of a cluster | |
Method | GET /api/v1/clusterconfig/members | |
Response Data | member | |
Authentication Required | yes | |
Return Codes | ||
200 | Request complete | |
400 | Bad authentication | |
500 | Request failed |
http
GET /api/v1/clusterconfig/members
shell
curl -v -X GET $YOUR_LOGSCALE_URL/api/v1/clusterconfig/members \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json"
json
[
{
"cores": 4,
"diskUsagePercentage": 29,
"displayName": "localhost:8080",
"humioVersion": "1.82.0--build-406818--sha-83da25d64199d5eea099adb7f4224ff3bef8ed5e",
"internalHostUri": "http://localhost:8080",
"isBeingEvicted": false,
"isEphemeral": false,
"lifecycleState": "Running",
"minimumCompatibleHumioVersion": "1.44.0",
"nodeRoleString": "all",
"queryCoordinator": true,
"shouldPollFdr": true,
"targetDiskUsagePercentage": 90,
"totalDiskSpaceBytes": 999995129856,
"uuid": "lictrnKsAZ3zMgsd99YhmM4cyErUK98F",
"vhost": 1
}
]
The returned JSON has the following structure:
Table:
Field | Type | Description |
---|---|---|
cores | integer | The number of CPU cores |
diskUsagePercentage | integer | The percentage of diskspace available to LogScale |
displayName | string | The displayed hostname for this node |
humioVersion | string | The LogScale version and build number |
internalHostUri | string | The internal hostname/Uri that identifies this node |
isBeingEvicted | boolean | Indicates if the node is currently being removed from the cluster |
isEphemeral | boolean | Whether the node is ephemeral |
lifecycleState | string | The current status of the node |
minimumCompatibleHumioVersion | integer | The minimum version of LogScale that this release is compatible with |
nodeRoleString | integer | A string denoting the current roles. See Logical Node Roles |
queryCoordinator | boolean | Indicates whether the node is a query coordinator node |
shouldPollFdr | boolean | Indicates whether the node should poll its Falcon Data Replicator feed |
targetDiskUsagePercentage | integer | Indicates the configured target disk usage percentage for this node |
totalDiskSpaceBytes | integer | Shows the current total disk space on this node in bytes |
uuid | string | The Universally unique ID for this node |
vhost | integer | The virtual node ID within the cluster |