Retrieve an existing Process Information
get
/services/{version}/mpoints/processes
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 Monitoring point data for registered OGG processes
Type:
object
Title:
Show Source
Oracle GoldenGate Monitoring point data for registered OGG processes
-
$schema(optional):
Allowed Values:
[ "mpoints:processes" ]
-
processes(optional):
array processes
Minimum Number of Items:
0
Maximum Number of Items:2147483647
Nested Schema : processes
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
Show Source
2147483647
Nested Schema : items
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "mpoints:process" ]
-
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(optional):
integer
Minimum Value:
1
Maximum Value:65535
The TCP/IP port the process listens on -
processId(optional):
integer
Minimum Value:
1
Maximum Value:4.294967295E9
The operating system process id -
processMode:
Allowed Values:
[ "Unknown", "Classic", "Integrated", "Coordinated", "Parallel", "ParallelApplier", "ParallelMapper", "Not Applicable" ]
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
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"
}
]
}
}