Oracle GoldenGate

Retrieve an existing Distribution Server Network Statistics

get

/services/{version}/mpoints/{item}/distsrvrNetworkStats

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 Distribution Server Network statistics

Type: object

Title: Oracle GoldenGate Distribution Server Network statistics

Show Source

$schema:

Allowed Values: [ "mpoints:distsrvrNetworkStats" ]
statistics: array statistics

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

{
    "title":"Oracle GoldenGate Distribution Server Network statistics",
    "required":[
        "statistics"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "mpoints:distsrvrNetworkStats"
            ]
        },
        "statistics":{
            "type":"array",
            "minItems":0,
            "maxItems":2147483647,
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Path Name",
                        "type":"string",
                        "minLength":1,
                        "maxLength":240
                    },
                    "receiveWaitTime":{
                        "description":"Receive Wait Time",
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "sendWaitTime":{
                        "description":"Send Wait Time",
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "totalBytesReceived":{
                        "description":"Total Number of Bytes Received",
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "totalBytesSent":{
                        "description":"Total Number of Bytes Sent",
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "totalMessagesReceived":{
                        "description":"Total Number of Messages Received",
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "totalMessagesSent":{
                        "description":"Total Number of Messages Sent",
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    }
                },
                "additionalProperties":false
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : statistics

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

Show Source

[0]: object items

{
    "type":"array",
    "minItems":0,
    "maxItems":2147483647,
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"Path Name",
                "type":"string",
                "minLength":1,
                "maxLength":240
            },
            "receiveWaitTime":{
                "description":"Receive Wait Time",
                "type":"integer",
                "minimum":0,
                "maximum":9.223372036854776E18
            },
            "sendWaitTime":{
                "description":"Send Wait Time",
                "type":"integer",
                "minimum":0,
                "maximum":9.223372036854776E18
            },
            "totalBytesReceived":{
                "description":"Total Number of Bytes Received",
                "type":"integer",
                "minimum":0,
                "maximum":9.223372036854776E18
            },
            "totalBytesSent":{
                "description":"Total Number of Bytes Sent",
                "type":"integer",
                "minimum":0,
                "maximum":9.223372036854776E18
            },
            "totalMessagesReceived":{
                "description":"Total Number of Messages Received",
                "type":"integer",
                "minimum":0,
                "maximum":9.223372036854776E18
            },
            "totalMessagesSent":{
                "description":"Total Number of Messages Sent",
                "type":"integer",
                "minimum":0,
                "maximum":9.223372036854776E18
            }
        },
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

name: string

Minimum Length: 1

Maximum Length: 240

Path Name
receiveWaitTime: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Receive Wait Time
sendWaitTime: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Send Wait Time
totalBytesReceived: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Total Number of Bytes Received
totalBytesSent: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Total Number of Bytes Sent
totalMessagesReceived: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Total Number of Messages Received
totalMessagesSent: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Total Number of Messages Sent

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Path Name",
            "type":"string",
            "minLength":1,
            "maxLength":240
        },
        "receiveWaitTime":{
            "description":"Receive Wait Time",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "sendWaitTime":{
            "description":"Send Wait Time",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "totalBytesReceived":{
            "description":"Total Number of Bytes Received",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "totalBytesSent":{
            "description":"Total Number of Bytes Sent",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "totalMessagesReceived":{
            "description":"Total Number of Messages Received",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "totalMessagesSent":{
            "description":"Total Number of Messages Sent",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "response":{
        "$schema":"mpoints:distsrvrNetworkStats",
        "statistics":[
            {
                "name":"PROD.PATH.1",
                "receiveWaitTime":49623007,
                "sendWaitTime":2948763,
                "totalBytesReceived":32767001,
                "totalBytesSent":10241024,
                "totalMessagesReceived":104,
                "totalMessagesSent":23
            },
            {
                "name":"PROD.PATH.2",
                "receiveWaitTime":29623007,
                "sendWaitTime":1948763,
                "totalBytesReceived":3767001,
                "totalBytesSent":5241024,
                "totalMessagesReceived":34,
                "totalMessagesSent":11
            }
        ]
    },
    "messages":[
    ],
    "links":[
    ]
}