Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Service Health Details

get

/services/{version}/config/health

Required Role: User

Retrieve detailed information for the service health.

Request

Path Parameters

version(required): 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:

Allowed Values: [ "ogg:health" ]
criticalResources: array criticalResources

Minimum Number of Items: 1

Maximum Number of Items: 65535
deploymentName(required): string

Minimum Length: 1

Maximum Length: 32

Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$

Name of the Oracle GoldenGate deployment
healthy(required): boolean

Microservice health indicator
serviceName(required): string

Minimum Length: 1

Maximum Length: 64

Name of the OGG Microservice
started(required): 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",
    "description":"This schema describes the health of an OGG service",
    "required":[
        "deploymentName",
        "serviceName",
        "started",
        "healthy"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:health"
            ]
        },
        "deploymentName":{
            "description":"Name of the Oracle GoldenGate deployment",
            "type":"string",
            "pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
            "minLength":"1",
            "maxLength":"32"
        },
        "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"
        },
        "criticalResources":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "deploymentName":{
                        "description":"Resource deployment name",
                        "type":"string",
                        "pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
                        "minLength":"1",
                        "maxLength":"32"
                    },
                    "name":{
                        "description":"Resource name",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"64"
                    },
                    "type":{
                        "description":"Resource type",
                        "enum":[
                            "extract",
                            "replicat",
                            "ER",
                            "service",
                            "task",
                            "distPath",
                            "recvPath"
                        ]
                    },
                    "status":{
                        "x-anyOf":[
                            {
                                "enum":[
                                    "starting",
                                    "running",
                                    "stopped",
                                    "killed",
                                    "abended"
                                ]
                            },
                            {
                                "enum":[
                                    "paused",
                                    "running",
                                    "stopping",
                                    "stopped",
                                    "killed",
                                    "uninitialized"
                                ],
                                "default":"stopped"
                            },
                            {
                                "enum":[
                                    "restarting",
                                    "disabled"
                                ]
                            }
                        ]
                    },
                    "healthy":{
                        "description":"Resource health indicator",
                        "type":"boolean"
                    }
                },
                "required":[
                    "name",
                    "type",
                    "status",
                    "healthy"
                ],
                "additionalProperties":false
            },
            "minItems":"1",
            "maxItems":"65535"
        }
    },
    "additionalProperties":false
}

Nested Schema : criticalResources

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 65535

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "deploymentName":{
                "description":"Resource deployment name",
                "type":"string",
                "pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
                "minLength":"1",
                "maxLength":"32"
            },
            "name":{
                "description":"Resource name",
                "type":"string",
                "minLength":"1",
                "maxLength":"64"
            },
            "type":{
                "description":"Resource type",
                "enum":[
                    "extract",
                    "replicat",
                    "ER",
                    "service",
                    "task",
                    "distPath",
                    "recvPath"
                ]
            },
            "status":{
                "x-anyOf":[
                    {
                        "enum":[
                            "starting",
                            "running",
                            "stopped",
                            "killed",
                            "abended"
                        ]
                    },
                    {
                        "enum":[
                            "paused",
                            "running",
                            "stopping",
                            "stopped",
                            "killed",
                            "uninitialized"
                        ],
                        "default":"stopped"
                    },
                    {
                        "enum":[
                            "restarting",
                            "disabled"
                        ]
                    }
                ]
            },
            "healthy":{
                "description":"Resource health indicator",
                "type":"boolean"
            }
        },
        "required":[
            "name",
            "type",
            "status",
            "healthy"
        ],
        "additionalProperties":false
    },
    "minItems":"1",
    "maxItems":"65535"
}

Nested Schema : items

Type: object

Show Source

deploymentName: string

Minimum Length: 1

Maximum Length: 32

Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$

Resource deployment name
healthy(required): boolean

Resource health indicator
name(required): string

Minimum Length: 1

Maximum Length: 64

Resource name
status(required): status
type(required):

Allowed Values: [ "extract", "replicat", "ER", "service", "task", "distPath", "recvPath" ]

Resource type

{
    "type":"object",
    "properties":{
        "deploymentName":{
            "description":"Resource deployment name",
            "type":"string",
            "pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
            "minLength":"1",
            "maxLength":"32"
        },
        "name":{
            "description":"Resource name",
            "type":"string",
            "minLength":"1",
            "maxLength":"64"
        },
        "type":{
            "description":"Resource type",
            "enum":[
                "extract",
                "replicat",
                "ER",
                "service",
                "task",
                "distPath",
                "recvPath"
            ]
        },
        "status":{
            "x-anyOf":[
                {
                    "enum":[
                        "starting",
                        "running",
                        "stopped",
                        "killed",
                        "abended"
                    ]
                },
                {
                    "enum":[
                        "paused",
                        "running",
                        "stopping",
                        "stopped",
                        "killed",
                        "uninitialized"
                    ],
                    "default":"stopped"
                },
                {
                    "enum":[
                        "restarting",
                        "disabled"
                    ]
                }
            ]
        },
        "healthy":{
            "description":"Resource health indicator",
            "type":"boolean"
        }
    },
    "required":[
        "name",
        "type",
        "status",
        "healthy"
    ],
    "additionalProperties":false
}

Nested Schema : status

Match Any

Show Source

Allowed Values: [ "starting", "running", "stopped", "killed", "abended" ]
Default Value: stopped

Allowed Values: [ "paused", "running", "stopping", "stopped", "killed", "uninitialized" ]
Allowed Values: [ "restarting", "disabled" ]

{
    "x-anyOf":[
        {
            "enum":[
                "starting",
                "running",
                "stopped",
                "killed",
                "abended"
            ]
        },
        {
            "enum":[
                "paused",
                "running",
                "stopping",
                "stopped",
                "killed",
                "uninitialized"
            ],
            "default":"stopped"
        },
        {
            "enum":[
                "restarting",
                "disabled"
            ]
        }
    ]
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/config/health",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/config/health",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/health",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:health",
        "deploymentName":"Local",
        "healthy":true,
        "serviceName":"adminsrvr",
        "started":"2024-04-03T22:33:14.387Z"
    }
}