Get clusters list

Get the list of clusters.

GET/v1/clusters

Response

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"

createdstring

Creation date/time

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

cubeTypestring

Cube clustertype(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: "N"

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"

providerAccountSeqinteger

Example: 1

regionCodestring

Example: "Default"

updatedstring

Modification time

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

useYnstring

Availability(Y: Allowed, N: Not allowed)

Example: "Y"

Request

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

Response

[
  {
    "apiUrl": "https://0.0.0.0:0",
    "authType": "CERT",
    "clusterId": "thingcluster",
    "clusterName": "devops cluster",
    "clusterSeq": 1,
    "clusterState": "RUNNING",
    "created": "2022-12-16 08:16:50",
    "cubeType": "MANAGED",
    "description": "",
    "ingressSupported": "Y",
    "k8sVersion": "1.23.14",
    "loadbalancerSupported": "N",
    "nodePortRange": "30000-32767",
    "nodePortSupported": "Y",
    "nodePortUrl": "0.0.0.0",
    "persistentVolumeSupported": "Y",
    "providerAccountSeq": 1,
    "regionCode": "Default",
    "updated": "2023-06-13 09:34:39",
    "useYn": "Y"
  }
]

PreviousCluster NextGet clusters status list

Last updated 8 months ago

[ { "apiUrl": "https://0.0.0.0:0", "authType": "CERT", "clusterId": "thingcluster", "clusterName": "devops cluster", "clusterSeq": 1, "clusterState": "RUNNING", "created": "2022-12-16 08:16:50", "cubeType": "MANAGED", "description": "", "ingressSupported": "Y", "k8sVersion": "1.23.14", "loadbalancerSupported": "N", "nodePortRange": "30000-32767", "nodePortSupported": "Y", "nodePortUrl": "0.0.0.0", "persistentVolumeSupported": "Y", "providerAccountSeq": 1, "regionCode": "Default", "updated": "2023-06-13 09:34:39", "useYn": "Y" } ]