clusters_get_kubernetes_instance_configs: Describe an Instance Config

In civis: R Client for the 'Civis Platform API'

Describe an Instance Config

Description

Describe an Instance Config

Usage

clusters_get_kubernetes_instance_configs(
  instance_config_id,
  include_usage_stats = NULL
)

Arguments

instance_config_id	integer required. The ID of this instance config.
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:

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, c5.18xlarge, and g6.2xlarge.
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	list, A list containing the following elements: pendingMemoryRequested integer, The sum of memory requests (in MB) for pending deployments in this instance config. pendingCpuRequested integer, The sum of cpu requests (in millicores) for pending deployments in this instance config. runningMemoryRequested integer, The sum of memory requests (in MB) for running deployments in this instance config. runningCpuRequested integer, The sum of cpu requests (in millicores) for running deployments in this instance config. pendingDeployments integer, The number of pending deployments in this instance config. runningDeployments integer, The number of running deployments in this instance config.
clusterPartitionId	integer, The ID of this InstanceConfig's cluster partition
clusterPartitionName	string, The name of this InstanceConfig's cluster partition

civis documentation built on Aug. 30, 2025, 1:08 a.m.