Executing a Request from API Testing Tools
You can invoke Service Health Check request using API Testing tools such as SoapUI, GitHub REST Client, Postman. The request must conform to the
HealthcheckRequest
schema. The
HealthCheck.wsdl
request schema is available at
<TIBCO_HOME>/administrator/<version>/samples/healthcheck/
.
The request schema consists of the following elements:
Element | Description |
---|---|
hops | The
A hop is defined as an Application instance within such a set of Applications, connected via Promoted References and Services. Valid values:
For example, in the following Application chain: Application1 -> Application2 -> Application3 -> Application4:
|
suppressStackTrace | (Optional) The
suppressStackTrace element specifies whether an exception stack trace in a Service Health Check response must be suppressed or not. The default is
false .
For more information, see Suppressing Stack Trace in a Service Health Check Response. |
timeout | (Optional) The
timeout element specifies a timeout value for the Service Health Check invocation in milliseconds.
For more information, see Specifying a Timeout Value for a Service Health Check Invocation. |
refreshCache | (Optional) The
refreshCache element controls whether the Service Health Check response for the current Service Health Check request must be cached. The default is
false .
For more information about how this element works in combination with
For more information about Caching, see Caching a Service Health Check Response. |
validityDurationInSecs | (Optional) The
Note: By default, the cache validity duration provided by the
com.tibco.amx.servicehealthcheck.caching.duration TRA property is used. For more information, refer to
Specifying the Validity Duration for a Service Health Check.
Note: The value of
validityDurationInSecs is ignored if
refreshCache=false .
For more information on how this element works in combination with
For more information about Caching, see Caching a Service Health Check Response. |
refreshIfOlderThan | (Optional) The
The
For more information on how this element works in combination with
For more information on Caching, see Caching a Service Health Check Response. |
Elements Related to Caching
refreshCache=true | refreshCache=false | |
---|---|---|
validityDurationInSecs=<valid value> For example, 10. |
A new Service Health Check Invocation is executed and cached for
<validvalue> seconds.
|
If a valid cached entry is present, it is returned. A warning is logged about not using the
If not, a new Service Health Check Invocation is executed but the response is not cached. |
validityDurationInSecs is not specified | Default system value of 60 seconds is used for the new Service Health Check Invocation. |
If a valid cached entry is present, it is returned. Expiry time is not updated. A warning is logged about not using the validityDurationInSecs attribute. If not, a new Service Health Check Invocation is executed. This response is not cached. |
validityDurationInSecs=0 | New Service Health Check Invocation is executed and returned, but cache is cleared for the request. |
If a valid cached entry is present, it is returned and the cache is not cleared. A warning is logged about not using the
If not, a new Service Health Check Invocation is executed. This response is not cached. |