Jump to

• Request
• Response

Retrieve an existing PM Service Collector Statistics

get

/services/{version}/mpoints/{item}/pmsrvrStats

Request

Path Parameters

• item: string
  Minimum Length: 1

  Maximum Length: 32
• version: 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 PM Server Collector Statistics

Type: object

Title: Oracle GoldenGate PM Server Collector Statistics

Show Source

• $schema(optional):
  Allowed Values: [ "mpoints:pmsrvrStats" ]
• bytesReceived(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Total Number of Bytes Received
• dataStoreType(optional): string
  Minimum Length: 1

  Maximum Length: 16

  Collector Data Store Type
• invalidPackets(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Total Number of Invalid Packets
• maxPacketSize(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Maximum Packet Size Received
• minPacketSize(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Minimum Packet Size Received
• missingPackets(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Total Number of Dropped Packets
• packetsReceived(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Total Number of Packets Received
• receiveErrors(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Number of Receive Errors
• sequenceErrors(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Total Number of Packet Sequencing Errors
• udpBufferSize(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Collector Receive Buffer Size
• udpPort(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Collector UDP Port

{
    "title":"Oracle GoldenGate PM Server Collector Statistics",
    "type":"object",
    "properties":{
        "dataStoreType":{
            "description":"Collector Data Store Type",
            "type":"string",
            "minLength":1,
            "maxLength":16
        },
        "maxPacketSize":{
            "description":"Maximum Packet Size Received",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "minPacketSize":{
            "description":"Minimum Packet Size Received",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "packetsReceived":{
            "description":"Total Number of Packets Received",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "invalidPackets":{
            "description":"Total Number of Invalid Packets",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "$schema":{
            "enum":[
                "mpoints:pmsrvrStats"
            ]
        },
        "missingPackets":{
            "description":"Total Number of Dropped Packets",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "udpPort":{
            "description":"Collector UDP Port",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "bytesReceived":{
            "description":"Total Number of Bytes Received",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "receiveErrors":{
            "description":"Number of Receive Errors",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "udpBufferSize":{
            "description":"Collector Receive Buffer Size",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "sequenceErrors":{
            "description":"Total Number of Packet Sequencing Errors",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "response":{
        "dataStoreType":"BDB",
        "maxPacketSize":32767,
        "minPacketSize":1024,
        "packetsReceived":12345,
        "invalidPackets":1,
        "$schema":"mpoints:pmsrvrStats",
        "missingPackets":12,
        "udpPort":7330,
        "bytesReceived":9876543,
        "receiveErrors":0,
        "udpBufferSize":32767,
        "sequenceErrors":3
    },
    "messages":[
    ],
    "links":[
    ]
}

Back to Top