Skip to main content

ClusterNodeGroupsListResponse

statusboolean

Whether the request succeeded.

Example: true
messagestring

Human-readable description of the result.

Example: Node groups retrieved successfully
node_groups object[]

Worker-node groups in the cluster.

  • Array [
  • idinteger

    Unique numeric identifier for the node group.

    Example: 4501
    namestring

    Name of the node group.

    Example: default
    rolestring

    Role of the node group.

    Example: worker
    flavor object

    Flavor (hardware configuration) of the nodes in the node group.

    idinteger

    Unique numeric identifier for the flavor.

    Example: 4501
    namestring

    Name of the flavor.

    Example: n1-cpu-small
    cpuinteger

    Number of CPU cores.

    Example: 4
    ramnumber

    Memory allocated to the flavor, in GB.

    Example: 4
    diskinteger

    Root disk capacity, in GB.

    Example: 100
    ephemeralinteger

    Ephemeral disk capacity, in GB. Cleared when the VM is deleted.

    Example: 0
    gpustring

    GPU model name. Empty string if the flavor has no GPU.

    Example:
    gpu_countinteger

    Number of GPUs attached to the flavor.

    Example: 0
    features object

    Feature flags for the flavor, such as high-speed networking and hibernation or snapshot restrictions.

    object
    labels object[]

    Labels associated with the flavor.

  • Array [
  • idinteger

    Unique numeric identifier for the label.

    labelstring

    The label name.

  • ]
  • countinteger

    Number of nodes in the node group.

    Example: 1
    min_countinteger

    Minimum number of nodes the group will scale down to.

    Example: 1
    max_countinteger

    Maximum number of nodes the group will scale up to.

    Example: 1
    firewall_idsinteger[]

    Identifiers of the firewalls attached to the nodes in the node group.

    firewalls object[]

    Firewalls attached to the nodes in the node group.

  • Array [
  • idinteger

    Unique numeric identifier for the firewall.

    namestring

    Name of the firewall.

    statusstring

    Current status of the firewall.

  • ]
  • created_atstring<date-time>

    ISO 8601 UTC timestamp marking when the node group was created.

    Example: 2026-05-07T09:21:55Z
    updated_atstring<date-time>

    ISO 8601 UTC timestamp marking when the node group was last updated.

    Example: 2026-05-07T09:21:55Z
  • ]
  • ClusterNodeGroupsListResponse
    {
    "status": true,
    "message": "Node groups retrieved successfully",
    "node_groups": [
    {
    "id": 4501,
    "name": "default",
    "role": "worker",
    "flavor": {
    "id": 4501,
    "name": "n1-cpu-small",
    "cpu": 4,
    "ram": 4,
    "disk": 100,
    "ephemeral": 0,
    "gpu": "",
    "gpu_count": 0,
    "features": {},
    "labels": [
    {
    "id": 0,
    "label": "string"
    }
    ]
    },
    "count": 1,
    "min_count": 1,
    "max_count": 1,
    "firewall_ids": [
    0
    ],
    "firewalls": [
    {
    "id": 0,
    "name": "string",
    "status": "string"
    }
    ],
    "created_at": "2026-05-07T09:21:55Z",
    "updated_at": "2026-05-07T09:21:55Z"
    }
    ]
    }