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" ] -
description:
string
Minimum Length:
1Maximum Length:4095Description for the trail -
name:
string
Minimum Length:
2Maximum Length:2Pattern:^[A-Za-z][A-Za-z0-9]$The two-character 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 -
processRef:
array processRef
Minimum Number of Items:
1Maximum Number of Items:5000List of all processes associated with this trail -
remote:
boolean
Default Value:
falseIndicates if trail is local or remote -
sequence:
integer
Minimum Value:
0Maximum Value:999999999Default Value:0Trail beginning sequence number -
sequenceLastArchived:
array sequenceLastArchived
Minimum Number of Items:
1Maximum Number of Items:128Last sequence number archived (Managed Trails only) -
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 -
trailName:
string
Minimum Length:
3Maximum Length:512Pattern:^[a-zA-Z0-9_#$/-]*$The optional 'user-friendly' name for the trail
Nested Schema : processRef
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
5000List of all processes associated with this trail
Show Source
-
Array of:
object items
A reference to an OGG process associated with this managed trail
Nested Schema : sequenceLastArchived
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
128Last sequence number archived (Managed Trails only)
Show Source
Nested Schema : items
Type:
objectA reference to an OGG process associated with this managed trail
Show Source
-
processName(required):
processName
-
processType(required):
Allowed Values:
[ "extract", "replicat", "distpath", "recvpath" ]
Nested Schema : items
Type:
Show Source
object-
archiveTarget(required):
archiveTarget
The location where the trail sequences were archived
-
sequence(required):
integer
Minimum Value:
0Maximum Value:999999999Default Value:0Last sequence number archived by the associated task -
taskName:
string
Minimum Length:
1Maximum Length:64Pattern:^[A-Za-z0-9][A-Za-z0-9_-]*$The name of the task which archived trail sequences
Nested Schema : archiveTarget
The location where the trail sequences were archived
Match One
Show Source
-
string
Minimum Length:
1Maximum Length:4096Filesystem directory where trail sequences are stored -
object archiveTarget-x-oneOf[1]
OCI Object Storage Bucket
-
object archiveTarget-x-oneOf[2]
S3-compatible object storage bucket
Nested Schema : archiveTarget-x-oneOf[1]
Type:
objectOCI Object Storage Bucket
Show Source
-
authentication(required):
authentication
-
bucketName(required):
string
Minimum Length:
1Maximum Length:1024The name of the Object Storage bucket -
nameSpace(required):
string
Minimum Length:
1Maximum Length:256The OCI Object Storage namespace
Nested Schema : archiveTarget-x-oneOf[2]
Type:
objectS3-compatible object storage bucket
Show Source
-
authentication:
authentication
-
bucketName(required):
string
Minimum Length:
1Maximum Length:1024The name of the S3-compatible bucket -
region:
string
Minimum Length:
1Maximum Length:256The optional region for the S3-compatible bucket
Nested Schema : authentication
Match One
Show Source
-
object authentication-x-oneOf[0]
Authentication using a named profile from the default profile configuration file
-
object authentication-x-oneOf[1]
Authentication for OCI using an instance principal
-
object authentication-x-oneOf[2]
Authentication for OCI using an API signing key for a user
Nested Schema : authentication-x-oneOf[0]
Type:
objectAuthentication using a named profile from the default profile configuration file
Show Source
-
profile(required):
string
Minimum Length:
1Maximum Length:256Name of the profile to use
Nested Schema : authentication-x-oneOf[1]
Type:
objectAuthentication for OCI using an instance principal
Show Source
-
instancePrincipal(required):
Allowed Values:
[ true ]Indicates the instance principal should be used for authentication
Nested Schema : authentication-x-oneOf[2]
Type:
objectAuthentication for OCI using an API signing key for a user
Show Source
-
apiSigningKey(required):
string
Minimum Length:
1Maximum Length:10240Pattern:^-----BEGIN RSA PRIVATE KEY----- ([A-Za-z0-9+/= ])+ -----END RSA PRIVATE KEY-----Unencrypted API signing key -
apiSigningKeyFingerprint(required):
string
Minimum Length:
47Maximum Length:47Pattern:^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$Fingerprint of the API signing key -
tenancyId(required):
string
Minimum Length:
1Maximum Length:256Pattern:^ocid1[.]tenancy[.].*OCI tenancy OCID -
userId(required):
string
Minimum Length:
1Maximum Length:256Pattern:^ocid1[.]user[.].*OCI user OCID
Nested Schema : authentication
Match One
Show Source
-
object authentication-x-oneOf[0]
Authentication using a named profile from the default profile configuration file
-
object authentication-x-oneOf[1]
S3 Authentication using secrets
Nested Schema : authentication-x-oneOf[0]
Type:
objectAuthentication using a named profile from the default profile configuration file
Show Source
-
profile(required):
string
Minimum Length:
1Maximum Length:256Name of the profile to use
Nested Schema : authentication-x-oneOf[1]
Type:
objectS3 Authentication using secrets
Show Source
-
accessKeyId(required):
string
Minimum Length:
1Maximum Length:256S3 access key -
secretKey(required):
string
Minimum Length:
1Maximum Length:256S3 secret key
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"
}
]
}
]
}
}