PlatformHealthStatus

Platform Health Status

The status of the platform's health.

JSON Example

{
    "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"
}

string

kubernetes_version

Read-Only

The Kubernetes version hosted by the Security Service Platform.

string

security_service_platform_version

Read-Only

The Security Service Platform version.

PlatformStatusEnum

overall_status

Optional

Enum for the overall platform status.

Enumeration: INITIALIZED, DEPLOYING, DEPLOYED, ERROR, UNDEPLOYING

PlatformOverallHealthStatus

overall_health

Optional

The overall health status of the Platform and Installer.

Enumeration: HEALTHY, UNHEALTHY

PlatformStatusEnum

installer_status

Optional

Enum for the overall platform status.

Enumeration: INITIALIZED, DEPLOYING, DEPLOYED, ERROR, UNDEPLOYING

PlatformStatusEnum

platform_status

Optional

Enum for the overall platform status.

Enumeration: INITIALIZED, DEPLOYING, DEPLOYED, ERROR, UNDEPLOYING

FQDNStatus

installer_fqdn

Optional

The FQDN of the Platform Ingress.

FQDNStatus

ingress_fqdn

Optional

The FQDN of the Platform Ingress.

FQDNStatus

kafka_fqdn

Optional

The FQDN of the Platform Ingress.

array of NodeStatus

management_nodes

Read-Only

The health of the management cluster nodes.

array of NodeStatus

workload_nodes

Read-Only

The health of the workload cluster nodes.

EpochMsTimestamp

creation_time

Optional

Timestamp in milliseconds since epoch.

EpochMsTimestamp

modified_time

Optional

Timestamp in milliseconds since epoch.

array of NamespaceStatus

management_namespace_status

Read-Only

The status of critical resources in the management cluster, organized by namespace.

array of NamespaceStatus

workload_namespace_status

Read-Only

The status of critical resources in the workload cluster, organized by namespace.

array of StorageClass

storage_class

Read-Only

The storage class of the workload cluster.

array of VSphereVM

vsphere_vms

Read-Only

The status of the vSphere VMs.

array of InfraCluster

clusters

Read-Only

The status of the clusters.

string

installer_version

Read-Only

The version of the Security Service Platform Installer.

string

vcenter_version

Read-Only

The version of the vCenter.

Returned By

Get Platform Health Status