Jump to

• Request
• Response

Retrieve an existing Distribution Service Path Statistics

get

/services/{version}/mpoints/{item}/distsrvrPathStats

Required Role: User

Retrieve an existing Distribution Service Path Statistics

Request

Path Parameters

• item(required): string
  Minimum Length: 1

  Maximum Length: 32
• 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 Server Path statistics

Type: object

Title: Oracle GoldenGate Distribution Server Path statistics

Show Source

• $schema:
  Allowed Values: [ "mpoints:distsrvrPathStats" ]
• statistics(required): array statistics
  Minimum Number of Items: 0

  Maximum Number of Items: 2147483647

{
    "title":"Oracle GoldenGate Distribution Server Path statistics",
    "required":[
        "statistics"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "mpoints:distsrvrPathStats"
            ]
        },
        "statistics":{
            "type":"array",
            "minItems":0,
            "maxItems":2147483647,
            "items":{
                "type":"object",
                "properties":{
                    "totalInserts":{
                        "description":"Total Number of Inserts",
                        "type":"integer",
                        "minimum":0,
                        "maximum":"9223372036854776000"
                    },
                    "totalUpserts":{
                        "description":"Total Number of Upserts",
                        "type":"integer",
                        "minimum":0,
                        "maximum":"9223372036854776000"
                    },
                    "totalOthers":{
                        "description":"Total Number of Other Commands",
                        "type":"integer",
                        "minimum":0,
                        "maximum":"9223372036854776000"
                    },
                    "name":{
                        "description":"Path Name",
                        "type":"string",
                        "minLength":1,
                        "maxLength":240
                    },
                    "status":{
                        "description":"Path Status",
                        "enum":[
                            "paused",
                            "running",
                            "stopping",
                            "stopped",
                            "killed",
                            "uninitialized"
                        ],
                        "default":"stopped"
                    },
                    "targetInitiated":{
                        "description":"Indicates that this path is target initiated",
                        "type":"boolean"
                    },
                    "totalDeletes":{
                        "description":"Total Number of Deletes",
                        "type":"integer",
                        "minimum":0,
                        "maximum":"9223372036854776000"
                    },
                    "lcrsReceived":{
                        "description":"Number of LCRs Received",
                        "type":"integer",
                        "minimum":0,
                        "maximum":"9223372036854776000"
                    },
                    "dataStreaming":{
                        "description":"Indicates that this is a data stream",
                        "type":"boolean"
                    },
                    "totalDDLs":{
                        "description":"Total Number of DDLs",
                        "type":"integer",
                        "minimum":0,
                        "maximum":"9223372036854776000"
                    },
                    "lastStarted":{
                        "description":"Timestamp of the last time started.",
                        "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"
                            }
                        ]
                    },
                    "totalProcedures":{
                        "description":"Total Number of Procedures",
                        "type":"integer",
                        "minimum":0,
                        "maximum":"9223372036854776000"
                    },
                    "totalUpdates":{
                        "description":"Total Number of Updates",
                        "type":"integer",
                        "minimum":0,
                        "maximum":"9223372036854776000"
                    },
                    "lcrsSent":{
                        "description":"Number of LCRs Sent",
                        "type":"integer",
                        "minimum":0,
                        "maximum":"9223372036854776000"
                    },
                    "lag":{
                        "description":"Process lag in seconds",
                        "type":"integer",
                        "minimum":0,
                        "maximum":"9223372036854776000"
                    }
                },
                "additionalProperties":false
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : statistics

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

Show Source

• Array of: object items

{
    "type":"array",
    "minItems":0,
    "maxItems":2147483647,
    "items":{
        "type":"object",
        "properties":{
            "totalInserts":{
                "description":"Total Number of Inserts",
                "type":"integer",
                "minimum":0,
                "maximum":"9223372036854776000"
            },
            "totalUpserts":{
                "description":"Total Number of Upserts",
                "type":"integer",
                "minimum":0,
                "maximum":"9223372036854776000"
            },
            "totalOthers":{
                "description":"Total Number of Other Commands",
                "type":"integer",
                "minimum":0,
                "maximum":"9223372036854776000"
            },
            "name":{
                "description":"Path Name",
                "type":"string",
                "minLength":1,
                "maxLength":240
            },
            "status":{
                "description":"Path Status",
                "enum":[
                    "paused",
                    "running",
                    "stopping",
                    "stopped",
                    "killed",
                    "uninitialized"
                ],
                "default":"stopped"
            },
            "targetInitiated":{
                "description":"Indicates that this path is target initiated",
                "type":"boolean"
            },
            "totalDeletes":{
                "description":"Total Number of Deletes",
                "type":"integer",
                "minimum":0,
                "maximum":"9223372036854776000"
            },
            "lcrsReceived":{
                "description":"Number of LCRs Received",
                "type":"integer",
                "minimum":0,
                "maximum":"9223372036854776000"
            },
            "dataStreaming":{
                "description":"Indicates that this is a data stream",
                "type":"boolean"
            },
            "totalDDLs":{
                "description":"Total Number of DDLs",
                "type":"integer",
                "minimum":0,
                "maximum":"9223372036854776000"
            },
            "lastStarted":{
                "description":"Timestamp of the last time started.",
                "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"
                    }
                ]
            },
            "totalProcedures":{
                "description":"Total Number of Procedures",
                "type":"integer",
                "minimum":0,
                "maximum":"9223372036854776000"
            },
            "totalUpdates":{
                "description":"Total Number of Updates",
                "type":"integer",
                "minimum":0,
                "maximum":"9223372036854776000"
            },
            "lcrsSent":{
                "description":"Number of LCRs Sent",
                "type":"integer",
                "minimum":0,
                "maximum":"9223372036854776000"
            },
            "lag":{
                "description":"Process lag in seconds",
                "type":"integer",
                "minimum":0,
                "maximum":"9223372036854776000"
            }
        },
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

• dataStreaming: boolean
  Indicates that this is a data stream
• lag: integer
  Minimum Value: 0

  Maximum Value: 9223372036854776000

  Process lag in seconds
• lastStarted: lastStarted
  Timestamp of the last time started.
• lcrsReceived: integer
  Minimum Value: 0

  Maximum Value: 9223372036854776000

  Number of LCRs Received
• lcrsSent: integer
  Minimum Value: 0

  Maximum Value: 9223372036854776000

  Number of LCRs Sent
• name: string
  Minimum Length: 1

  Maximum Length: 240

  Path Name
• status:
  Default Value: stopped

  Allowed Values: [ "paused", "running", "stopping", "stopped", "killed", "uninitialized" ]

  Path Status
• targetInitiated: boolean
  Indicates that this path is target initiated
• totalDDLs: integer
  Minimum Value: 0

  Maximum Value: 9223372036854776000

  Total Number of DDLs
• totalDeletes: integer
  Minimum Value: 0

  Maximum Value: 9223372036854776000

  Total Number of Deletes
• totalInserts: integer
  Minimum Value: 0

  Maximum Value: 9223372036854776000

  Total Number of Inserts
• totalOthers: integer
  Minimum Value: 0

  Maximum Value: 9223372036854776000

  Total Number of Other Commands
• totalProcedures: integer
  Minimum Value: 0

  Maximum Value: 9223372036854776000

  Total Number of Procedures
• totalUpdates: integer
  Minimum Value: 0

  Maximum Value: 9223372036854776000

  Total Number of Updates
• totalUpserts: integer
  Minimum Value: 0

  Maximum Value: 9223372036854776000

  Total Number of Upserts

{
    "type":"object",
    "properties":{
        "totalInserts":{
            "description":"Total Number of Inserts",
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000"
        },
        "totalUpserts":{
            "description":"Total Number of Upserts",
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000"
        },
        "totalOthers":{
            "description":"Total Number of Other Commands",
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000"
        },
        "name":{
            "description":"Path Name",
            "type":"string",
            "minLength":1,
            "maxLength":240
        },
        "status":{
            "description":"Path Status",
            "enum":[
                "paused",
                "running",
                "stopping",
                "stopped",
                "killed",
                "uninitialized"
            ],
            "default":"stopped"
        },
        "targetInitiated":{
            "description":"Indicates that this path is target initiated",
            "type":"boolean"
        },
        "totalDeletes":{
            "description":"Total Number of Deletes",
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000"
        },
        "lcrsReceived":{
            "description":"Number of LCRs Received",
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000"
        },
        "dataStreaming":{
            "description":"Indicates that this is a data stream",
            "type":"boolean"
        },
        "totalDDLs":{
            "description":"Total Number of DDLs",
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000"
        },
        "lastStarted":{
            "description":"Timestamp of the last time started.",
            "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"
                }
            ]
        },
        "totalProcedures":{
            "description":"Total Number of Procedures",
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000"
        },
        "totalUpdates":{
            "description":"Total Number of Updates",
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000"
        },
        "lcrsSent":{
            "description":"Number of LCRs Sent",
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000"
        },
        "lag":{
            "description":"Process lag in seconds",
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000"
        }
    },
    "additionalProperties":false
}

Nested Schema : lastStarted

Timestamp of the last time started.

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":"Timestamp of the last time started.",
    "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":{
        "$schema":"mpoints:distsrvrPathStats",
        "statistics":[
            {
                "totalInserts":10,
                "totalOthers":2,
                "name":"PROD.PATH.1",
                "totalDeletes":30,
                "lcrsReceived":96,
                "totalDDLs":0,
                "totalProcedures":0,
                "totalUpdates":20,
                "lcrsSent":10
            },
            {
                "totalInserts":5,
                "totalOthers":1,
                "name":"PROD.PATH.2",
                "totalDeletes":0,
                "lcrsReceived":43,
                "totalDDLs":0,
                "totalProcedures":0,
                "totalUpdates":2,
                "lcrsSent":15
            }
        ]
    },
    "messages":[
    ],
    "links":[
    ]
}

Back to Top