# List node types

Launch stage: GA

`GET /api/2.1/clusters/list-node-types`

Returns a list of supported Spark node types. These node types can be used to launch a cluster.

API scopes: clusters

## Returns

- `node_types` (array of object, optional)
  The list of available Spark node types.
  - `node_type_id` (string, required)
    Unique identifier for this node type.
  - `memory_mb` (int32, required)
    Memory (in MB) available for this node type.
  - `num_cores` (float, double, required)
    Number of CPU cores available for this node type.
     Note that this can be fractional, e.g., 2.5 cores, if the number of cores on a
     machine instance is not divisible by the number of Spark nodes on that machine.
  - `description` (string, required)
    A string description associated with this node type, e.g., "r3.xlarge".
  - `instance_type_id` (string, required)
    An identifier for the type of hardware that this node runs on, e.g., "r3.2xlarge" in AWS.
  - `is_deprecated` (boolean, optional)
    Whether the node type is deprecated. Non-deprecated node types offer greater performance.
    Default: `false`
  - `category` (string, required)
    A descriptive category for this node type. Examples include "Memory Optimized" and
     "Compute Optimized".
  - `support_ebs_volumes` (boolean, optional)
    Whether this node type support EBS volumes. EBS volumes is disabled for node types that
     we could place multiple corresponding containers on the same hosting instance.
    Default: `true`
  - `support_cluster_tags` (boolean, optional)
    Whether this node type support cluster tags.
    Default: `true`
  - `num_gpus` (int32, optional)
    Number of GPUs available for this node type.
  - `node_instance_type` (object, optional)
    The NodeInstanceType object corresponding to instance_type_id
    - `instance_type_id` (string, required)
      Unique identifier across instance types
    - `local_disks` (int32, optional)
      Number of local disks that are present on this instance.
    - `local_disk_size_gb` (int32, optional)
      Size of the individual local disks attached to this instance (i.e. per local disk).
    - `local_nvme_disk_size_gb` (int32, optional)
      Size of the individual local nvme disks attached to this instance (i.e. per local disk).
    - `local_nvme_disks` (int32, optional)
      Number of local nvme disks that are present on this instance.
  - `is_hidden` (boolean, optional)
    Whether this node is hidden from presentation in the UI.
  - `support_port_forwarding` (boolean, optional)
    Whether this node type supports port forwarding.
    Default: `true`
  - `display_order` (int32, optional)
    An optional hint at the display order of node types in the UI.
     Within a node type category, lowest numbers come first.
    Default: `0`
  - `is_io_cache_enabled` (boolean, optional)
    Whether this node comes with IO cache enabled by default.
    Default: `false`
  - `node_info` (object, optional)
    A collection of node type info reported by the cloud provider
    - `status` (array of string, optional)
      Status as reported by the cloud provider
      Possible values:
      - `NotEnabledOnSubscription`
      - `NotAvailableInRegion`
  - `photon_worker_capable` (boolean, optional)
    Default: `false`
  - `photon_driver_capable` (boolean, optional)
    Default: `false`
  - `is_encrypted_in_transit` (boolean, optional)
    AWS specific, whether this instance supports encryption in transit, used for hipaa and pci
     workloads.
    Default: `false`
  - `is_graviton` (boolean, optional)
    Whether this is an Arm-based instance.
    Default: `false`

## Response

```json
{
  "node_types": [
    {
      "category": "Memory Optimized",
      "description": "r4.xlarge",
      "display_order": 0,
      "instance_type_id": "r4.xlarge",
      "is_deprecated": false,
      "is_hidden": false,
      "is_io_cache_enabled": false,
      "memory_mb": 31232,
      "node_instance_type": {
        "instance_family": "EC2 r4 Family vCPUs",
        "instance_type_id": "r4.xlarge",
        "local_disk_size_gb": 0,
        "local_disks": 0,
        "swap_size": "10g"
      },
      "node_type_id": "r4.xlarge",
      "num_cores": 4,
      "num_gpus": 0,
      "support_cluster_tags": true,
      "support_ebs_volumes": true,
      "support_port_forwarding": true,
      "supports_elastic_disk": true
    }
  ]
}
```