Get cluster details

Get cluster details

Get the cluster details.

GET/v1/clusters/{clusterId}

Path parameters

clusterId*string

Response

200

OK

Body

*/*

apiUrlstring

Example: "https://0.0.0.0:0"

authTypestring

authentication type(TOKEN, CERT, PLAIN)

Example: "CERT"

clusterIdstring

Example: "thingcluster"

clusterNamestring

Example: "devops cluster"

clusterSeqinteger

Example: 1

clusterStatestring

clusterState(RUNNING, STOPPED)

Example: "RUNNING"

countOfNamespaceinteger

Example: 22

countOfNodeinteger

Example: 7

countOfStaticVolumeinteger

Example: 0

countOfStorageClassinteger

Example: 2

countOfVolumeinteger

Example: 48

createdstring

Creation date/time

Example: "2022-12-16 08:16:50"

cubeTypestring

Cube cluster type(ECS, EKS, ACS, AKS, GKE, TKE, OCP, OKE, MANAGED, PROVIDER)

Example: "MANAGED"

descriptionstring

Example: ""

ingressSupportedstring

Ingress support availability(Y: Allowed, N: Not allowed)

Example: "Y"

k8sVersionstring

Example: "1.23.14"

loadbalancerSupportedstring

Load balancer support availability(Y: Allowed, N: Not allowed)

Example: "Y"

nodePortRangestring

Node port range(required if supporting node ports)

Example: "30000-32767"

nodePortSupportedstring

Node port support availability(Y: Allowed, N: Not allowed)

Example: "Y"

nodePortUrlstring

Example: "0.0.0.0"

persistentVolumeSupportedstring

Volume request support availability(Y: Allowed, N: Not allowed)

Example: "Y"

providerAccountProviderAccount (object)

regionCodestring

Example: "KR"

updatedstring

Modification time

Example: "2023-06-13 09:34:39"

useYnstring

Availability(Y: Allowed, N: Not allowed)

Example: "Y"

Request

JavaScriptCurlPython

const response = await fetch('/v1/clusters/{clusterId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "apiUrl": "https://0.0.0.0:0",
  "authType": "CERT",
  "clusterId": "thingcluster",
  "clusterName": "devops cluster",
  "clusterSeq": 1,
  "clusterState": "RUNNING",
  "countOfNamespace": 22,
  "countOfNode": 7,
  "countOfStaticVolume": 0,
  "countOfStorageClass": 2,
  "countOfVolume": 48,
  "created": "2022-12-16 08:16:50",
  "cubeType": "MANAGED",
  "description": "",
  "ingressSupported": "Y",
  "k8sVersion": "1.23.14",
  "loadbalancerSupported": "Y",
  "nodePortRange": "30000-32767",
  "nodePortSupported": "Y",
  "nodePortUrl": "0.0.0.0",
  "persistentVolumeSupported": "Y",
  "providerAccount": {
    "description": "",
    "providerCode": "IDC",
    "providerCodeName": "Datacenter",
    "providerName": "thingcluster",
    "seq": 1,
    "useType": "USER"
  },
  "regionCode": "KR",
  "updated": "2023-06-13 09:34:39",
  "useYn": "Y"
}