Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve an existing Queue Bucket Statistics

get

/services/{version}/mpoints/{item}/queueBucketStatistics

Required Role: User

Retrieve an existing Queue Bucket Statistics

Request

Path Parameters

item(required): string

Minimum Length: 1

Maximum Length: 32
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Root Schema : Oracle GoldenGate Queue Bucket statistics

Type: object

Title: Oracle GoldenGate Queue Bucket statistics

Show Source

$schema:

Allowed Values: [ "mpoints:queueBucketStatistics" ]
queueBucketStatistics: array queueBucketStatistics

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

{
    "title":"Oracle GoldenGate Queue Bucket statistics",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "mpoints:queueBucketStatistics"
            ]
        },
        "queueBucketStatistics":{
            "type":"array",
            "minItems":"0",
            "maxItems":"2147483647",
            "items":{
                "type":"object",
                "properties":{
                    "bucketId":{
                        "description":"Bucket ID",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"2147483647"
                    },
                    "bucketSize":{
                        "description":"Bucket Size",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"2147483647"
                    },
                    "bucketQHits":{
                        "description":"Bucket Queue Hits",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "bucketCurrLen":{
                        "description":"Current Bucket Length",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"2147483647"
                    },
                    "bucketMaxLen":{
                        "description":"Max Bucket Length",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"2147483647"
                    },
                    "bucketAvgLen":{
                        "description":"Average Bucket Length",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"2147483647"
                    },
                    "bucketCanniblized":{
                        "description":"Times Bucket Cannibalized",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"2147483647"
                    }
                },
                "additionalProperties":false
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : queueBucketStatistics

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":{
            "bucketId":{
                "description":"Bucket ID",
                "type":"integer",
                "minimum":"0",
                "maximum":"2147483647"
            },
            "bucketSize":{
                "description":"Bucket Size",
                "type":"integer",
                "minimum":"0",
                "maximum":"2147483647"
            },
            "bucketQHits":{
                "description":"Bucket Queue Hits",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "bucketCurrLen":{
                "description":"Current Bucket Length",
                "type":"integer",
                "minimum":"0",
                "maximum":"2147483647"
            },
            "bucketMaxLen":{
                "description":"Max Bucket Length",
                "type":"integer",
                "minimum":"0",
                "maximum":"2147483647"
            },
            "bucketAvgLen":{
                "description":"Average Bucket Length",
                "type":"integer",
                "minimum":"0",
                "maximum":"2147483647"
            },
            "bucketCanniblized":{
                "description":"Times Bucket Cannibalized",
                "type":"integer",
                "minimum":"0",
                "maximum":"2147483647"
            }
        },
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

bucketAvgLen: integer

Minimum Value: 0

Maximum Value: 2147483647

Average Bucket Length
bucketCanniblized: integer

Minimum Value: 0

Maximum Value: 2147483647

Times Bucket Cannibalized
bucketCurrLen: integer

Minimum Value: 0

Maximum Value: 2147483647

Current Bucket Length
bucketId: integer

Minimum Value: 0

Maximum Value: 2147483647

Bucket ID
bucketMaxLen: integer

Minimum Value: 0

Maximum Value: 2147483647

Max Bucket Length
bucketQHits: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Bucket Queue Hits
bucketSize: integer

Minimum Value: 0

Maximum Value: 2147483647

Bucket Size

{
    "type":"object",
    "properties":{
        "bucketId":{
            "description":"Bucket ID",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        },
        "bucketSize":{
            "description":"Bucket Size",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        },
        "bucketQHits":{
            "description":"Bucket Queue Hits",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "bucketCurrLen":{
            "description":"Current Bucket Length",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        },
        "bucketMaxLen":{
            "description":"Max Bucket Length",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        },
        "bucketAvgLen":{
            "description":"Average Bucket Length",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        },
        "bucketCanniblized":{
            "description":"Times Bucket Cannibalized",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "response":{
        "$schema":"mpoints:queueBucketStatistics",
        "queueBucketStatistics":[
            {
                "bucketId":"0",
                "bucketSize":"65536",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"1",
                "bucketSize":"131072",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"2",
                "bucketSize":"262144",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"3",
                "bucketSize":"524288",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"4",
                "bucketSize":"1048576",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"5",
                "bucketSize":"2097152",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"6",
                "bucketSize":"4194304",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"7",
                "bucketSize":"8388608",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"8",
                "bucketSize":"16777216",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"9",
                "bucketSize":"33554432",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"10",
                "bucketSize":"67108864",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"11",
                "bucketSize":"134217728",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"12",
                "bucketSize":"268435456",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"13",
                "bucketSize":"536870912",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            },
            {
                "bucketId":"14",
                "bucketSize":"1073741824",
                "bucketQHits":"0",
                "bucketCurrLen":"0",
                "bucketMaxLen":"0",
                "bucketAvgLen":"0",
                "bucketCanniblized":"0"
            }
        ]
    },
    "messages":[
    ],
    "links":[
    ]
}