Retrieve Status
get
/services/{version}/replicats/{replicat}/info/status
Retrieve the current status of the replicat process.
Request
Path Parameters
-
replicat: string
Minimum Length:
1
Maximum Length:8
Pattern:^[A-Z_$][A-Z0-9_$]*$
The name of the replicat. Replicat names are upper case, begin with an alphabetic character followed by up to seven alpha-numeric characters.
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
Process status retrieved successfully.
Root Schema : Replicat process status
Type:
object
Title:
Show Source
Replicat process status
-
$schema(optional):
Allowed Values:
[ "ogg:replicatStatus" ]
-
lag:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Process lag in seconds -
lastStarted:
lastStarted
-
position(optional):
position
-
processId(optional):
integer
Minimum Value:
1
Maximum Value:4.294967295E9
-
sinceLagReported:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Time in seconds since process lag was reported -
status:
Allowed Values:
[ "starting", "running", "stopped", "killed", "abended" ]
-
synchronized(optional):
boolean
Nested Schema : position-x-oneOf[0]
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:trailPosition" ]
-
name:
string
Minimum Length:
2
Maximum Length:2
Pattern:^[A-Za-z][A-Za-z0-9]$
The name of the trail -
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Default Value:0
Offset in trail sequence file -
path(optional):
string
Minimum Length:
1
Maximum Length:4096
The path where trail data is stored -
sequence:
integer
Minimum Value:
0
Maximum Value:999999999
Default Value:0
Trail file sequence number
Nested Schema : position-x-oneOf[1]
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:filePosition" ]
-
name:
string
Minimum Length:
1
Maximum Length:4096
The name of the file -
offset:
integer
Minimum Value:
0
Maximum Value:2147483647
Offset in file -
path:
string
Minimum Length:
1
Maximum Length:4096
The path where file data is stored
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/replicats/REP2/info/status",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/replicats/REP2/info/status",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/replicatStatus",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:replicatStatus",
"lag":0,
"lastStarted":"2021-07-13T16:38:52.479Z",
"position":{
"name":"X2",
"offset":4528,
"path":"/u02/ogg/Local/var/lib/data/",
"sequence":0
},
"processId":1904,
"sinceLagReported":3,
"status":"running"
}
}