1. REST API for Server Manager Guide
  2. health

health

API Name

health

Description

Provides the health check summary of the instances.

REST Methods

POST

Precondition

Server Manager and Agent must be running.

Input Params

instanceName Note (Release 9.2.4.3): Add these additional parameters if there are duplicate instance names: agentHostName, jdeHome.

Sample Request

{ "instanceName" : "Give_instace_Name"}Example 2:{"targetType": "webserver"}

Example: Health Check on All servers registered on the particular Host{"agentHostName" : "den00ktt.example.com"}Example: Health Check on based on Server Group{"serverGroup":"default"}Example: Health Check on all servers registered on this Server MangerSend Empty request or {} This is the sample request if you have multiple instance names: { "instanceName":"tqa_923_lnx_jas_jdeSMA_21502", "agentHostName":"jdeSMA.example.com”, "jdeHome":"/slot/oracle/jde_agent_jas/SCFHA"}

Return

Throws an exception if the operation fails for any reason.

Sample Response

Sample example for HTML Server Health Check response:{ "reportType": "Health Status for JDE Instances", "instanceHealths": [ { "instanceName": "smagenttestHtml", "healthStatus": "Passed", "instanceHealthChecks": [ { "HealthCheckName": "Login", "Result": "Passed" }, { "HealthCheckName": "Interactive App", "Result": "Passed" }, { "HealthCheckName": "UBE", "Result": "Passed" }, { "HealthCheckName": "OVR", "Warning": "OVR not configured", "Result": "Passed" } ], "targetType": "webserver", "executedOn": "11 Aug 2017 12:32:16 GMT", "instanceStatus": "RUNNING", "healthCheckUser": "JDE", "healthCheckEnv": "JDV920" } ]}

Exception

Throws an exception if the operation fails for any reason.