client.clusters.get_kubernetes

A method of the Clusters endpoint.

get_kubernetes(id: int, *, include_usage_stats: bool = None) → Response

Describe a Kubernetes Cluster

API URL: GET /clusters/kubernetes/{id}

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

Parameters:

idint

include_usage_statsbool, optional

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

Returns:

civis.Response

• idint

  The ID of this cluster.

• organization_idstr

  The id of this cluster’s organization.

• organization_namestr

  The name of this cluster’s organization.

• organization_slugstr

  The slug of this cluster’s organization.

• raw_cluster_slugstr

  The slug of this cluster’s raw configuration.

• custom_partitionsbool

  Whether this cluster has a custom partition configuration.

• cluster_partitionsList[civis.Response]

  List of cluster partitions associated with this cluster.

  • cluster_partition_idint

    The ID of this cluster partition.

  • namestr

    The name of the cluster partition.

  • labelsList[str]

    Labels associated with this partition.

  • instance_configsList[civis.Response]

    The instances configured for this cluster partition.

    • 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.

  • default_instance_config_idint

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

• is_nat_enabledbool

  Whether this cluster needs a NAT gateway or not.

• hoursfloat (float)

  The number of hours used this month for this cluster.