Endpoint

/v1/cluster/node-replacement-plan/

GET

Get the current node replacement plan. This plan lists the nodes pending replacement and nodes currently in process of being replaced.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_node_replacement_plan",
  "type": "object",
  "properties": {
    "nodes_to_be_replaced": {
      "type": "array",
      "items": {
        "description": "Nodes selected for replacement.",
        "type": "number"
      }
    },
    "nodes_currently_being_replaced": {
      "type": "array",
      "items": {
        "description": "Nodes currently in process of being replaced.",
        "type": "number"
      }
    },
    "target_stripe_config": {
      "description": "The target EC stripe config. If this value is empty, it indicates that the cluster's stripe config will remain unchanged throughout the node replacement.",
      "type": "object",
      "properties": {
        "blocks_per_stripe": {
          "description": "Number of blocks per EC stripe including parity.",
          "type": "number"
        },
        "data_blocks_per_stripe": {
          "description": "The number of data blocks per stripe.",
          "type": "number"
        }
      }
    }
  }
}

POST

To initiate node replacement, specify the nodes to replace.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_cluster_node_replacement_request",
  "type": "object",
  "properties": {
    "nodes_to_be_replaced": {
      "type": "array",
      "items": {
        "description": "Nodes selected for replacement.",
        "type": "number"
      }
    },
    "target_stripe_config": {
      "description": "The optional target EC stripe config.",
      "type": "object",
      "properties": {
        "blocks_per_stripe": {
          "description": "Number of blocks per EC stripe including parity.",
          "type": "number"
        },
        "data_blocks_per_stripe": {
          "description": "The number of data blocks per stripe.",
          "type": "number"
        }
      }
    }
  }
}

Response

Codes

Code Description
200 Return value on success