Endpoint

/v2/cluster/nodes/dry-run

POST

Validate a node-add operation or node replacement step and, if it succeeds, return the projected usable capacity and node fault tolerance level.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_cluster_nodes_modify_request_v2",
  "type": "object",
  "properties": {
    "node_uuids": {
      "type": "array",
      "items": {
        "description": "The UUIDs of the unconfigured nodes to add to the cluster",
        "type": "string"
      }
    },
    "node_ips": {
      "type": "array",
      "items": {
        "description": "The IP addresses of the unconfigured nodes to add to the cluster",
        "type": "string"
      }
    },
    "nodes_to_replace": {
      "type": "array",
      "items": {
        "description": "The configured nodes to replace. Note: These nodes must be a subset of the node replacement plan.",
        "type": "number"
      }
    },
    "target_max_node_failures": {
      "description": "The minimum node-fault-tolerance level for the resulting cluster configuration. Note: In certain cases, a lower node-fault-tolerance level can result in higher usable capacity.",
      "type": "number"
    },
    "target_stripe_config": {
      "description": "The final stripe configuration to use.",
      "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

Schema

{
  "description": "api_cluster_nodes_modify_dry_run_response",
  "type": "object",
  "properties": {
    "current_capacity": {
      "description": "The cluster's current usable capacity (in bytes)",
      "type": "string"
    },
    "current_max_node_failures": {
      "description": "The cluster's current node-fault-tolerance level",
      "type": "number"
    },
    "projected_capacity": {
      "description": "The cluster's usable capacity (in bytes) after the operation",
      "type": "string"
    },
    "projected_max_node_failures": {
      "description": "The cluster's node-fault-tolerance level after the operation",
      "type": "number"
    }
  }
}