API Stability Short-Term

The setIsBeingEvicted() GraphQL mutation is used to toggle whether the specified host should be prepared for eviction from the cluster. If preparing for eviction, the cluster will attempt to move data and work away from the host.

Syntax

Below is the syntax for the setIsBeingEvicted() mutation field:

graphql
setIsBeingEvicted(
      vhost: integer!, 
      isBeingEvicted: boolean!
   ): boolean!

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

Show:
graphql
mutation {
  setIsBeingEvicted(
      vhost: 1,
      isBeingEvicted: true
  )
}
Example Responses
Show:
json
{
  "data": {
    "setIsBeingEvicted": true
  }
}

There are no special datatypes for this mutation field.