Endpoint

/v1/cluster/calculate-node-add-capacity

POST

Calculate changes to cluster usable capacity from a proposed node-add operation. This endpoint is deprecated in favor of /v2/cluster/nodes/dry-run.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_cluster_calculate_node_add_capacity_request",
  "type": "object",
  "properties": {
    "node_uuids": {
      "type": "array",
      "items": {
        "description": "Identifiers of nodes to add to existing cluster",
        "type": "string"
      }
    },
    "node_ips": {
      "type": "array",
      "items": {
        "description": "IP addresses of nodes to add to existing cluster",
        "type": "string"
      }
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_cluster_calculate_node_add_capacity_response",
  "type": "object",
  "properties": {
    "new_usable_capacity_in_bytes": {
      "description": "The cluster's usable capacity (in bytes) after node-add operations",
      "type": "string"
    },
    "increase_from_current_usable_capacity_in_bytes": {
      "description": "The increase of the cluster's usable capacity (in bytes) after node-add operations",
      "type": "string"
    },
    "max_node_failures": {
      "description": "The maximum number of tolerable cluster node failures after node-add operations",
      "type": "number"
    },
    "node_add_capacity_optimized_for_fault_tolerance": {
      "description": "This field is only populated if it is possible to optimize the cluster for increased node fault tolerance instead of usable capacity during node-add operations. When populated, it shows the usable cluster capacity and node fault tolerance for the optimized cluster.",
      "type": "object",
      "properties": {
        "new_usable_capacity_in_bytes": {
          "description": "The cluster's usable capacity (in bytes) after node-add operations and optimization for increased node fault tolerance",
          "type": "string"
        },
        "increase_from_current_usable_capacity_in_bytes": {
          "description": "The increase of the cluster's usable capacity (in bytes) after node-add operations and optimization for increased node fault tolerance",
          "type": "string"
        },
        "max_node_failures": {
          "description": "The maximum number of tolerable cluster node failures after node-add operations and optimization for increased node fault tolerance",
          "type": "number"
        }
      }
    }
  }
}