Get Edge Cluster details
GET/v1/edge-mgmt/cluster/details
Get Edge Cluster details
Responses
- 200
- 404
- 500
(empty)
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
]
Array [
]
Array [
Array [
]
]
Array [
Array [
]
]
metadata
object
MetaData defines the metadata for the resource.
CreationTimestamp is the timestamp when the resource was created.
ID is the unique identifier of the resource.
labels
object
LastModifiedTimestamp is the timestamp when the resource was last modified.
Name is the name of the resource.
tags
object
Tags is the list of tags associated with the resource.
spec
object
ClusterSpec is the specification of the cluster.
nodePools
object[]
hosts
object[]
nic
object[]
pool
object
Possible values: [arm64
, amd64
]
Default value: amd64
Architecture type of the edge host
Name of the cluster node pool.
status
ClusterStatus provides the status of the cluster.
clusterConditions
undefined[]
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.
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.
Human readable message indicating details about last transition.
Unique, one word reason for the condition's last transition.
Possible values: [Provisioning
, Running
, Deleting
, Error
]
health
object
Health provides details about the resource health.
Possible values: [Healthy
, Unhealthy
]
Default value: false
nodePools
object[]
nodes
object[]
health
object
Health provides details about the resource health.
Possible values: [Healthy
, Unhealthy
]
Possible values: [Provisioning
, Running
, Deleting
, Error
]
pool
object
Possible values: [arm64
, amd64
]
Default value: amd64
Architecture type of the edge host
Name of the cluster node pool.
Default value: false
services
object[]
Host of the service.
Name of the service.
ports
object[]
Ports of the service.
App protocol of the port.
Name of the port.
NodePort number.
Port number.
Protocol of the port.
number or string of the target port .
Default value: false
{
"metadata": {
"creationTimestamp": "2024-07-29T15:51:28.071Z",
"id": "string",
"labels": {},
"lastModifiedTimestamp": "2024-07-29T15:51:28.071Z",
"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-29T15:51:28.071Z",
"lastTransitionTime": "2024-07-29T15:51:28.071Z",
"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
}
}
(empty)
- application/json
- Schema
Schema
any
(empty)
- application/json
- Schema
- Example (from schema)
Schema
{
"code": "string",
"details": {},
"message": "string",
"ref": "string"
}