Oracle GoldenGate

Retrieve an existing Distribution Server Chunk Statistics

get

/services/{version}/mpoints/{item}/distsrvrChunkStats

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 Chunk statistics

Type: object

Title: Oracle GoldenGate Distribution Server Chunk statistics

Show Source

$schema:

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

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

{
    "title":"Oracle GoldenGate Distribution Server Chunk statistics",
    "required":[
        "statistics"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "mpoints:distsrvrChunkStats"
            ]
        },
        "statistics":{
            "type":"array",
            "minItems":0,
            "maxItems":2147483647,
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Path Name",
                        "type":"string",
                        "minLength":1,
                        "maxLength":240
                    },
                    "stats":{
                        "type":"object",
                        "properties":{
                            "updates":{
                                "type":"integer",
                                "minimum":0,
                                "maximum":9.223372036854776E18
                            },
                            "ddl":{
                                "type":"integer",
                                "minimum":0,
                                "maximum":9.223372036854776E18
                            },
                            "inserts":{
                                "type":"integer",
                                "minimum":0,
                                "maximum":9.223372036854776E18
                            },
                            "$schema":{
                                "enum":[
                                    "ogg:distPathChunkStats"
                                ]
                            },
                            "procedure":{
                                "type":"integer",
                                "minimum":0,
                                "maximum":9.223372036854776E18
                            },
                            "deletes":{
                                "type":"integer",
                                "minimum":0,
                                "maximum":9.223372036854776E18
                            },
                            "lcrReceived":{
                                "type":"integer",
                                "minimum":0,
                                "maximum":9.223372036854776E18
                            },
                            "lcrSent":{
                                "type":"integer",
                                "minimum":0,
                                "maximum":9.223372036854776E18
                            },
                            "other":{
                                "type":"integer",
                                "minimum":0,
                                "maximum":9.223372036854776E18
                            },
                            "chunkId":{
                                "type":"integer",
                                "minimum":1,
                                "maximum":4.294967295E9
                            }
                        },
                        "required":[
                            "chunkId",
                            "lcrReceived",
                            "lcrSent"
                        ],
                        "additionalProperties":false
                    }
                },
                "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
            },
            "stats":{
                "type":"object",
                "properties":{
                    "updates":{
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "ddl":{
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "inserts":{
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "$schema":{
                        "enum":[
                            "ogg:distPathChunkStats"
                        ]
                    },
                    "procedure":{
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "deletes":{
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "lcrReceived":{
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "lcrSent":{
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "other":{
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "chunkId":{
                        "type":"integer",
                        "minimum":1,
                        "maximum":4.294967295E9
                    }
                },
                "required":[
                    "chunkId",
                    "lcrReceived",
                    "lcrSent"
                ],
                "additionalProperties":false
            }
        },
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

name: string

Minimum Length: 1

Maximum Length: 240

Path Name
stats: object stats

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Path Name",
            "type":"string",
            "minLength":1,
            "maxLength":240
        },
        "stats":{
            "type":"object",
            "properties":{
                "updates":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                "ddl":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                "inserts":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                "$schema":{
                    "enum":[
                        "ogg:distPathChunkStats"
                    ]
                },
                "procedure":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                "deletes":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                "lcrReceived":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                "lcrSent":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                "other":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                "chunkId":{
                    "type":"integer",
                    "minimum":1,
                    "maximum":4.294967295E9
                }
            },
            "required":[
                "chunkId",
                "lcrReceived",
                "lcrSent"
            ],
            "additionalProperties":false
        }
    },
    "additionalProperties":false
}

Nested Schema : stats

Type: object

Show Source

$schema:

Allowed Values: [ "ogg:distPathChunkStats" ]
chunkId: integer

Minimum Value: 1

Maximum Value: 4.294967295E9
ddl: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18
deletes: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18
inserts: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18
lcrReceived: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18
lcrSent: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18
other: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18
procedure: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18
updates: integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

{
    "type":"object",
    "properties":{
        "updates":{
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "ddl":{
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "inserts":{
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "$schema":{
            "enum":[
                "ogg:distPathChunkStats"
            ]
        },
        "procedure":{
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "deletes":{
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "lcrReceived":{
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "lcrSent":{
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "other":{
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "chunkId":{
            "type":"integer",
            "minimum":1,
            "maximum":4.294967295E9
        }
    },
    "required":[
        "chunkId",
        "lcrReceived",
        "lcrSent"
    ],
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "response":{
        "$schema":"mpoints:distsrvrChunkStats",
        "statistics":[
            {
                "totalInserts":10,
                "totalOthers":2,
                "name":"PROD.PATH.1",
                "totalDeletes":30,
                "lcrsReceived":96,
                "totalDDLs":0,
                "totalProcedures":0,
                "chunkId":1,
                "totalUpdates":20,
                "lcrsSent":10
            },
            {
                "totalInserts":10,
                "totalOthers":2,
                "name":"PROD.PATH.1",
                "totalDeletes":30,
                "lcrsReceived":96,
                "totalDDLs":0,
                "totalProcedures":0,
                "chunkId":2,
                "totalUpdates":20,
                "lcrsSent":10
            },
            {
                "totalInserts":5,
                "totalOthers":1,
                "name":"PROD.PATH.2",
                "totalDeletes":0,
                "lcrsReceived":43,
                "totalDDLs":0,
                "totalProcedures":0,
                "chunkId":1,
                "totalUpdates":2,
                "lcrsSent":15
            },
            {
                "totalInserts":5,
                "totalOthers":1,
                "name":"PROD.PATH.2",
                "totalDeletes":0,
                "lcrsReceived":43,
                "totalDDLs":0,
                "totalProcedures":0,
                "chunkId":2,
                "totalUpdates":2,
                "lcrsSent":15
            }
        ]
    },
    "messages":[
    ],
    "links":[
    ]
}