Get Kubernetes Cluster Details

GET

/api/v1/kubernetes/{service_id}

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/kubernetes/{service_id}?project_id=<PROJECT_ID>&apikey=<API_KEY>&location=<LOCATION>' \
  --header 'Authorization: Bearer <API_TOKEN>'

import requests

response = requests.get(
    "https://api.e2enetworks.com/myaccount/api/v1/kubernetes/{service_id}",
    params={"project_id": "<PROJECT_ID>", "apikey": "<API_KEY>", "location": "<LOCATION>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
print(response.json())

const url = new URL("https://api.e2enetworks.com/myaccount/api/v1/kubernetes/{service_id}");
url.search = new URLSearchParams({ project_id: "<PROJECT_ID>", apikey: "<API_KEY>", location: "<LOCATION>" });

const response = await fetch(url, {
  method: "GET",
  headers: { "Authorization": "Bearer <API_TOKEN>" },
});
console.log(await response.json());

Returns the full configuration of a single cluster, including its master role and node id list, state, Kubernetes version, encryption flag, the committed-pricing options, and every worker node_pools entry with its elasticity/scheduled policy detail, plan, and member node names. Use the cluster service_id returned by List.

Parameters

Path Parameters

service_id

required

integer

The service_id of the cluster, as returned by List.

Example

Query Parameters

project_id

required

integer

Identifier of the project to scope the request to. Required integer project ID.

Example

<PROJECT_ID>

apikey

required

string

API key used to authenticate the request.

Example

<API_KEY>

location

required

string

Region of the cluster.

Example

<LOCATION>

Responses

200

Successful response

application/json

object

code

integer

data

A single-element list holding the cluster detail.

Array<object>

object

service_id

integer

service_name

string

roles

Array<object>

object

role_name

string

cardinality

integer

state

string

node_id_list

Array<integer>

state

string

version

string

master_node_id

integer

cluster_id

integer

isEncryptionEnabled

boolean

node_pools

Worker node pools of the cluster.

Array<object>

object

name

string

slug_name

string

sku_id

integer

policy_type

string

vcpu

integer

ram

integer

worker_node_count

integer

node_names

Array<string>

no_of_nodes

integer

master_pool

object

name

string

plan_name

string

vcpu

integer

ram

integer

state

string

errors

object

message

string

Example

{
  "code": 200,
  "data": [
    {
      "service_id": 12345,
      "service_name": "my-k8s-cluster",
      "roles": [
        {
          "role_name": "master",
          "cardinality": 1,
          "state": "Running",
          "node_id_list": [
            320001
          ]
        }
      ],
      "state": "Running",
      "version": "1.32",
      "master_node_id": 320000,
      "cluster_id": 10001,
      "isEncryptionEnabled": true,
      "node_pools": [
        {
          "name": "pool-worker-1",
          "slug_name": "C3-4vCPU-8RAM-100DISK-C3.96GB - CentOS-Stream-Delhi",
          "sku_id": 1088,
          "policy_type": "Default-Scheduled",
          "vcpu": 4,
          "ram": 8,
          "worker_node_count": 3,
          "node_names": [
            "worker_0_service_12346",
            "worker_1_service_12346",
            "worker_2_service_12346"
          ]
        }
      ],
      "no_of_nodes": 7,
      "master_pool": {
        "name": "master-pool",
        "plan_name": "E2E-K8s-Cluster",
        "vcpu": 4,
        "ram": 8,
        "state": "Running"
      }
    }
  ],
  "message": "Success"
}