1. Oracle GoldenGate Microservices REST API
  2. Tasks
  3. Administration Service
  4. Trails

List Trails

get

/services/{version}/trails

Required Role: User

Retrieve a collection of all known trails

Request

Path Parameters
Query Parameters

  • When provided, the returned collection includes a "details" property for each trail item.

Back to Top

Response

Supported Media Types

200 Response

Collection of Trails retrieved successfully.

Body ()
Root Schema : Oracle GoldenGate Trail Collection
Type: object
Title: Oracle GoldenGate Trail Collection
Show Source
Nested Schema : items
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : items-allOf[0]
Type: object
Additional Properties Allowed: true
Show Source
Nested Schema : items-allOf[1]
Type: object
Additional Properties Allowed: true
Show Source
Nested Schema : status
Item status
Match Any
Show Source
  • Allowed Values: [ "starting", "running", "stopped", "killed", "abended" ]
  • Default Value: stopped
    Allowed Values: [ "paused", "running", "stopping", "stopped", "killed", "uninitialized" ]
Nested Schema : details
Type: object
Show Source
  • Allowed Values: [ "ogg:trail" ]
  • Minimum Length: 2
    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: 4096
    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: 0
    Maximum Value: 999999999
    Default Value: 0
    Maximum trail sequence number that exists in the deployment
  • Minimum Value: 0
    Maximum Value: 999999999
    Default Value: 0
    Maximum trail sequence number in use
  • Minimum Value: 0
    Maximum Value: 999999999
    Default Value: 0
    Minimum trail sequence number that exists in the deployment
  • Minimum Value: 0
    Maximum Value: 999999999
    Default Value: 0
    Minimum trail sequence number in use
  • Minimum Value: 1
    Maximum Value: 2000
    Default Value: 500
    The maximum size, in megabytes, of a file in the trail.
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Bytes consumed by all trail sequences
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "rel":"canonical",
            "href":"http://localhost:25001/services/v2/trails",
            "mediaType":"application/json"
        },
        {
            "rel":"self",
            "href":"http://localhost:25001/services/v2/trails",
            "mediaType":"application/json"
        },
        {
            "rel":"describedby",
            "href":"http://localhost:25001/services/v2/metadata-catalog/trails",
            "mediaType":"application/schema+json"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:trailCollection",
        "items":[
            {
                "links":[
                    {
                        "rel":"parent",
                        "href":"http://localhost:25001/services/v2/trails",
                        "mediaType":"application/json"
                    }
                ],
                "$schema":"ogg:collectionItem",
                "name":"a1",
                "details":{
                    "name":"a1",
                    "path":"a1_subdir",
                    "$schema":"ogg:trail",
                    "sequenceMinInUse":"1",
                    "sequenceMaxInUse":"2",
                    "spaceUsed":"412767",
                    "sequenceMin":"0",
                    "sequenceMax":"2"
                }
            },
            {
                "links":[
                    {
                        "rel":"parent",
                        "href":"http://localhost:25001/services/v2/trails",
                        "mediaType":"application/json"
                    }
                ],
                "$schema":"ogg:collectionItem",
                "name":"b1",
                "details":{
                    "name":"b1",
                    "$schema":"ogg:trail",
                    "spaceUsed":"825534",
                    "sequenceMin":"0",
                    "sequenceMax":"5"
                }
            }
        ]
    }
}
Back to Top