Jump to

• Request
• Response

Retrieve an existing Oracle GoldenGate Distribution Path Information

get

/services/{version}/sources/{distpath}/info

Required Role: User

Retrieve an existing Oracle GoldenGate Distribution Path Information

Request

Path Parameters

• distpath(required): string
  Minimum Length: 1

  Maximum Length: 32

  Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$
• version(required): string

  Oracle GoldenGate Service API version.

  Allowed Values: [ "v2" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : Oracle GoldenGate Distribution Path info

Type: object

Title: Oracle GoldenGate Distribution Path info

Show Source

• $schema:
  Allowed Values: [ "ogg:distPathInfo" ]
• encryptionProfile: string
  Minimum Length: 1

  Maximum Length: 64

  Pattern: ^[A-Za-z0-9][A-Za-z0-9_:-]*$

  Encryption Profile
• lag: integer
  Minimum Value: 0

  Maximum Value: 4294967295

  Lag in seconds between the time when extract wrote a transaction in the trail file and the time when distsrvr processes this transaction.
• lastStarted(required): lastStarted
  Time when the distpath was last started, if null it means that the distpath was never started and created with status 'stopped'.
• processId(required): integer
  Minimum Value: 1

  Maximum Value: 4294967295

  Process id of the distsrvr process.
• sinceLagReported: integer
  Minimum Value: 0

  Maximum Value: 4294967295

  Time in seconds since the lag was reported.
• sourceDatabaseInstance: string
  Minimum Length: 1

  Maximum Length: 130

  Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$

  Instance of the database from which the trail files are produced.
• sourceDatabaseName: string
  Minimum Length: 1

  Maximum Length: 130

  Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$

  Name of the database from which the trail files are produced.
• sourceExtractName: 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(required): integer
  Minimum Value: 0

  Maximum Value: 9223372036854776000

  Thread id of the distpath thread.

{
    "title":"Oracle GoldenGate Distribution Path info",
    "required":[
        "processId",
        "threadId",
        "lastStarted"
    ],
    "type":"object",
    "properties":{
        "threadId":{
            "description":"Thread id of the distpath thread.",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "processId":{
            "description":"Process id of the distsrvr process.",
            "type":"integer",
            "minimum":"1",
            "maximum":"4294967295"
        },
        "encryptionProfile":{
            "description":"Encryption Profile",
            "type":"string",
            "pattern":"^[A-Za-z0-9][A-Za-z0-9_:-]*$",
            "minLength":"1",
            "maxLength":"64"
        },
        "$schema":{
            "enum":[
                "ogg:distPathInfo"
            ]
        },
        "sinceLagReported":{
            "description":"Time in seconds since the lag was reported.",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "sourceDatabaseInstance":{
            "description":"Instance of the database from which the trail files are produced.",
            "type":"string",
            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
            "minLength":"1",
            "maxLength":"130"
        },
        "lastStarted":{
            "description":"Time when the distpath was last started, if null it means that the distpath was never started and created with status 'stopped'.",
            "x-oneOf":[
                {
                    "type":"string",
                    "pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
                    "minLength":"20",
                    "maxLength":"32"
                },
                {
                    "type":"null"
                }
            ]
        },
        "sourceDatabaseName":{
            "description":"Name of the database from which the trail files are produced.",
            "type":"string",
            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
            "minLength":"1",
            "maxLength":"130"
        },
        "sourceExtractName":{
            "description":"Name of the producer of the trail files read by this distpath.",
            "type":"string",
            "pattern":"^[A-Z_$][A-Z0-9_$]*$",
            "minLength":"1",
            "maxLength":"8"
        },
        "lag":{
            "description":"Lag in seconds between the time when extract wrote a transaction in the trail file and the time when distsrvr processes this transaction.",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        }
    },
    "additionalProperties":false
}

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

• string
  Minimum Length: 20

  Maximum Length: 32

  Pattern: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$
• null

{
    "description":"Time when the distpath was last started, if null it means that the distpath was never started and created with status 'stopped'.",
    "x-oneOf":[
        {
            "type":"string",
            "pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
            "minLength":"20",
            "maxLength":"32"
        },
        {
            "type":"null"
        }
    ]
}

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":"140292288149248",
        "processId":"28934",
        "$schema":"ogg:distPathInfo",
        "sinceLagReported":"5",
        "sourceDatabaseInstance":"vlez1",
        "lastStarted":"2016-10-28T01:45:50.148Z",
        "sourceDatabaseName":"VLEZ1",
        "sourceExtractName":"EXT1",
        "lag":"0"
    }
}

Back to Top