Retrieve an existing Oracle GoldenGate Distribution Path Information
get
/services/{version}/sources/{distpath}/info
Request
Path Parameters
-
distpath: string
Minimum Length:
1
Maximum Length:32
Pattern:^[A-Za-z][A-Za-z0-9-_.]*$
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
Root Schema : Oracle GoldenGate Distribution Path info
Type:
object
Title:
Show Source
Oracle GoldenGate Distribution Path info
-
$schema(optional):
Allowed Values:
[ "ogg:distPathInfo" ]
-
encryptionProfile(optional):
string
Minimum Length:
1
Maximum Length:64
Pattern:^[A-Za-z0-9][A-Za-z0-9_:-]*$
Encryption Profile -
lag(optional):
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Lag in seconds between the time when extract wrote a transaction in the trail file and the time when distsrvr processes this transaction. -
lastStarted:
lastStarted
Time when the distpath was last started, if null it means that the distpath was never started and created with status 'stopped'.
-
processId:
integer
Minimum Value:
1
Maximum Value:4.294967295E9
Process id of the distsrvr process. -
sinceLagReported(optional):
integer
Minimum Value:
0
Maximum Value:4.294967295E9
Time in seconds since the lag was reported. -
sourceDatabaseInstance(optional):
string
Minimum Length:
1
Maximum Length:130
Pattern:^([^.*?"]{1,128}|["].{1,128}["])$
Instance of the database from which the trail files are produced. -
sourceDatabaseName(optional):
string
Minimum Length:
1
Maximum Length:130
Pattern:^([^.*?"]{1,128}|["].{1,128}["])$
Name of the database from which the trail files are produced. -
sourceExtractName(optional):
string
Minimum Length:
1
Maximum Length:8
Pattern:^[A-Z_$][A-Z0-9_$]*$
Name of the producer of the trail files read by this distpath. -
threadId:
integer
Minimum Value:
0
Maximum Value:9.223372036854776E18
Thread id of the distpath thread.
Nested Schema : lastStarted
Time when the distpath was last started, if null it means that the distpath was never started and created with status 'stopped'.
Match One
Show Source
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:9002/services/v2/distpaths/moriapath1/info",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:9002/services/v2/distpaths/moriapath1/info",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"threadId":1.40292288149248E14,
"processId":28934,
"$schema":"ogg:distPathInfo",
"sinceLagReported":5,
"sourceDatabaseInstance":"vlez1",
"lastStarted":"2016-10-28T01:45:50.148Z",
"sourceDatabaseName":"VLEZ1",
"sourceExtractName":"EXT1",
"lag":0
}
}