Endpoint

/v3/cluster/calculate-supported-protection-info

POST

Returns list of supported data protection stripe configuration(s). This includes the stripe width and usable capacity using that width. For use with unconfigured nodes only.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_supported_protection_info_request_v2",
  "type": "object",
  "properties": {
    "node_uuids": {
      "type": "array",
      "items": {
        "description": "List of unconfigured node UUIDs to query supported protection levels and capacities",
        "type": "string"
      }
    },
    "node_ips": {
      "type": "array",
      "items": {
        "description": "List of unconfigured node IPs to query supported protection levels and capacities",
        "type": "string"
      }
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_supported_protection_configs",
  "type": "object",
  "properties": {
    "supported_configs": {
      "type": "array",
      "items": {
        "description": "Vector of supported protection configurations",
        "type": "object",
        "properties": {
          "blocks_per_stripe": {
            "description": "Number of blocks per stripe for this stripe config",
            "type": "number"
          },
          "max_drive_failures": {
            "description": "Number of simultaneous drive failures supported for this stripe config",
            "type": "number"
          },
          "max_node_failures": {
            "description": "Number of simultaneous node failures supported for this stripe config",
            "type": "number"
          },
          "max_cluster_node_count": {
            "description": "The max amount of nodes supported to guarantee data safety with this stripe config",
            "type": "number"
          },
          "usable_capacity_in_bytes": {
            "description": "The usable capacity in bytes if the node/SKU configuration uses this stripe config",
            "type": "string"
          }
        }
      }
    }
  }
}