Oracle GoldenGate

Root Schema : Oracle GoldenGate Monitoring point data for Registered OGG processes

Type: object

Title: Oracle GoldenGate Monitoring point data for Registered OGG processes

Show Source

$schema:

Allowed Values: [ "mpoints:process" ]
processes: array processes

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

{
    "title":"Oracle GoldenGate Monitoring point data for Registered OGG processes",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "mpoints:process"
            ]
        },
        "processes":{
            "type":"array",
            "minItems":0,
            "maxItems":2147483647,
            "items":{
                "type":"object",
                "properties":{
                    "processName":{
                        "description":"The process name",
                        "type":"string",
                        "minLength":1,
                        "maxLength":16
                    },
                    "lastMessage":{
                        "description":"The identifier of the last message issued by the process with the processId",
                        "type":"integer",
                        "minimum":0,
                        "maximum":4.294967295E9
                    },
                    "firstMessage":{
                        "description":"The identifier of the first message issued by the process with the processId",
                        "type":"integer",
                        "minimum":0,
                        "maximum":4.294967295E9
                    },
                    "processId":{
                        "description":"The operating system process id",
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "lastHeartbeat":{
                        "description":"Time of the Last Heartbeat",
                        "x-oneOf":[
                            {
                                "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
                            },
                            {
                                "type":"null"
                            }
                        ]
                    },
                    "processType":{
                        "description":"The Process Type",
                        "enum":[
                            "Unknown",
                            "Manager",
                            "Extract",
                            "Replicat",
                            "Pump",
                            "Server",
                            "GGSCI",
                            "GGCMD",
                            "DEFGEN",
                            "EMSCLNT",
                            "AdminServer",
                            "AdminClient",
                            "DistServer",
                            "RecvServer",
                            "PMServer",
                            "ServiceManager"
                        ]
                    },
                    "startTime":{
                        "description":"Process Start Time",
                        "x-oneOf":[
                            {
                                "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
                            },
                            {
                                "type":"null"
                            }
                        ]
                    },
                    "portNumber":{
                        "description":"The TCP/IP port the process listens on",
                        "type":"integer",
                        "minimum":0,
                        "maximum":4.294967295E9
                    },
                    "stateTime":{
                        "description":"Time of the Last State Change",
                        "x-oneOf":[
                            {
                                "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
                            },
                            {
                                "type":"null"
                            }
                        ]
                    },
                    "processMode":{
                        "description":"The Process Mode",
                        "enum":[
                            "Unknown",
                            "Classic",
                            "Integrated",
                            "Coordinated",
                            "Parallel",
                            "ParallelApplier",
                            "ParallelMapper"
                        ]
                    },
                    "processState":{
                        "description":"The Process State",
                        "enum":[
                            "Registered",
                            "Starting",
                            "Running",
                            "Stopping",
                            "StoppingForced",
                            "Stopped",
                            "StoppedForced",
                            "Abend",
                            "Killed",
                            "NotResponsive"
                        ]
                    }
                },
                "additionalProperties":false
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : processes

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

Show Source

[0]: object items

{
    "type":"array",
    "minItems":0,
    "maxItems":2147483647,
    "items":{
        "type":"object",
        "properties":{
            "processName":{
                "description":"The process name",
                "type":"string",
                "minLength":1,
                "maxLength":16
            },
            "lastMessage":{
                "description":"The identifier of the last message issued by the process with the processId",
                "type":"integer",
                "minimum":0,
                "maximum":4.294967295E9
            },
            "firstMessage":{
                "description":"The identifier of the first message issued by the process with the processId",
                "type":"integer",
                "minimum":0,
                "maximum":4.294967295E9
            },
            "processId":{
                "description":"The operating system process id",
                "type":"integer",
                "minimum":0,
                "maximum":9.223372036854776E18
            },
            "lastHeartbeat":{
                "description":"Time of the Last Heartbeat",
                "x-oneOf":[
                    {
                        "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
                    },
                    {
                        "type":"null"
                    }
                ]
            },
            "processType":{
                "description":"The Process Type",
                "enum":[
                    "Unknown",
                    "Manager",
                    "Extract",
                    "Replicat",
                    "Pump",
                    "Server",
                    "GGSCI",
                    "GGCMD",
                    "DEFGEN",
                    "EMSCLNT",
                    "AdminServer",
                    "AdminClient",
                    "DistServer",
                    "RecvServer",
                    "PMServer",
                    "ServiceManager"
                ]
            },
            "startTime":{
                "description":"Process Start Time",
                "x-oneOf":[
                    {
                        "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
                    },
                    {
                        "type":"null"
                    }
                ]
            },
            "portNumber":{
                "description":"The TCP/IP port the process listens on",
                "type":"integer",
                "minimum":0,
                "maximum":4.294967295E9
            },
            "stateTime":{
                "description":"Time of the Last State Change",
                "x-oneOf":[
                    {
                        "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
                    },
                    {
                        "type":"null"
                    }
                ]
            },
            "processMode":{
                "description":"The Process Mode",
                "enum":[
                    "Unknown",
                    "Classic",
                    "Integrated",
                    "Coordinated",
                    "Parallel",
                    "ParallelApplier",
                    "ParallelMapper"
                ]
            },
            "processState":{
                "description":"The Process State",
                "enum":[
                    "Registered",
                    "Starting",
                    "Running",
                    "Stopping",
                    "StoppingForced",
                    "Stopped",
                    "StoppedForced",
                    "Abend",
                    "Killed",
                    "NotResponsive"
                ]
            }
        },
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

firstMessage: integer

Minimum Value: 0

Maximum Value: 4.294967295E9

The identifier of the first message issued by the process with the processId
lastHeartbeat: lastHeartbeat

Time of the Last Heartbeat
lastMessage: integer

Minimum Value: 0

Maximum Value: 4.294967295E9

The identifier of the last message issued by the process with the processId
portNumber: integer

Minimum Value: 0

Maximum Value: 4.294967295E9

The TCP/IP port the process listens on
processId: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

The operating system process id
processMode:

Allowed Values: [ "Unknown", "Classic", "Integrated", "Coordinated", "Parallel", "ParallelApplier", "ParallelMapper" ]

The Process Mode
processName: string

Minimum Length: 1

Maximum Length: 16

The process name
processState:

Allowed Values: [ "Registered", "Starting", "Running", "Stopping", "StoppingForced", "Stopped", "StoppedForced", "Abend", "Killed", "NotResponsive" ]

The Process State
processType:

Allowed Values: [ "Unknown", "Manager", "Extract", "Replicat", "Pump", "Server", "GGSCI", "GGCMD", "DEFGEN", "EMSCLNT", "AdminServer", "AdminClient", "DistServer", "RecvServer", "PMServer", "ServiceManager" ]

The Process Type
startTime: startTime

Process Start Time
stateTime: stateTime

Time of the Last State Change

{
    "type":"object",
    "properties":{
        "processName":{
            "description":"The process name",
            "type":"string",
            "minLength":1,
            "maxLength":16
        },
        "lastMessage":{
            "description":"The identifier of the last message issued by the process with the processId",
            "type":"integer",
            "minimum":0,
            "maximum":4.294967295E9
        },
        "firstMessage":{
            "description":"The identifier of the first message issued by the process with the processId",
            "type":"integer",
            "minimum":0,
            "maximum":4.294967295E9
        },
        "processId":{
            "description":"The operating system process id",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "lastHeartbeat":{
            "description":"Time of the Last Heartbeat",
            "x-oneOf":[
                {
                    "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
                },
                {
                    "type":"null"
                }
            ]
        },
        "processType":{
            "description":"The Process Type",
            "enum":[
                "Unknown",
                "Manager",
                "Extract",
                "Replicat",
                "Pump",
                "Server",
                "GGSCI",
                "GGCMD",
                "DEFGEN",
                "EMSCLNT",
                "AdminServer",
                "AdminClient",
                "DistServer",
                "RecvServer",
                "PMServer",
                "ServiceManager"
            ]
        },
        "startTime":{
            "description":"Process Start Time",
            "x-oneOf":[
                {
                    "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
                },
                {
                    "type":"null"
                }
            ]
        },
        "portNumber":{
            "description":"The TCP/IP port the process listens on",
            "type":"integer",
            "minimum":0,
            "maximum":4.294967295E9
        },
        "stateTime":{
            "description":"Time of the Last State Change",
            "x-oneOf":[
                {
                    "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
                },
                {
                    "type":"null"
                }
            ]
        },
        "processMode":{
            "description":"The Process Mode",
            "enum":[
                "Unknown",
                "Classic",
                "Integrated",
                "Coordinated",
                "Parallel",
                "ParallelApplier",
                "ParallelMapper"
            ]
        },
        "processState":{
            "description":"The Process State",
            "enum":[
                "Registered",
                "Starting",
                "Running",
                "Stopping",
                "StoppingForced",
                "Stopped",
                "StoppedForced",
                "Abend",
                "Killed",
                "NotResponsive"
            ]
        }
    },
    "additionalProperties":false
}

Nested Schema : lastHeartbeat

Time of the Last Heartbeat

Match One

Show Source

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])$
null

{
    "description":"Time of the Last Heartbeat",
    "x-oneOf":[
        {
            "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
        },
        {
            "type":"null"
        }
    ]
}

Nested Schema : startTime

Process Start Time

Match One

Show Source

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])$
null

{
    "description":"Process Start Time",
    "x-oneOf":[
        {
            "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
        },
        {
            "type":"null"
        }
    ]
}

Nested Schema : stateTime

Time of the Last State Change

Match One

Show Source

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])$
null

{
    "description":"Time of the Last State Change",
    "x-oneOf":[
        {
            "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
        },
        {
            "type":"null"
        }
    ]
}

Retrieve an existing Process Information

Request

Response

200 Response