Summary

The setIsBeingEvicted() mutation sets the eviction flag for a specified cluster node. When you set the flag to true, the cluster moves data and workloads away from that node in preparation for its removal. Use this mutation when decommissioning a node or performing maintenance that requires draining cluster activity from a host. To check current eviction status across all nodes, use the cluster() query.

API Stability Short-Term

Syntax

graphql
setIsBeingEvicted(
      vhost: Int!, isBeingEvicted: Boolean!
   ): Boolean!

Both arguments are required. Provide the integer ID of the target node in vhost and set isBeingEvicted to true to begin eviction preparation or false to cancel it. The mutation returns a non-null Boolean! confirming whether the operation succeeded.

Example

Raw
graphql
mutation {
  setIsBeingEvicted(
      vhost: 1,
      isBeingEvicted: true
  )
}
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 {
  setIsBeingEvicted(
      vhost: 1,
      isBeingEvicted: true
  )
}"
}
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 {
  setIsBeingEvicted(
      vhost: 1,
      isBeingEvicted: true
  )
}"
}
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 { ^
  setIsBeingEvicted( ^
      vhost: 1, ^
      isBeingEvicted: true ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setIsBeingEvicted(
      vhost: 1,
      isBeingEvicted: true
  )
}"
}'
    "$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 {
  setIsBeingEvicted(
      vhost: 1,
      isBeingEvicted: true
  )
}";
$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 {
  setIsBeingEvicted(
      vhost: 1,
      isBeingEvicted: true
  )
}"
}'''

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 {
  setIsBeingEvicted(
      vhost: 1,
      isBeingEvicted: true
  )
}"
}
);


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": {
    "setIsBeingEvicted": true
  }
}

Input Parameters

Both input parameters are required. Provide the node ID and the desired eviction state.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
isBeingEvicted Boolean! yes   Eviction flag for the node. Set to true to prepare the node for eviction; the cluster migrates data and workloads away from it. Set to false to cancel eviction preparation.
vhost Int! yes   Integer ID of the cluster node to set the eviction flag for. Retrieve node IDs from the cluster() query.