1. Oracle GoldenGate
  2. Tasks
  3. Distribution Server

Get a list of the deployment extracts with their trail files

get

/services/{version}/exttrails

Request

Path Parameters

Response

Supported Media Types

200 Response

Body ()
Root Schema : Oracle GoldenGate List of extracts and their trail files
Type: object
Title: Oracle GoldenGate List of extracts and their trail files
Show Source
  • Allowed Values: [ "ogg:extractTrailsList" ]
  • extracts
    Minimum Number of Items: 0
    Maximum Number of Items: 32767
    List of extracts and their trail files info
Nested Schema : extracts
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
List of extracts and their trail files info
Show Source
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "ogg:extractTrails" ]
  • Default Value: false
    Name of the extract
  • Minimum Length: 1
    Maximum Length: 8
    Pattern: ^[A-Z_$][A-Z0-9_$]*$
    Name of the extract
  • trails
    Minimum Number of Items: 0
    Maximum Number of Items: 32767
    List of trail files for this extract
Nested Schema : trails
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
List of trail files for this extract
Show Source
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "ogg:trail" ]
  • Minimum Length: 1
    Maximum Length: 2
    Pattern: ^[A-Za-z][A-Za-z0-9]?$
    The name of the trail
  • Minimum Value: 0
    Maximum Value: 2147483647
    Offset in trail sequence file
  • Minimum Length: 1
    Maximum Length: 255
    The path where trail data is stored
  • Default Value: false
    Indicates if trail is local or remote
  • Minimum Value: 0
    Maximum Value: 999999999
    Default Value: 0
    Trail beginning sequence number
  • Default Value: 9
    Allowed Values: [ 6, 9 ]
    Number of digits in sequence file name
  • Default Value: false
    Indicates sequence number length will change
  • Minimum Value: 1
    Maximum Value: 2000
    Default Value: 500
    The maximum size, in megabytes, of a file in the trail.
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
                    }
                ]
            }
        ]
    }
}