Get

/computeclusters/

This endpoint lists VAST Compute Clusters

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Responses

200

Compute Cluster information

Array of object

object

Compute cluster object returned when listing VAST compute clusters.

id

integer

The unique identifier for the VAST compute cluster on the specific VAST cluster to which the compute cluster belongs.

guid

string

The globally unique identifier for the VAST compute cluster across all VAST clusters.

name

string

The name of the VAST compute cluster

root_certificate

string

RKE2 root certificate. If omitted, certificates will be generated automatically. Must be provided together with intermediate_certificate and intermediate_key.

intermediate_certificate

string

RKE2 intermediate certificate. If omitted, certificates will be generated automatically. Must be provided together with root_certificate and intermediate_key.

intermediate_key

string

RKE2 intermediate private key. If omitted, certificates will be generated automatically. Must be provided together with root_certificate and intermediate_certificate.

static_ip_ranges

Array of array

List of IP range pairs [[start1, end1], [start2, end2]] for static IP assignment to CNodes. Must provide enough IPs for all CNodes.

Array of string

Min items2

Max items2

Example[ "10.0.0.10", "10.0.0.20" ]

string

netmask

string

Network mask for the compute cluster network (e.g., "255.255.255.0" or "24")

default_gateway

string

Default gateway IP address for the compute cluster network (e.g., "10.0.0.1"). Optional.

vlan

integer

VLAN ID for the compute cluster network (1-4095). Optional; omit or set to null to disable.

Minimum1

Maximum4095

cluster_cidr

string

Kubernetes cluster CIDR for pod networking (default is "10.64.0.0/12")

Default"10.64.0.0/12"

service_cidr

string

Kubernetes service CIDR for service networking (default is "10.80.0.0/12")

Default"10.80.0.0/12"

server_kube_vip_address

string

Kubernetes VIP address for the API server

state

string

Current state of the compute cluster

Valid values[ "CREATING", "UPDATING", "DELETING", "STARTING", "STOPPED", "RUNNING", "STOPPING", "ERROR", "DEGRADED", "PARTIALLY_PROVISIONED" ]

resource_counts

object

Resource counts with state-based breakdowns for this cluster

cnodes

object (ComputeClusterCNodeCountsPerState)

Example{ "total": 50, "ready": 45, "disk_pressure": 2, "memory_pressure": 1, "pid_pressure": 0, "network_unavailable": 2 }

property*

integer additionalProperties

Valid values[ total, ready, disk_pressure, memory_pressure, pid_pressure, network_unavailable ]

pods

object (ComputeClusterPodCountsPerState)

Example{ "total": 200, "running": 180, "pending": 10, "succeeded": 5, "failed": 3, "unknown": 2 }

property*

integer additionalProperties

Valid values[ total, failed, running, pending, succeeded, unknown ]

deployments

object (ComputeClusterDeploymentCountsPerState)

Example{ "total": 50, "running": 45, "degraded": 3, "error": 2 }

property*

integer additionalProperties

Valid values[ total, running, degraded, error ]

service_counts

integer

Total number of services on the compute cluster

namespace_counts

integer

Total number of namespaces on the compute cluster

tenant_counts

integer

Total number of tenants attached to the compute cluster

backup_frequency

integer

Backup frequency in minutes for the compute cluster. This is an automated schedule that dictates how often the compute cluster's state and persistent data is backed up.

Default60

description

string

User-defined description for the compute cluster

tags

Array of string

User-defined tags for the compute cluster

Max items64

string

Max length40

all_tenants

boolean

When true, all existing and newly created tenants are automatically assigned to this compute cluster

Defaultfalse

Get all existing Compute Clusters