Oracle GoldenGate Microservices REST API

Retrieve an existing Process Information

get

/services/{version}/mpoints/processes

Required Role: User

Retrieve an existing Process Information

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 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:processes" ]
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:processes"
            ]
        },
        "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":"4294967295"
                    },
                    "firstMessage":{
                        "description":"The identifier of the first message issued by the process with the processId",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"4294967295"
                    },
                    "processId":{
                        "description":"The operating system process id",
                        "type":"integer",
                        "minimum":"1",
                        "maximum":"4294967295"
                    },
                    "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"
                        ]
                    },
                    "$schema":{
                        "enum":[
                            "mpoints:process"
                        ]
                    },
                    "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":"1",
                        "maximum":"65535"
                    },
                    "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",
                            "Not Applicable"
                        ]
                    },
                    "processState":{
                        "description":"The Process State",
                        "enum":[
                            "Registered",
                            "Starting",
                            "Running",
                            "Stopping",
                            "StoppingForced",
                            "Stopped",
                            "StoppedForced",
                            "Abend",
                            "Killed",
                            "NotResponsive"
                        ]
                    }
                },
                "required":[
                    "processName",
                    "processType",
                    "processMode",
                    "processState",
                    "startTime",
                    "lastHeartbeat",
                    "stateTime",
                    "firstMessage",
                    "lastMessage"
                ],
                "additionalProperties":false
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : processes

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

Show Source

Array of: 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":"4294967295"
            },
            "firstMessage":{
                "description":"The identifier of the first message issued by the process with the processId",
                "type":"integer",
                "minimum":"0",
                "maximum":"4294967295"
            },
            "processId":{
                "description":"The operating system process id",
                "type":"integer",
                "minimum":"1",
                "maximum":"4294967295"
            },
            "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"
                ]
            },
            "$schema":{
                "enum":[
                    "mpoints:process"
                ]
            },
            "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":"1",
                "maximum":"65535"
            },
            "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",
                    "Not Applicable"
                ]
            },
            "processState":{
                "description":"The Process State",
                "enum":[
                    "Registered",
                    "Starting",
                    "Running",
                    "Stopping",
                    "StoppingForced",
                    "Stopped",
                    "StoppedForced",
                    "Abend",
                    "Killed",
                    "NotResponsive"
                ]
            }
        },
        "required":[
            "processName",
            "processType",
            "processMode",
            "processState",
            "startTime",
            "lastHeartbeat",
            "stateTime",
            "firstMessage",
            "lastMessage"
        ],
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

$schema:

Allowed Values: [ "mpoints:process" ]
firstMessage(required): integer

Minimum Value: 0

Maximum Value: 4294967295

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

Time of the Last Heartbeat
lastMessage(required): integer

Minimum Value: 0

Maximum Value: 4294967295

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

Minimum Value: 1

Maximum Value: 65535

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

Minimum Value: 1

Maximum Value: 4294967295

The operating system process id
processMode(required):

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

The Process Mode
processName(required): string

Minimum Length: 1

Maximum Length: 16

The process name
processState(required):

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

The Process State
processType(required):

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

The Process Type
startTime(required): startTime

Process Start Time
stateTime(required): 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":"4294967295"
        },
        "firstMessage":{
            "description":"The identifier of the first message issued by the process with the processId",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "processId":{
            "description":"The operating system process id",
            "type":"integer",
            "minimum":"1",
            "maximum":"4294967295"
        },
        "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"
            ]
        },
        "$schema":{
            "enum":[
                "mpoints:process"
            ]
        },
        "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":"1",
            "maximum":"65535"
        },
        "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",
                "Not Applicable"
            ]
        },
        "processState":{
            "description":"The Process State",
            "enum":[
                "Registered",
                "Starting",
                "Running",
                "Stopping",
                "StoppingForced",
                "Stopped",
                "StoppedForced",
                "Abend",
                "Killed",
                "NotResponsive"
            ]
        }
    },
    "required":[
        "processName",
        "processType",
        "processMode",
        "processState",
        "startTime",
        "lastHeartbeat",
        "stateTime",
        "firstMessage",
        "lastMessage"
    ],
    "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"
        }
    ]
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:17004/services/v2/mpoints/processes",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:17004/services/v2/mpoints/processes",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:17004/services/v2/metadata-catalog/processes",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"mpoints:processes",
        "processes":[
            {
                "processName":"ADMINSRVR",
                "lastMessage":"0",
                "firstMessage":"0",
                "processId":"25256",
                "lastHeartbeat":"2019-03-03T15:42:11.821Z",
                "processType":"AdminServer",
                "startTime":"2019-03-03T15:41:39.787Z",
                "portNumber":"17001",
                "stateTime":"2019-03-03T15:41:39.787Z",
                "processMode":"Not Applicable",
                "processState":"Running"
            },
            {
                "processName":"DISTSRVR",
                "lastMessage":"0",
                "firstMessage":"0",
                "processId":"655",
                "lastHeartbeat":"2019-03-03T15:42:14.475Z",
                "processType":"DistServer",
                "startTime":"2019-03-02T14:51:55.993Z",
                "portNumber":"17002",
                "stateTime":"2019-03-02T14:51:55.995Z",
                "processMode":"Not Applicable",
                "processState":"Running"
            },
            {
                "processName":"EXT1",
                "lastMessage":"0",
                "firstMessage":"0",
                "processId":"24335",
                "lastHeartbeat":"2019-03-03T15:42:13.474Z",
                "processType":"Extract",
                "startTime":"2019-03-03T14:58:43.291Z",
                "stateTime":"2019-03-03T14:59:02.102Z",
                "processMode":"Integrated",
                "processState":"Running"
            },
            {
                "processName":"PMSRVR",
                "lastMessage":"0",
                "firstMessage":"0",
                "processId":"25157",
                "lastHeartbeat":"2019-03-03T15:42:13.455Z",
                "processType":"PMServer",
                "startTime":"2019-03-03T15:38:13.819Z",
                "portNumber":"17004",
                "stateTime":"2019-03-03T15:38:13.820Z",
                "processMode":"Not Applicable",
                "processState":"Running"
            },
            {
                "processName":"RECVSRVR",
                "lastMessage":"0",
                "firstMessage":"0",
                "processId":"657",
                "lastHeartbeat":"2019-03-03T15:42:11.915Z",
                "processType":"RecvServer",
                "startTime":"2019-03-02T14:51:56.022Z",
                "portNumber":"17003",
                "stateTime":"2019-03-02T14:51:56.023Z",
                "processMode":"Not Applicable",
                "processState":"Running"
            }
        ]
    }
}