clusters_get_kubernetes_partitions {civis}

Describe a Cluster Partition

Description

Describe a Cluster Partition

Usage

clusters_get_kubernetes_partitions(
  id,
  cluster_partition_id,
  include_usage_stats = NULL
)

Arguments

id

integer required. The ID of the cluster which this partition belongs to.

cluster_partition_id

integer required. The ID of this cluster partition.

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:

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, An array containing the following fields:

• instanceConfigId integer, The ID of this InstanceConfig.

• instanceType string, An EC2 instance type. Possible values include t2.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m5.12xlarge, and c5.18xlarge.

• minInstances integer, The minimum number of instances of that type in this cluster.

• maxInstances integer, The maximum number of instances of that type in this cluster.

• instanceMaxMemory integer, The amount of memory (RAM) available to a single instance of that type in megabytes.

• instanceMaxCpu integer, The number of processor shares available to a single instance of that type in millicores.

• instanceMaxDisk integer, The amount of disk available to a single instance of that type in gigabytes.

• usageStats object,

defaultInstanceConfigId

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