Get multiple tenants' health details

The following API GET call retrieves the health status of all OHS instances for a list of tenants.

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/ohshealthdetails' \

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

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

--header 'Grpc-Metadata-TenantIds: {TenantId1},{TenantId2},...,{TenantIdN}' \

--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsIm' \

Sample JSON Response

{
    "ohsHealthDetails": [
        {
            "tenantId": "2baf2911-c836-47bf-a9ad-fcf0717e7c31",
            "instanceId": "f51a4570-f604-42aa-b955-9a483ec3b302",
            "instanceName": "OhsHealthConfigurationCheckIns",
            "version": "2.4.0.9",
            "status": "NotKnown"
        },
        {
            "tenantId": "2baf2911-c836-47bf-a9ad-fcf0717e7c31",
            "instanceId": "4644b966-19bc-4424-91ac-0a2924281a3f",
            "instanceName": "ClientScopeTestInstance",
            "status": "Running",
            "statusDetails": [
                {
                    "testName": "Minimum Diskspace check",
                    "testStatus": "Passed",
                    "testResult": "System has enough space to run OHS",
                    "severity": "Medium",
                    "supportedFeature": "Resources and Permissions"
                },
                {
                    "testName": "Hybrid Connector Workspace folder permission check",
                    "testStatus": "Passed",
                    "testResult": "User has RW permission for OHS service.",
                    "severity": "Medium",
                    "supportedFeature": "Resources and Permissions"
                },
                {
                    "testName": "CPU, Memory utilization check",
                    "testStatus": "Passed",
                    "testResult": "System is having normal CPU and Memory Utilization",
                    "severity": "High",
                    "supportedFeature": "Resources and Permissions"
                }
            ],
            "statusReceivedDate": "2020-11-19T07:24:48.950Z",
            "initiatedBy": "System"
        },
        {
            "tenantId": "97a889a7-66ec-4c4d-bb4d-f15e6702d19e",
            "instanceId": "ef98dbd5-61c8-457c-b01c-06ae64210442",
            "instanceName": "demoinstance_123",
            "status": "NotKnown"
        },
        {
            "tenantId": "97a889a7-66ec-4c4d-bb4d-f15e6702d19e",
            "instanceId": "7f1b7966-ea6d-4227-89df-de9657b0e004",
            "instanceName": "inst12345",
            "version": "2.4.0.16",
            "status": "Running",
            "statusDetails": [
                {
                    "testName": "Identity server connectivity check",
                    "testStatus": "Passed",
                    "testResult": "Fetched Identity Access Token",
                    "severity": "High",
                    "supportedFeature": "Connectivity Checks"
                },
                {
                    "testName": "Minimum Diskspace check",
                    "testStatus": "Passed",
                    "testResult": "System has enough space to run OHS",
                    "severity": "Medium",
                    "supportedFeature": "Resources and Permissions"
                },
                {
                    "testName": "CPU, Memory utilization check",
                    "testStatus": "Passed",
                    "testResult": "System is having normal CPU and Memory Utilization",
                    "severity": "High",
                    "supportedFeature": "Resources and Permissions"
                },
                {
                    "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-12-02T04:42:49.246Z",
            "initiatedBy": "System"
        }
    ]
}