Skip to main content
Version: latest

Get Edge Cluster details

GET 

/v1/edge-mgmt/cluster/details

Get Edge Cluster details

Responses

(empty)

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.

  • ]

  • 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 .

  • ]

  • ]

Loading...