API Stability Preview

The refreshClusterManagementStats() GraphQL mutation may be used to force a refresh of the ClusterManagementStats cache and return reasonsNodeCannotBeSafelyUnregistered for the specified node.

When developing scripts to automate the unregistration of multiple evicted nodes at a time, this mutation can be called to validate that the node being unregistered can be terminated without risking data loss. As the mutation is expensive, it should not be called frequently.

Syntax

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

graphql
refreshClusterManagementStats(
      nodeId: integer!
   ): RefreshClusterManagementStatsMutation!

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

Show:
graphql
mutation {
  refreshClusterManagementStats( nodeId: 3 )
    { reasonsNodeCannotBeSafelyUnregistered { isAlive, hasUnderReplicatedData } }
}

Returned Data Types

For RefreshClusterManagementStatsMutation), there is one parameter, but it has a few sub-parameters. A link to a table with those sub-parameters is in the description field here.

Table: RefreshClusterManagementStatsMutation

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 23, 2024
reasonsNodeCannotBeSafelyUnregisteredreasonsNodeCannotBeSafelyUnregisteredyes PreviewThe reasons the node cannot be safely unregistered. See reasonsNodeCannotBeSafelyUnregistered.