Service Health Details
get
/services/{version}/config/health
Retrieve detailed information for the service health.
Request
Path Parameters
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
Root Schema : Oracle GoldenGate Service Health
Type:
object
Title:
Oracle GoldenGate Service Health
This schema describes the health of an OGG service
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:health" ]
-
criticalResources(optional):
array criticalResources
Minimum Number of Items:
1
Maximum Number of Items:65535
-
deploymentName:
string
Minimum Length:
1
Maximum Length:32
Pattern:^[A-Za-z][A-Za-z0-9-_.]*$
Name of the Oracle GoldenGate deployment -
healthy:
boolean
Microservice health indicator
-
serviceName:
string
Minimum Length:
1
Maximum Length:64
Name of the OGG Microservice -
started:
string
Minimum Length:
20
Maximum Length:32
Pattern:^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$
Date and time the service started
Nested Schema : criticalResources
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
65535
Nested Schema : items
Type:
Show Source
object
-
deploymentName(optional):
string
Minimum Length:
1
Maximum Length:32
Pattern:^[A-Za-z][A-Za-z0-9-_.]*$
Resource deployment name -
healthy:
boolean
Resource health indicator
-
name:
string
Minimum Length:
1
Maximum Length:64
Resource name -
status:
status
-
type:
Allowed Values:
[ "extract", "replicat", "ER", "service", "task", "distPath" ]
Resource type
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/config/health",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/config/health",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/health",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:health",
"deploymentName":"Local",
"healthy":true,
"serviceName":"adminsrvr",
"started":"2019-03-15T14:40:41.353Z"
}
}