1. Oracle GoldenGate 23ai Microservices Architecture REST API Documentation
  2. Tasks
  3. Common
  4. Configuration

Service Health Summary

get

/services/{version}/config/health/check

Required Role: Any

Retrieve summary information for the service health.

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
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
  • Allowed Values: [ "ogg:healthSummary" ]
  • 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
  • Minimum Length: 1
    Maximum Length: 32
    Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$
    Name of the Oracle GoldenGate deployment
  • Microservice health indicator
  • 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
  • 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 deployment that manages this service
  • Minimum Length: 1
    Maximum Length: 64
    Name of the OGG Microservice
  • 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",
        "deploymentId":"fb399546-9e6e-4acb-a776-a53360c8c106",
        "deploymentName":"Local",
        "healthy":true,
        "serviceId":"515c56a9-b1f2-434b-ba7b-5af584e00dcd",
        "serviceManagerId":"81e9a66d-bb10-4d3a-b5e0-ec886cac174b",
        "serviceName":"adminsrvr",
        "started":"2024-04-03T22:33:14.387Z"
    }
}

429 Response

Body ()
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
  • Allowed Values: [ "ogg:healthSummary" ]
  • 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
  • Minimum Length: 1
    Maximum Length: 32
    Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$
    Name of the Oracle GoldenGate deployment
  • Microservice health indicator
  • 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
  • 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 deployment that manages this service
  • Minimum Length: 1
    Maximum Length: 64
    Name of the OGG Microservice
  • 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",
        "deploymentId":"fb399546-9e6e-4acb-a776-a53360c8c106",
        "deploymentName":"Local",
        "healthy":false,
        "serviceId":"515c56a9-b1f2-434b-ba7b-5af584e00dcd",
        "serviceManagerId":"81e9a66d-bb10-4d3a-b5e0-ec886cac174b",
        "serviceName":"adminsrvr",
        "started":"2024-04-03T22:33:14.387Z"
    }
}
Back to Top