Oracle GoldenGate 19c Microservices Architecture REST API

Retrieve an existing Distribution Server Path Statistics

get

/services/{version}/mpoints/{item}/distsrvrTableStats

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

Type: object

Title: Oracle GoldenGate Distribution Server Table statistics

Show Source

$schema(optional):

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

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

{
    "title":"Oracle GoldenGate Distribution Server Table statistics",
    "required":[
        "statistics"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "mpoints:distsrvrTableStats"
            ]
        },
        "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":{
                            "upserts":{
                                "type":"integer",
                                "minimum":0,
                                "maximum":9.223372036854776E18
                            },
                            "truncates":{
                                "type":"integer",
                                "minimum":0,
                                "maximum":9.223372036854776E18
                            },
                            "tableName":{
                                "x-anyOf":[
                                    {
                                        "type":"string",
                                        "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                                        "minLength":1,
                                        "maxLength":130
                                    },
                                    {
                                        "x-anyOf":[
                                            {
                                                "type":"string",
                                                "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                                                "minLength":3,
                                                "maxLength":261
                                            },
                                            {
                                                "type":"string",
                                                "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                                                "minLength":5,
                                                "maxLength":392
                                            }
                                        ]
                                    }
                                ]
                            },
                            "updates":{
                                "type":"integer",
                                "minimum":0,
                                "maximum":9.223372036854776E18
                            },
                            "inserts":{
                                "type":"integer",
                                "minimum":0,
                                "maximum":9.223372036854776E18
                            },
                            "$schema":{
                                "enum":[
                                    "ogg:distPathTableStats"
                                ]
                            },
                            "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
                            },
                            "unsupported":{
                                "type":"integer",
                                "minimum":0,
                                "maximum":9.223372036854776E18
                            }
                        },
                        "required":[
                            "tableName",
                            "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

Array of: 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":{
                    "upserts":{
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "truncates":{
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "tableName":{
                        "x-anyOf":[
                            {
                                "type":"string",
                                "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                                "minLength":1,
                                "maxLength":130
                            },
                            {
                                "x-anyOf":[
                                    {
                                        "type":"string",
                                        "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                                        "minLength":3,
                                        "maxLength":261
                                    },
                                    {
                                        "type":"string",
                                        "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                                        "minLength":5,
                                        "maxLength":392
                                    }
                                ]
                            }
                        ]
                    },
                    "updates":{
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "inserts":{
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    },
                    "$schema":{
                        "enum":[
                            "ogg:distPathTableStats"
                        ]
                    },
                    "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
                    },
                    "unsupported":{
                        "type":"integer",
                        "minimum":0,
                        "maximum":9.223372036854776E18
                    }
                },
                "required":[
                    "tableName",
                    "lcrReceived",
                    "lcrSent"
                ],
                "additionalProperties":false
            }
        },
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

name(optional): string

Minimum Length: 1

Maximum Length: 240

Path Name
stats(optional): object stats

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Path Name",
            "type":"string",
            "minLength":1,
            "maxLength":240
        },
        "stats":{
            "type":"object",
            "properties":{
                "upserts":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                "truncates":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                "tableName":{
                    "x-anyOf":[
                        {
                            "type":"string",
                            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                            "minLength":1,
                            "maxLength":130
                        },
                        {
                            "x-anyOf":[
                                {
                                    "type":"string",
                                    "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                                    "minLength":3,
                                    "maxLength":261
                                },
                                {
                                    "type":"string",
                                    "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                                    "minLength":5,
                                    "maxLength":392
                                }
                            ]
                        }
                    ]
                },
                "updates":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                "inserts":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                "$schema":{
                    "enum":[
                        "ogg:distPathTableStats"
                    ]
                },
                "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
                },
                "unsupported":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                }
            },
            "required":[
                "tableName",
                "lcrReceived",
                "lcrSent"
            ],
            "additionalProperties":false
        }
    },
    "additionalProperties":false
}

Nested Schema : stats

Type: object

Show Source

$schema(optional):

Allowed Values: [ "ogg:distPathTableStats" ]
deletes(optional): integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18
inserts(optional): 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(optional): integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18
tableName: tableName
truncates(optional): integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18
unsupported(optional): integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18
updates(optional): integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18
upserts(optional): integer

Minimum Value: 0

Maximum Value: 9.223372036854776E18

{
    "type":"object",
    "properties":{
        "upserts":{
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "truncates":{
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "tableName":{
            "x-anyOf":[
                {
                    "type":"string",
                    "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                    "minLength":1,
                    "maxLength":130
                },
                {
                    "x-anyOf":[
                        {
                            "type":"string",
                            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                            "minLength":3,
                            "maxLength":261
                        },
                        {
                            "type":"string",
                            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                            "minLength":5,
                            "maxLength":392
                        }
                    ]
                }
            ]
        },
        "updates":{
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "inserts":{
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "$schema":{
            "enum":[
                "ogg:distPathTableStats"
            ]
        },
        "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
        },
        "unsupported":{
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        }
    },
    "required":[
        "tableName",
        "lcrReceived",
        "lcrSent"
    ],
    "additionalProperties":false
}

Nested Schema : tableName

Match Any

Show Source

string

Minimum Length: 1

Maximum Length: 130

Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
tableName-x-anyOf[1]

{
    "x-anyOf":[
        {
            "type":"string",
            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
            "minLength":1,
            "maxLength":130
        },
        {
            "x-anyOf":[
                {
                    "type":"string",
                    "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                    "minLength":3,
                    "maxLength":261
                },
                {
                    "type":"string",
                    "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                    "minLength":5,
                    "maxLength":392
                }
            ]
        }
    ]
}

Nested Schema : tableName-x-anyOf[1]

Match Any

Show Source

string

Minimum Length: 3

Maximum Length: 261

Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
string

Minimum Length: 5

Maximum Length: 392

Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$

{
    "x-anyOf":[
        {
            "type":"string",
            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
            "minLength":3,
            "maxLength":261
        },
        {
            "type":"string",
            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
            "minLength":5,
            "maxLength":392
        }
    ]
}

Example Response (application/json)

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