Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve an existing Queue Statistics

get

/services/{version}/mpoints/{item}/queueStatistics

Required Role: User

Retrieve an existing Queue 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 statistics

Type: object

Title: Oracle GoldenGate Queue statistics

Show Source

$schema:

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

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

{
    "title":"Oracle GoldenGate Queue statistics",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "mpoints:queueStatistics"
            ]
        },
        "queueStatistics":{
            "type":"array",
            "minItems":"0",
            "maxItems":"2147483647",
            "items":{
                "type":"object",
                "properties":{
                    "queueReadWaits":{
                        "description":"Queue Reads resulting in a wait",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "queueWrites":{
                        "description":"Queue Writes",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "threadId":{
                        "description":"Owning Thread id",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "queueReadsSignaled":{
                        "description":"Queue Read Waits that were signaled",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "queueMaxSize":{
                        "description":"Max Size of the Queue",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "queueName":{
                        "description":"Queue Name",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"1024"
                    },
                    "queueReads":{
                        "description":"Queue Reads",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "queueWriteWaits":{
                        "description":"Queue Writes resulting in a wait",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "queueWritesSignaled":{
                        "description":"Queue Write Waits that were signaled",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "queueItems":{
                        "description":"Items in the Queue",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "queueCurrentSize":{
                        "description":"Current Size of the Queue",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    }
                },
                "additionalProperties":false
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : queueStatistics

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":{
            "queueReadWaits":{
                "description":"Queue Reads resulting in a wait",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "queueWrites":{
                "description":"Queue Writes",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "threadId":{
                "description":"Owning Thread id",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "queueReadsSignaled":{
                "description":"Queue Read Waits that were signaled",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "queueMaxSize":{
                "description":"Max Size of the Queue",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "queueName":{
                "description":"Queue Name",
                "type":"string",
                "minLength":"1",
                "maxLength":"1024"
            },
            "queueReads":{
                "description":"Queue Reads",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "queueWriteWaits":{
                "description":"Queue Writes resulting in a wait",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "queueWritesSignaled":{
                "description":"Queue Write Waits that were signaled",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "queueItems":{
                "description":"Items in the Queue",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "queueCurrentSize":{
                "description":"Current Size of the Queue",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            }
        },
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

queueCurrentSize: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Current Size of the Queue
queueItems: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Items in the Queue
queueMaxSize: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Max Size of the Queue
queueName: string

Minimum Length: 1

Maximum Length: 1024

Queue Name
queueReads: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Queue Reads
queueReadsSignaled: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Queue Read Waits that were signaled
queueReadWaits: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Queue Reads resulting in a wait
queueWrites: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Queue Writes
queueWritesSignaled: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Queue Write Waits that were signaled
queueWriteWaits: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Queue Writes resulting in a wait
threadId: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Owning Thread id

{
    "type":"object",
    "properties":{
        "queueReadWaits":{
            "description":"Queue Reads resulting in a wait",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "queueWrites":{
            "description":"Queue Writes",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "threadId":{
            "description":"Owning Thread id",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "queueReadsSignaled":{
            "description":"Queue Read Waits that were signaled",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "queueMaxSize":{
            "description":"Max Size of the Queue",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "queueName":{
            "description":"Queue Name",
            "type":"string",
            "minLength":"1",
            "maxLength":"1024"
        },
        "queueReads":{
            "description":"Queue Reads",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "queueWriteWaits":{
            "description":"Queue Writes resulting in a wait",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "queueWritesSignaled":{
            "description":"Queue Write Waits that were signaled",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "queueItems":{
            "description":"Items in the Queue",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "queueCurrentSize":{
            "description":"Current Size of the Queue",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "response":{
        "$schema":"mpoints:queueStatistics",
        "queueStatistics":[
            {
                "queueReadWaits":"0",
                "queueWrites":"55463",
                "threadId":"21963",
                "queueReadsSignaled":"0",
                "queueMaxSize":"0",
                "queueName":"AsyncReader 1 Buffers",
                "queueReads":"55460",
                "queueWriteWaits":"0",
                "queueWritesSignaled":"0",
                "queueItems":"4",
                "queueCurrentSize":"0"
            },
            {
                "queueReadWaits":"68118",
                "queueWrites":"7721",
                "threadId":"21964",
                "queueReadsSignaled":"7720",
                "queueMaxSize":"0",
                "queueName":"AsyncReader 1 Results",
                "queueReads":"7721",
                "queueWriteWaits":"0",
                "queueWritesSignaled":"0",
                "queueItems":"8",
                "queueCurrentSize":"0"
            },
            {
                "queueReadWaits":"2",
                "queueWrites":"14893",
                "threadId":"21964",
                "queueReadsSignaled":"13",
                "queueMaxSize":"0",
                "queueName":"IXAsyncTrans Buffers",
                "queueReads":"14594",
                "queueWriteWaits":"0",
                "queueWritesSignaled":"0",
                "queueItems":"300",
                "queueCurrentSize":"0"
            },
            {
                "queueReadWaits":"64436",
                "queueWrites":"15567",
                "threadId":"21964",
                "queueReadsSignaled":"29",
                "queueMaxSize":"34359738368",
                "queueName":"IXAsyncTrans Results",
                "queueReads":"15567",
                "queueWriteWaits":"0",
                "queueWritesSignaled":"0",
                "queueItems":"316",
                "queueCurrentSize":"0"
            }
        ]
    },
    "messages":[
    ],
    "links":[
    ]
}