API Stability Long-Term

The clusterUnregisterNode() GraphQL mutation may be used to unregister a node from a cluster.

For information on clusters, see the Cluster Management documentation page. You may also want to look at the LogScale Logical Architecture page in the Training section.

Syntax

graphql
clusterUnregisterNode(
      force: boolean!,
      nodeID: integer!
   ): UnregisterNodeMutation!

The force is given with a value of true, along with nodeID and its unique identifier to force the removal of a node.

There are no special input datatypes for this mutation field.

Example

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  clusterUnregisterNode(
         nodeID: 2,
         force: false ) 
  { cluster { nodes { id, name } } }
}
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" : "mutation {
  clusterUnregisterNode(
         nodeID: 2,
         force: false ) 
  { cluster { nodes { id, name } } }
}"
}
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" : "mutation {
  clusterUnregisterNode(
         nodeID: 2,
         force: false ) 
  { cluster { nodes { id, name } } }
}"
}
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" : "mutation { ^
  clusterUnregisterNode( ^
         nodeID: 2, ^
         force: false )  ^
  { cluster { nodes { id, name } } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  clusterUnregisterNode(
         nodeID: 2,
         force: false ) 
  { cluster { nodes { id, name } } }
}"
}'
    "$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 = "mutation {
  clusterUnregisterNode(
         nodeID: 2,
         force: false ) 
  { cluster { nodes { id, name } } }
}";
$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" : "mutation {
  clusterUnregisterNode(
         nodeID: 2,
         force: false ) 
  { cluster { nodes { id, name } } }
}"
}'''

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" : "mutation {
  clusterUnregisterNode(
         nodeID: 2,
         force: false ) 
  { cluster { nodes { id, name } } }
}"
}
);


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": {
    "clusterUnregisterNode": {
      "cluster": {
        "nodes": [
          {
            "id": 1,
            "name": "humio-cluster-node1:8080"
          }
        ]
      }
    }
  }
}

Returned Datatype

With the returned datatype, by way of sub-parameters, you can get information on the cluster and on the individual nodes: the unique identifiers and names of all nodes in the cluster — which you can use with other query and mutation fields to learn more about a specific node, as well as make changes. To see all of your choices, click on the link for that sub-datatype in the table below:

Table: UnregisterNodeMutation

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: Oct 4, 2024
clusterClusteryes Long-TermThe node to unregister from the cluster. See Cluster.