clusters_get_kubernetes {civis}

Describe a Kubernetes Cluster

Description

Describe a Kubernetes Cluster

Usage

clusters_get_kubernetes(id, include_usage_stats = NULL)

Arguments

id

integer required.

include_usage_stats

boolean optional. When true, usage stats are returned in instance config objects. Defaults to false.

Value

A list containing the following elements:

id

integer, The ID of this cluster.

organizationId

string, The id of this cluster's organization.

organizationName

string, The name of this cluster's organization.

organizationSlug

string, The slug of this cluster's organization.

rawClusterSlug

string, The slug of this cluster's raw configuration.

customPartitions

boolean, Whether this cluster has a custom partition configuration.

clusterPartitions

array, An array containing the following fields:

• clusterPartitionId integer, The ID of this cluster partition.

• name string, The name of the cluster partition.

• labels array, Labels associated with this partition.

• instanceConfigs array, The instances configured for this cluster partition.

• defaultInstanceConfigId integer, The id of the InstanceConfig that is the default for this partition.

isNatEnabled

boolean, Whether this cluster needs a NAT gateway or not.

hours

number, The number of hours used this month for this cluster.