client.clusters.get_kubernetes_instance_configs

A method of the Clusters endpoint.

get_kubernetes_instance_configs(instance_config_id: int, *, include_usage_stats: bool = None) → Response

Describe an Instance Config

API URL: GET /clusters/kubernetes/instance_configs/{instance_config_id}

import civis
client = civis.APIClient()
response = client.clusters.get_kubernetes_instance_configs(...)

Parameters:

instance_config_idint

The ID of this instance config.

include_usage_statsbool, optional

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

Returns:

civis.Response

• instance_config_idint

  The ID of this InstanceConfig.

• instance_typestr

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

• min_instancesint

  The minimum number of instances of that type in this cluster.

• max_instancesint

  The maximum number of instances of that type in this cluster.

• instance_max_memoryint

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

• instance_max_cpuint

  The number of processor shares available to a single instance of that type in millicores.

• instance_max_diskint

  The amount of disk available to a single instance of that type in gigabytes.

• usage_statscivis.Response

  • pending_memory_requestedint

    The sum of memory requests (in MB) for pending deployments in this instance config.

  • pending_cpu_requestedint

    The sum of cpu requests (in millicores) for pending deployments in this instance config.

  • running_memory_requestedint

    The sum of memory requests (in MB) for running deployments in this instance config.

  • running_cpu_requestedint

    The sum of cpu requests (in millicores) for running deployments in this instance config.

  • pending_deploymentsint

    The number of pending deployments in this instance config.

  • running_deploymentsint

    The number of running deployments in this instance config.

• cluster_partition_idint

  The ID of this InstanceConfig’s cluster partition

• cluster_partition_namestr

  The name of this InstanceConfig’s cluster partition