Get Platform Health Status
Returns the overall high-level health state of the platform deployment as perceived by the installer.
Notes:
- This is an installer-centric view of health. For detailed, granular cluster health metrics, use the
ssp/cluster/monitor/platform/statusAPI from the corresponding Platform instead.
A globally unique UUID representing the platform.
434348d8-681e-4809-8dc1-427127d2bee7Platform health status.
{
"kubernetes_version": "string",
"security_service_platform_version": "string",
"overall_status": "string",
"overall_health": "string",
"installer_status": "string",
"platform_status": "string",
"installer_fqdn": {
"name": "string",
"state": "string",
"ip": "string"
},
"ingress_fqdn": {
"name": "string",
"state": "string",
"ip": "string"
},
"kafka_fqdn": {
"name": "string",
"state": "string",
"ip": "string"
},
"management_nodes": [
{
"name": "string",
"internal_ip": "string",
"used_cpu": "number",
"used_disk": "number",
"used_memory": "number",
"allocated_cpu": "number",
"allocated_disk": "number",
"allocated_memory": "number",
"system_info": {
"machine_id": "string",
"system_uuid": "string",
"boot_id": "string",
"kernel_version": "string",
"os_image": "string",
"container_runtime_version": "string",
"kubelet_version": "string",
"kubeproxy_version": "string",
"operating_system": "string",
"architecture": "string"
},
"ready": "string",
"is_control_plane": false
}
],
"workload_nodes": [
{
"name": "string",
"internal_ip": "string",
"used_cpu": "number",
"used_disk": "number",
"used_memory": "number",
"allocated_cpu": "number",
"allocated_disk": "number",
"allocated_memory": "number",
"system_info": {
"machine_id": "string",
"system_uuid": "string",
"boot_id": "string",
"kernel_version": "string",
"os_image": "string",
"container_runtime_version": "string",
"kubelet_version": "string",
"kubeproxy_version": "string",
"operating_system": "string",
"architecture": "string"
},
"ready": "string",
"is_control_plane": false
}
],
"creation_time": 0,
"modified_time": 0,
"management_namespace_status": [
{
"name": "string",
"phase": "string",
"pod_status": [
{
"name": "string",
"phase": "string",
"pod_ip": "string",
"status": "string",
"status_message": "string"
}
],
"service_status": [
{
"name": "string",
"cluster_ip": "string",
"external_ips": [
"string"
]
}
]
}
],
"workload_namespace_status": [
{
"name": "string",
"phase": "string",
"pod_status": [
{
"name": "string",
"phase": "string",
"pod_ip": "string",
"status": "string",
"status_message": "string"
}
],
"service_status": [
{
"name": "string",
"cluster_ip": "string",
"external_ips": [
"string"
]
}
]
}
],
"storage_class": [
{
"name": "string",
"provisioner": "string",
"parameters": [
{
"name": "string",
"value": "string"
}
]
}
],
"vsphere_vms": [
{
"name": "string",
"datacenter": "string",
"datastore": "string",
"disk": 0,
"folder": "string",
"memory": 0,
"resource_pool": "string",
"server": "string",
"storage_policy": "string",
"template": "string",
"thumbprint": "string",
"status": {
"status": "string",
"reason": "string",
"message": "string"
},
"network": {
"devices": [
{
"network_name": "string",
"nameservers": [
"string"
],
"addresses_from_pools": [
{
"api_group": "string",
"kind": "string",
"name": "string"
}
]
}
]
}
}
],
"clusters": [
{
"name": "string",
"controlplane_endpoint": {
"host": "string",
"port": 0
},
"status": {
"status": "string",
"reason": "string",
"message": "string"
}
}
],
"installer_version": "string",
"vcenter_version": "string"
}The Kubernetes version hosted by the Security Service Platform.
The Security Service Platform version.
Enum for the overall platform status.
The overall health status of the Platform and Installer.
Enum for the overall platform status.
Enum for the overall platform status.
The FQDN of the Platform Ingress.
The FQDN of the Platform Ingress.
The FQDN of the Platform Ingress.
The health of the management cluster nodes.
The health of the workload cluster nodes.
Timestamp in milliseconds since epoch.
Timestamp in milliseconds since epoch.
The status of critical resources in the management cluster, organized by namespace.
The status of critical resources in the workload cluster, organized by namespace.
The storage class of the workload cluster.
The status of the vSphere VMs.
The status of the clusters.
The version of the Security Service Platform Installer.
The version of the vCenter.
Bad Request
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Unauthorized
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Forbidden
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Failed
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Required
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Too Many Requests
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
curl -H 'Authorization: <value>' https://{api_host}/https://{api_host}:{port}/lh-appliance/platforms/{platform-id}/health