API Stability Short-Term

The clusterManagementSettings() GraphQL query is used to return the cluster management settings for a LogScale cluster.

Related to cluster management, see the cluster() query. There are also a few mutation fields related to clusters: createLocalClusterConnection() and updateLocalClusterConnection() for local connections; createRemoteClusterConnection() and updateRemoteClusterConnection() for remote connections; and clusterUnregisterNode() and deleteClusterConnection() removing a node, temporarily and permanently.

For information on managing and monitoring clusters, see the Cluster Management page in the main documentation. You may also want to look at the LogScale Logical Architecture page, which provides graphics and details on how clusters work in LogScale.

Syntax

graphql
clusterManagementSettings: ClusterManagementSettings

There is no input for this query field. There's only parameters for the return datatype, such as replication factors and what else is allowed related to managing the cluster. They're described in the next section.

Example

Below is an example of how you might use this query field:

Raw
graphql
query {
	clusterManagementSettings
  { allowUpdateDesiredDigesters, 
    allowRebalanceExistingSegments,
    segmentReplicationFactor,
    minHostAlivePercentageToEnableClusterRebalancing}
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
	clusterManagementSettings
  { allowUpdateDesiredDigesters, 
    allowRebalanceExistingSegments,
    segmentReplicationFactor,
    minHostAlivePercentageToEnableClusterRebalancing}
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
	clusterManagementSettings
  { allowUpdateDesiredDigesters, 
    allowRebalanceExistingSegments,
    segmentReplicationFactor,
    minHostAlivePercentageToEnableClusterRebalancing}
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
	clusterManagementSettings ^
  { allowUpdateDesiredDigesters,  ^
    allowRebalanceExistingSegments, ^
    segmentReplicationFactor, ^
    minHostAlivePercentageToEnableClusterRebalancing} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
	clusterManagementSettings
  { allowUpdateDesiredDigesters, 
    allowRebalanceExistingSegments,
    segmentReplicationFactor,
    minHostAlivePercentageToEnableClusterRebalancing}
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "query {
	clusterManagementSettings
  { allowUpdateDesiredDigesters, 
    allowRebalanceExistingSegments,
    segmentReplicationFactor,
    minHostAlivePercentageToEnableClusterRebalancing}
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
	clusterManagementSettings
  { allowUpdateDesiredDigesters, 
    allowRebalanceExistingSegments,
    segmentReplicationFactor,
    minHostAlivePercentageToEnableClusterRebalancing}
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "query {
	clusterManagementSettings
  { allowUpdateDesiredDigesters, 
    allowRebalanceExistingSegments,
    segmentReplicationFactor,
    minHostAlivePercentageToEnableClusterRebalancing}
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "clusterManagementSettings": {
      "allowUpdateDesiredDigesters": true,
      "allowRebalanceExistingSegments": true,
      "segmentReplicationFactor": 1,
      "minHostAlivePercentageToEnableClusterRebalancing": 25
    }
  }
}

Returned Datatype

The returned datatype is used to get administrative information on the cluster (e.g., whether digesters may be updated automatically). The return values possible are listed below, along with descriptions of them:

Table: ClusterManagementSettings

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Aug 19, 2025
allowRebalanceExistingSegmentsbooleanyes Short-TermWhether the cluster should allow the moving of existing segments between nodes. This is done generally to achieve a better data distribution.
allowUpdateDesiredDigestersbooleanyes Short-TermWhether or not desired digesters are allowed to be updated automatically.
digestReplicationFactorintegeryes Long-TermThe replication factor for the digesters.
minHostAlivePercentageToEnableClusterRebalancinglongyes Long-TermPercentage of all hosts relevant to a particular cluster rebalance operation that need to be alive before we allow the system to automatically execute the operation. Cluster rebalance operations currently include reassigning digest work, and moving existing segments to balance disk usage. Value is between 0 and 100, both inclusive.
segmentReplicationFactorintegeryes Long-TermThe replication factor for segments.