Skip to main content
GET
/
cloud
/
v2
/
k8s
/
clusters
/
{project_id}
/
{region_id}
/
{cluster_name}
/
pools
/
{pool_name}
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
k8s_cluster_pool = client.cloud.k8s.clusters.pools.get(
    pool_name="pool_name",
    project_id=0,
    region_id=0,
    cluster_name="cluster_name",
)
print(k8s_cluster_pool.id)
{
  "auto_healing_enabled": true,
  "boot_volume_size": 123,
  "boot_volume_type": "<string>",
  "created_at": "<string>",
  "crio_config": {},
  "flavor_id": "<string>",
  "id": "<string>",
  "is_public_ipv4": true,
  "kubelet_config": {},
  "labels": {},
  "max_node_count": 123,
  "min_node_count": 123,
  "name": "<string>",
  "node_count": 123,
  "status": "<string>",
  "taints": {},
  "servergroup_id": "",
  "servergroup_name": "",
  "servergroup_policy": ""
}

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id
integer
required

Project identifier

region_id
integer
required

Region identifier

cluster_name
string
required

Cluster name

pool_name
string
required

Pool name

Response

Pool details

auto_healing_enabled
boolean
required

Indicates the status of auto healing

Example:

true

boot_volume_size
integer
required

Size of the boot volume

Example:

50

boot_volume_type
string
required

Type of the boot volume

Example:

"ssd_hiiops"

created_at
string
required

Date of function creation

Example:

"2023-02-15T11:53:03+03:00"

crio_config
Crio Config · object
required

Crio configuration for pool nodes

Example:
{ "default-ulimits": "nofile=1024:2048" }
flavor_id
string
required

ID of the cluster pool flavor

Example:

"g1-standard-1-2"

id
string
required

UUID of the cluster pool

Example:

"f01fd9a0-9548-48ba-82dc-a8c8b2d6f2f1"

is_public_ipv4
boolean
required

Indicates if the pool is public

Example:

true

kubelet_config
Kubelet Config · object
required

Kubelet configuration for pool nodes

Example:
{ "podMaxPids": "4096" }
labels
Labels · object
required

Labels applied to the cluster pool

Example:
{ "my-label": "foo" }
max_node_count
integer
required

Maximum node count in the cluster pool

Example:

10

min_node_count
integer
required

Minimum node count in the cluster pool

Example:

1

name
string
required

Name of the cluster pool

Example:

"test"

node_count
integer
required

Node count in the cluster pool

Example:

2

status
string
required

Status of the cluster pool

Example:

"Running"

taints
Taints · object
required

Taints applied to the cluster pool

Example:
{ "my-taint": "bar:NoSchedule" }
servergroup_id
string
default:""

Server group ID

Example:

"1772de21-f013-4b70-9f8f-a518985b3bc2"

servergroup_name
string
default:""

Server group name

Example:

"my-server-group"

servergroup_policy
string
default:""

Anti-affinity, affinity or soft-anti-affinity server group policy

Example:

"anti-affinity"