Get instance health details

The following API GET call retrieves a detailed health check status for a given OHS instance. This API call retrieves the latest health status only if the Initiating a health check (API method) API returned an indication of success. Otherwise, the latest available Expected health status results are returned.

Variables

Variable	Description
TenantId	Tenant Management Tenant ID GUID.
CorrelationId	Correlation identifier GUID as set by the requester for tracking requests to responses

Sample cURL Request

curl --location --request GET 'https://k8s.itrontotal.com/ihcconfiggateway/api/v1/tenants/{TenantId}/instanceshealth'

--header 'Content-Type: application/json'

--header 'Grpc-Metadata-CorrelationId: {CorrelationId}'

--header 'Authorization: Bearer eyJhbGciOiJSUzI1' \

Sample JSON Response

{
    "ohsHealthDetails": [
        {
            "tenantId": "2baf2911-c836-47bf-a9ad-fcf0717e7c31",
            "instanceId": "229de42b-f014-4919-894a-c4b100424ad6",
            "instanceName": "healthchecklocalgv",
            "version": "2.4.0.9",
            "status": "Error",
            "statusDetails": [
                {
                    "testName": "Minimum Diskspace check",
                    "testStatus": "Alert",
                    "testResult": "System is using more than 80% of space",
                    "severity": "Medium",
                    "recoveryMeasures": "OHS is running on a machine which has less than recommended free space on C drive. Please clean up.",
                    "supportedFeature": "Resources and Permissions"
                },
                {
                    "testName": "CPU, Memory utilization check",
                    "testStatus": "Alert",
                    "testResult": "System is having high more than 80% Memory utilization by services running in the machine.",
                    "severity": "High",
                    "recoveryMeasures": "The CPU and memory usage on the machine is high. Please free up resources or scale up the machine as this could impact performance. ",
                    "supportedFeature": "Resources and Permissions"
                },
                {
                    "testName": "RabbitMQ connectivity check",
                    "testStatus": "Passed",
                    "testResult": "Rabbit Mq Connection details are valid",
                    "severity": "High",
                    "supportedFeature": "Connectivity Checks"
                },
                {
                    "testName": "Check subscriber queue exists",
                    "testStatus": "Alert",
                    "testResult": "Test will get implement in next sprint",
                    "severity": "Medium",
                    "recoveryMeasures": "Service Bus topic/queue does not exist. Please run provisioning of the outcome concerned to create them. Check with outcome team for guidance if required.",
                    "supportedFeature": "Functional Checks"
                },
                {
                    "testName": "Service Bus queue space check",
                    "testStatus": "Failed",
                    "testResult": "Test will get implement in next sprint",
                    "severity": "Medium",
                    "recoveryMeasures": "Service Bus topic/queue has exceeded the maximum capacity of messages it can hold. Check if the services that are supposed to read the messages from the queue are running.  Check for any misconfiguration of features. ",
                    "supportedFeature": "Functional Checks"
                },
                {
                    "testName": "Hybrid Connector Workspace folder permission check",
                    "testStatus": "Passed",
                    "testResult": "User has RW permission for OHS service.",
                    "severity": "Medium",
                    "supportedFeature": "Resources and Permissions"
                }
            ],
            "statusReceivedDate": "2020-11-17T12:28:24.433Z",
            "initiatedBy": "System"
        },
    ]
}