Get Edge Cluster details

GET 
/v1/edge-mgmt/cluster/details

Get Edge Cluster details

Responses

200

(empty)

application/json

Schema

Schema

metadata

object

MetaData defines the metadata for the resource.

creationTimestampdate-time

CreationTimestamp is the timestamp when the resource was created.

idstring

ID is the unique identifier of the resource.

labels

object

property name*string

lastModifiedTimestampdate-time

LastModifiedTimestamp is the timestamp when the resource was last modified.

namestring

Name is the name of the resource.

tags

object

Tags is the list of tags associated with the resource.

property name*object

spec

object

ClusterSpec is the specification of the cluster.

hostIDsstring[]

nodePools

object[]

Array [

hosts

object[]

Array [

hostAddressstring

hostIDstring

hostNamestring

nic

object[]

Array [

dnsstring[]

gatewaystring

ipstring

isDefaultboolean

macAddrstring

nicNamestring

subnetstring

]

]

pool

object

archTypestring

Possible values: [arm64, amd64]

Default value: amd64

Architecture type of the edge host

isControlPlaneboolean

namestring

Name of the cluster node pool.

]

ntpServersstring[]

overlayCIDRstring

sshKeysstring[]

vipstring

status

ClusterStatus provides the status of the cluster.

agentVersionstring

clusterConditions

undefined[]

Array [

lastProbeTimedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

lastTransitionTimedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

messagestring

Human readable message indicating details about last transition.

reasonstring

Unique, one word reason for the condition's last transition.

statusstringrequired

typestringrequired

]

clusterStatestring

Possible values: [Provisioning, Running, Deleting, Error]

health

object

Health provides details about the resource health.

reasonstring

statusstring

Possible values: [Healthy, Unhealthy]

isRebootPendingboolean

Default value: false

k8sVersionstring

kubeconfigstring

nodePools

object[]

Array [

nodes

object[]

Array [

agestring

architecturestring

health

object

Health provides details about the resource health.

reasonstring

statusstring

Possible values: [Healthy, Unhealthy]

ipv4string

k8sVersionstring

nodeNamestring

nodeStatestring

Possible values: [Provisioning, Running, Deleting, Error]

]

pool

object

archTypestring

Possible values: [arm64, amd64]

Default value: amd64

Architecture type of the edge host

isControlPlaneboolean

namestring

Name of the cluster node pool.

]

ntpServersAppliedboolean

Default value: false

services

object[]

Array [

hoststring

Host of the service.

namestring

Name of the service.

ports

object[]

Ports of the service.

Array [

appProtocolstring

App protocol of the port.

namestring

Name of the port.

nodePortinteger

NodePort number.

portinteger

Port number.

protocolstring

Protocol of the port.

targetPortstring

number or string of the target port .

]

]

sshKeysAppliedboolean

Default value: false

Example (from schema)

{
  "metadata": {
    "creationTimestamp": "2024-07-10T22:28:52.796Z",
    "id": "string",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-10T22:28:52.796Z",
    "name": "string",
    "tags": {}
  },
  "spec": {
    "hostIDs": [
      "string"
    ],
    "nodePools": [
      {
        "hosts": [
          {
            "hostAddress": "string",
            "hostID": "string",
            "hostName": "string",
            "nic": [
              {
                "dns": [
                  "string"
                ],
                "gateway": "string",
                "ip": "string",
                "isDefault": true,
                "macAddr": "string",
                "nicName": "string",
                "subnet": "string"
              }
            ]
          }
        ],
        "pool": {
          "archType": "amd64",
          "isControlPlane": true,
          "name": "string"
        }
      }
    ],
    "ntpServers": [
      "string"
    ],
    "overlayCIDR": "string",
    "sshKeys": [
      "string"
    ],
    "vip": "string"
  },
  "status": {
    "agentVersion": "string",
    "clusterConditions": [
      {
        "lastProbeTime": "2024-07-10T22:28:52.797Z",
        "lastTransitionTime": "2024-07-10T22:28:52.797Z",
        "message": "string",
        "reason": "string",
        "status": "string",
        "type": "string"
      }
    ],
    "clusterState": "Provisioning",
    "health": {
      "reason": "string",
      "status": "Healthy"
    },
    "isRebootPending": false,
    "k8sVersion": "string",
    "kubeconfig": "string",
    "nodePools": [
      {
        "nodes": [
          {
            "age": "string",
            "architecture": "string",
            "health": {
              "reason": "string",
              "status": "Healthy"
            },
            "ipv4": "string",
            "k8sVersion": "string",
            "nodeName": "string",
            "nodeState": "Provisioning"
          }
        ],
        "pool": {
          "archType": "amd64",
          "isControlPlane": true,
          "name": "string"
        }
      }
    ],
    "ntpServersApplied": false,
    "services": [
      {
        "host": "string",
        "name": "string",
        "ports": [
          {
            "appProtocol": "string",
            "name": "string",
            "nodePort": 0,
            "port": 0,
            "protocol": "string",
            "targetPort": "string"
          }
        ]
      }
    ],
    "sshKeysApplied": false
  }
}

404

(empty)

application/json

Schema

Schema

any

500

(empty)

application/json

Schema

Schema

codestring
detailsobject
messagestring
refstring

Example (from schema)

{
  "code": "string",
  "details": {},
  "message": "string",
  "ref": "string"
}

Loading...