Retrieve Status
get
/services/{version}/extracts/{extract}/info/status
Retrieve the current status of the extract process.
Request
Path Parameters
-
extract: string
Minimum Length:
1
Maximum Length:8
Pattern:^[A-Z_$][A-Z0-9_$]*$
The name of the extract. Extract 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 : Extract process status
Type:
object
Title:
Show Source
Extract process status
-
$schema:
Allowed Values:
[ "ogg:extractStatus" ]
-
lag:
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Process lag in seconds -
lastStarted:
lastStarted
-
position:
position
-
processId:
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" ]
Nested Schema : position
Match One
Show Source
-
position-x-oneOf[0]
-
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])$
-
position-x-oneOf[2]
Nested Schema : position-x-oneOf[2]
Match One
Show Source
-
object position-x-oneOf[2]-x-oneOf[0]
Position in archive logs (classic mode, non-threaded)
-
object position-x-oneOf[2]-x-oneOf[1]
Position in archive logs (classic mode, threaded)
-
object position-x-oneOf[2]-x-oneOf[2]
Position at a specific SCN (integrated mode)
Nested Schema : position-x-oneOf[2]-x-oneOf[0]
Type:
object
Position in archive logs (classic mode, non-threaded)
Show Source
-
rba:
integer
Minimum Value:
0
Maximum Value:2147483647
Default Value:0
-
seqno:
integer
Minimum Value:
1
Maximum Value:4.294967295E9
Default Value:1
Match Any
Show Source
Nested Schema : position-x-oneOf[2]-x-oneOf[1]
Type:
object
Position in archive logs (classic mode, threaded)
Show Source
-
positions:
array positions
Minimum Number of Items:
1
Maximum Number of Items:100
Nested Schema : position-x-oneOf[2]-x-oneOf[2]
Type:
object
Position at a specific SCN (integrated mode)
Show Source
Nested Schema : positions
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
100
-
[0]:
object items
Position in archive logs for one thread in a classic extract
Nested Schema : items
Type:
object
Position in archive logs for one thread in a classic extract
Show Source
-
position:
position
-
thread:
integer
Minimum Value:
1
Maximum Value:100
Nested Schema : position
Match One
Show Source
-
Allowed Values:
[ "now" ]
-
position-x-oneOf[1]
-
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])$
-
object position-x-oneOf[3]
Position in archive logs (classic mode, non-threaded)
Nested Schema : position-x-oneOf[3]
Type:
object
Position in archive logs (classic mode, non-threaded)
Show Source
-
rba:
integer
Minimum Value:
0
Maximum Value:2147483647
Default Value:0
-
seqno:
integer
Minimum Value:
1
Maximum Value:4.294967295E9
Default Value:1
Match Any
Show Source
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/extracts/EXT2/info/status",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/extracts/EXT2/info/status",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/extractStatus",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:extractStatus",
"lag":0,
"lastStarted":"2017-12-14T12:42:36.350Z",
"position":"0.1543170",
"processId":1642,
"sinceLagReported":0,
"status":"running"
}
}