Get cluster detail

GET 
/backend/api/cluster/:cluster_id/

Host: https://core.ocplanet.cloud

Get cluster detail.

Request

Responses

200

application/json

Schema

Schema

cluster_name stringrequired
cluster_version stringrequired
node_pools object[]required
Array [
id string
name string
flavor_id string
count integer
autoscale boolean
max_count integernull
is_default boolean
labels object[]
Array [
key stringrequired
values stringrequired
]
taints object[]
Array [
key stringrequired
value stringrequired
effect NoSchedule | PreferNoSchedule | NoExecuterequired
]
nodes object[]
Array [
id uuid
name string
ready boolean
state string
flavor string
version string
node_pool string
control_plane boolean
]
]
id uuidrequired
status string
status_reason nullstring
api_address string
create_at string
updated_at string
restriction_api boolean
restriction_ips string
control_nodes object
id uuid
name string
ready boolean
state string
flavor string
version string
node_pool string
control_plane boolean

Example (from schema)

{
  "cluster_name": "string",
  "cluster_version": "string",
  "node_pools": [
    {
      "id": "string",
      "name": "string",
      "flavor_id": "string",
      "count": 0,
      "autoscale": true,
      "is_default": true,
      "labels": [
        {
          "key": "string",
          "values": "string"
        }
      ],
      "taints": [
        {
          "key": "string",
          "value": "string",
          "effect": "string"
        }
      ],
      "nodes": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "ready": true,
          "state": "string",
          "flavor": "string",
          "version": "string",
          "node_pool": "string",
          "control_plane": true
        }
      ]
    }
  ],
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "string",
  "api_address": "string",
  "create_at": "string",
  "updated_at": "string",
  "restriction_api": true,
  "restriction_ips": "string",
  "control_nodes": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "ready": true,
    "state": "string",
    "flavor": "string",
    "version": "string",
    "node_pool": "string",
    "control_plane": true
  }
}

Example

{
  "id": "5833f953-b236-45dc-b78e-9d8a11157fec",
  "cluster_name": "cluster25379",
  "cluster_version": "v1.28.6",
  "status": "active",
  "status_reason": null,
  "api_address": "217.147.172.152:6443",
  "created_at": "2024-03-25T07:58:55.064790Z",
  "updated_at": "2024-03-25T08:23:23.016427Z",
  "control_nodes": [
    {
      "id": "3ac8320a-04aa-46bc-a665-379f14b2c5a2",
      "name": "cluster25379-control-plane-wvhmv",
      "ready": true,
      "state": "ACTIVE",
      "flavor": "v1.m4",
      "version": "v1.28.6",
      "node_pool": null,
      "control_plane": true
    }
  ],
  "node_pools": [
    {
      "id": "c361737b-4e32-417f-880f-ea9d26a75750",
      "name": "cluster25379-nodepool19901",
      "flavor": "v1.m8",
      "count": 1,
      "autoscale": false,
      "max_count": null,
      "is_default": false,
      "status": "active",
      "labels": [],
      "taints": [],
      "nodes": [
        {
          "id": "105eb2d6-07c2-4014-9133-3bfa693292a1",
          "name": "cluster25379-nodepool19901-sz87v",
          "ready": true,
          "state": "ACTIVE",
          "flavor": "v1.m8",
          "version": "v1.28.6",
          "node_pool": "cluster25379-nodepool19901",
          "control_plane": false
        }
      ]
    }
  ],
  "restriction_api": false,
  "restriction_ips": null
}

Loading...