Oracle GoldenGate Microservices Architecture REST API

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

{
    "title":"Oracle GoldenGate Service Health Summary",
    "description":"This schema summarizes the health of an OGG service",
    "required":[
        "serviceManagerId",
        "deploymentId",
        "deploymentName",
        "serviceId",
        "serviceName",
        "started",
        "healthy"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:healthSummary"
            ]
        },
        "serviceManagerId":{
            "description":"The unique identifier for the Service Manager service that manages this service",
            "type":"string",
            "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}$",
            "minLength":36,
            "maxLength":36
        },
        "deploymentId":{
            "description":"The unique identifier for this service's deployment",
            "type":"string",
            "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}$",
            "minLength":36,
            "maxLength":36
        },
        "deploymentName":{
            "description":"Name of the Oracle GoldenGate deployment",
            "type":"string",
            "pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
            "minLength":1,
            "maxLength":32
        },
        "serviceId":{
            "description":"The unique identifier for this service",
            "type":"string",
            "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}$",
            "minLength":36,
            "maxLength":36
        },
        "serviceName":{
            "description":"Name of the OGG Microservice",
            "type":"string",
            "minLength":1,
            "maxLength":64
        },
        "started":{
            "description":"Date and time the service started",
            "type":"string",
            "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])$",
            "minLength":20,
            "maxLength":32
        },
        "healthy":{
            "description":"Microservice health indicator",
            "type":"boolean"
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:healthSummary",
        "deploymentId":"808bf044-02df-4234-aaf3-3c1b649b8bc6",
        "deploymentName":"Local",
        "healthy":true,
        "serviceId":"716f5944-3680-4313-9a54-ba671503bd69",
        "serviceManagerId":"6a31c389-721c-497a-b2bc-955e1d8f03b6",
        "serviceName":"adminsrvr",
        "started":"2021-07-13T16:36:51.361Z"
    }
}

429 Response