Oracle GoldenGate

Retrieve an existing Output Trail File Statistics

get

/services/{version}/mpoints/{item}/trailOutput

Request

Path Parameters

item: string

Minimum Length: 1

Maximum Length: 32
version: string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Root Schema : Oracle GoldenGate Output trail description

Type: object

Title: Oracle GoldenGate Output trail description

Show Source

$schema:

Allowed Values: [ "mpoints:trailOutput" ]
hostname: hostname

The host name for a remote trail
ioWriteBytes: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Number of I/O Write Bytes Transfered
ioWriteCount: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Number of I/O Write Operations
portNumber: integer

Minimum Value: 1

Maximum Value: 65535

The TCP/IP port for the remote trail
portType:

Allowed Values: [ "LocalTrail", "Manager", "ServerCollector" ]

The type of port connection
trailBufferFlushes: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Number trail file buffer flushes
trailBufferFlushTime: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Time spent flushing trail file buffers
trailBytesFlushed: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Number of bytes flushed from trail file buffers
trailLastBufferFlushTs: trailLastBufferFlushTs

Last trail file buffer flush time stamp
trailLobBytes: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Number of LOB bytes write in trail file
trailMaxBytes: integer

Minimum Value: 0

Maximum Value: 4.294967295E9

Max Number of Bytes for a Trail file
trailName: string

Minimum Length: 1

Maximum Length: 16

The base name of the trail
trailPath: string

Minimum Length: 1

Maximum Length: 512

The path for storing the trail
trailRba: integer

Minimum Value: 0

Maximum Value: 4.294967295E9

Current RBA
trailSeq: integer

Minimum Value: 0

Maximum Value: 4.294967295E9

Current Sequence
trailWriteTime: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Time spent in write of trail file

{
    "title":"Oracle GoldenGate Output trail description",
    "type":"object",
    "properties":{
        "trailBufferFlushTime":{
            "description":"Time spent flushing trail file buffers",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "hostname":{
            "description":"The host name for a remote trail",
            "x-oneOf":[
                {
                    "description":"Network host name",
                    "type":"string",
                    "pattern":"^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$",
                    "minLength":1,
                    "maxLength":4095
                },
                {
                    "description":"Network IPv4 address",
                    "type":"string",
                    "pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
                    "minLength":7,
                    "maxLength":15
                },
                {
                    "description":"Network IPv6 address",
                    "type":"string",
                    "pattern":"^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$",
                    "minLength":1,
                    "maxLength":256
                }
            ]
        },
        "trailBytesFlushed":{
            "description":"Number of bytes flushed from trail file buffers",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "ioWriteCount":{
            "description":"Number of I/O Write Operations",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "trailName":{
            "description":"The base name of the trail",
            "type":"string",
            "minLength":1,
            "maxLength":16
        },
        "trailRba":{
            "description":"Current RBA",
            "type":"integer",
            "minimum":0,
            "maximum":4.294967295E9
        },
        "ioWriteBytes":{
            "description":"Number of I/O Write Bytes Transfered",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "trailPath":{
            "description":"The path for storing the trail",
            "type":"string",
            "minLength":1,
            "maxLength":512
        },
        "portType":{
            "description":"The type of port connection",
            "enum":[
                "LocalTrail",
                "Manager",
                "ServerCollector"
            ]
        },
        "$schema":{
            "enum":[
                "mpoints:trailOutput"
            ]
        },
        "portNumber":{
            "description":"The TCP/IP port for the remote trail",
            "type":"integer",
            "minimum":1,
            "maximum":65535
        },
        "trailMaxBytes":{
            "description":"Max Number of Bytes for a Trail file",
            "type":"integer",
            "minimum":0,
            "maximum":4.294967295E9
        },
        "trailLobBytes":{
            "description":"Number of LOB bytes write in trail file",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "trailBufferFlushes":{
            "description":"Number trail file buffer flushes",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "trailWriteTime":{
            "description":"Time spent in write of trail file",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "trailSeq":{
            "description":"Current Sequence",
            "type":"integer",
            "minimum":0,
            "maximum":4.294967295E9
        },
        "trailLastBufferFlushTs":{
            "description":"Last trail file buffer flush time stamp",
            "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"
                }
            ]
        }
    },
    "additionalProperties":false
}

Nested Schema : hostname

The host name for a remote trail

Match One

Show Source

string

Minimum Length: 1

Maximum Length: 4095

Pattern: ^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$

Network host name
string

Minimum Length: 7

Maximum Length: 15

Pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

Network IPv4 address
string

Minimum Length: 1

Maximum Length: 256

Pattern: ^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$

Network IPv6 address

{
    "description":"The host name for a remote trail",
    "x-oneOf":[
        {
            "description":"Network host name",
            "type":"string",
            "pattern":"^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$",
            "minLength":1,
            "maxLength":4095
        },
        {
            "description":"Network IPv4 address",
            "type":"string",
            "pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
            "minLength":7,
            "maxLength":15
        },
        {
            "description":"Network IPv6 address",
            "type":"string",
            "pattern":"^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$",
            "minLength":1,
            "maxLength":256
        }
    ]
}

Nested Schema : trailLastBufferFlushTs

Last trail file buffer flush time stamp

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":"Last trail file buffer flush time stamp",
    "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",
    "response":{
        "trailBufferFlushTime":0,
        "hostname":"slc03flg",
        "trailBytesFlushed":160119,
        "ioWriteCount":1,
        "trailName":"aa",
        "trailRba":1530,
        "ioWriteBytes":61,
        "trailPath":"/net/slc03flg/scratch/jdivinc/view_storage/jdivinc_db1/tklocal/ggora/dirdat",
        "portType":"LocalTrail",
        "$schema":"mpoints:trailOutput",
        "portNumber":0,
        "trailMaxBytes":20000000,
        "trailLobBytes":0,
        "trailBufferFlushes":61405,
        "trailWriteTime":0,
        "trailSeq":20,
        "trailLastBufferFlushTs":"2015-06-10T11:06:57.024Z"
    },
    "messages":[
    ],
    "links":[
    ]
}