Get a list of the deployment extracts with their trail files
get
/services/{version}/exttrails
Required Role: User
Get a list of the deployment extracts with their trail filesRequest
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 List of extracts and their trail files
Type:
objectTitle:
Show Source
Oracle GoldenGate List of extracts and their trail files-
$schema:
Allowed Values:
[ "ogg:extractTrailsList" ] -
extracts(required):
array extracts
Minimum Number of Items:
0Maximum Number of Items:32767List of extracts and their trail files info
Nested Schema : extracts
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
32767List of extracts and their trail files info
Show Source
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:extractTrails" ] -
isRunning:
boolean
Default Value:
falseName of the extract -
name(required):
string
Minimum Length:
1Maximum Length:8Pattern:^[A-Z_$][A-Z0-9_$]*$Name of the extract -
trails(required):
array trails
Minimum Number of Items:
0Maximum Number of Items:32767List of trail files for this extract
Nested Schema : trails
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
32767List of trail files for this extract
Show Source
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:trail" ] -
name(required):
string
Minimum Length:
2Maximum Length:2Pattern:^[A-Za-z][A-Za-z0-9]$The name of the trail -
offset:
integer
Minimum Value:
0Maximum Value:2147483647Offset in trail sequence file -
path:
string
Minimum Length:
1Maximum Length:4096The path where trail data is stored -
remote:
boolean
Default Value:
falseIndicates if trail is local or remote -
sequence:
integer
Minimum Value:
0Maximum Value:999999999Default Value:0Trail beginning sequence number -
sequenceLength:
Default Value:
9Allowed Values:[ "6", "9" ]Number of digits in sequence file name -
sequenceLengthFlip:
boolean
Default Value:
falseIndicates sequence number length will change -
sequenceMax:
integer
Minimum Value:
0Maximum Value:999999999Default Value:0Maximum trail sequence number that exists in the deployment -
sequenceMaxInUse:
integer
Minimum Value:
0Maximum Value:999999999Default Value:0Maximum trail sequence number in use -
sequenceMin:
integer
Minimum Value:
0Maximum Value:999999999Default Value:0Minimum trail sequence number that exists in the deployment -
sequenceMinInUse:
integer
Minimum Value:
0Maximum Value:999999999Default Value:0Minimum trail sequence number in use -
sizeMB:
integer
Minimum Value:
1Maximum Value:2000Default Value:500The maximum size, in megabytes, of a file in the trail. -
spaceUsed:
integer
Minimum Value:
0Maximum Value:18446744073709552000Bytes consumed by all trail sequences
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:9002/services/v2/exttrails",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:9002/services/v2/exttrails",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:extractTrailsList",
"extracts":[
{
"isRunning":true,
"name":"EXT1",
"trails":[
{
"name":"X1",
"offset":"1448",
"sequence":"1",
"sequenceLength":"9",
"sequenceLengthFlip":false,
"sizeMB":"500"
}
]
},
{
"isRunning":true,
"name":"EXT2",
"trails":[
{
"name":"X2",
"offset":"1389",
"sequence":"0",
"sequenceLength":"9",
"sequenceLengthFlip":false,
"sizeMB":"500"
}
]
},
{
"isRunning":true,
"name":"EXT3",
"trails":[
{
"name":"X3",
"offset":"1389",
"sequence":"0",
"sequenceLength":"9",
"sequenceLengthFlip":false,
"sizeMB":"500"
},
{
"name":"X4",
"offset":"0",
"sequence":"0",
"sequenceLength":"6",
"sequenceLengthFlip":true,
"sizeMB":"500"
},
{
"name":"X5",
"offset":"0",
"sequence":"0",
"sequenceLength":"6",
"sequenceLengthFlip":true,
"sizeMB":"500"
}
]
}
]
}
}