Service Health Summary
get
/services/{version}/config/health/check
Retrieve summary 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 Summary
Type:
object
Title:
Oracle GoldenGate Service Health Summary
This schema summarizes the health of an OGG service
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:healthSummary" ]
-
deploymentId:
string
Minimum Length:
36
Maximum Length:36
Pattern:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
The unique identifier for this service's deployment -
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
-
serviceId:
string
Minimum Length:
36
Maximum Length:36
Pattern:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
The unique identifier for this service -
serviceManagerId:
string
Minimum Length:
36
Maximum Length:36
Pattern:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
The unique identifier for the Service Manager service that manages this service -
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
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
],
"messages":[
],
"response":{
"$schema":"ogg:healthSummary",
"deploymentName":"Local",
"healthy":true,
"serviceName":"adminsrvr",
"started":"2019-03-15T14:40:41.353Z"
}
}
429 Response
Root Schema : Oracle GoldenGate Service Health Summary
Type:
object
Title:
Oracle GoldenGate Service Health Summary
This schema summarizes the health of an OGG service
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:healthSummary" ]
-
deploymentId:
string
Minimum Length:
36
Maximum Length:36
Pattern:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
The unique identifier for this service's deployment -
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
-
serviceId:
string
Minimum Length:
36
Maximum Length:36
Pattern:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
The unique identifier for this service -
serviceManagerId:
string
Minimum Length:
36
Maximum Length:36
Pattern:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
The unique identifier for the Service Manager service that manages this service -
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
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
],
"messages":[
],
"response":{
"$schema":"ogg:healthSummary",
"deploymentName":"Local",
"healthy":false,
"serviceName":"adminsrvr",
"started":"2019-03-15T14:40:43.812Z"
}
}