Oracle GoldenGate Microservices REST API

Retrieve an existing PM Service Worker Thread Statistics

get

/services/{version}/mpoints/{item}/pmsrvrWorkerStats

Required Role: User

Retrieve an existing PM Service Worker Thread 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 PM Server Worker Thread Statistics

Type: object

Title: Oracle GoldenGate PM Server Worker Thread Statistics

Show Source

$schema:

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

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

{
    "title":"Oracle GoldenGate PM Server Worker Thread Statistics",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "mpoints:pmsrvrWorkerStats"
            ]
        },
        "pmsrvrWorkerStats":{
            "type":"array",
            "minItems":"0",
            "maxItems":"2147483647",
            "items":{
                "type":"object",
                "properties":{
                    "executionTime":{
                        "description":"Total Execution Time in milliseconds",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "writeTimeHWM":{
                        "description":"HWM in milliseconds of a write operation",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"2147483647"
                    },
                    "threadName":{
                        "description":"Name of the Worker Thread",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"64"
                    },
                    "databasesAssigned":{
                        "description":"Total Number of Databases assigned to this worker",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"2147483647"
                    },
                    "operationsProcessed":{
                        "description":"Total Number of Operations Processed",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "threadId":{
                        "description":"Thread id of the Worker Thread",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "appendTimeHWM":{
                        "description":"HWM in milliseconds of an append operation",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"2147483647"
                    },
                    "workerQueueDepth":{
                        "description":"Current Depth of the Worker Queue",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"2147483647"
                    },
                    "timeQueueDepthHWMHit":{
                        "description":"Time HWM Depth of the Worker Queue hit",
                        "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"
                            }
                        ]
                    },
                    "waitTime":{
                        "description":"Total Wait time in milliseconds",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "lastTimeWorkerQueueFull":{
                        "description":"Last Time the Worker Queue wax at max",
                        "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"
                            }
                        ]
                    },
                    "workerQueueDepthHWM":{
                        "description":"HWM Depth of the Worker Queue",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"2147483647"
                    },
                    "timesWorkerQueueFull":{
                        "description":"Number of times the Worker Queue was Full",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"2147483647"
                    },
                    "workerId":{
                        "description":"Worker id number",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"9223372036854776000"
                    },
                    "commitTimeHWM":{
                        "description":"HWM in milliseconds of a commit operation",
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"2147483647"
                    }
                },
                "additionalProperties":false
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : pmsrvrWorkerStats

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":{
            "executionTime":{
                "description":"Total Execution Time in milliseconds",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "writeTimeHWM":{
                "description":"HWM in milliseconds of a write operation",
                "type":"integer",
                "minimum":"0",
                "maximum":"2147483647"
            },
            "threadName":{
                "description":"Name of the Worker Thread",
                "type":"string",
                "minLength":"1",
                "maxLength":"64"
            },
            "databasesAssigned":{
                "description":"Total Number of Databases assigned to this worker",
                "type":"integer",
                "minimum":"0",
                "maximum":"2147483647"
            },
            "operationsProcessed":{
                "description":"Total Number of Operations Processed",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "threadId":{
                "description":"Thread id of the Worker Thread",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "appendTimeHWM":{
                "description":"HWM in milliseconds of an append operation",
                "type":"integer",
                "minimum":"0",
                "maximum":"2147483647"
            },
            "workerQueueDepth":{
                "description":"Current Depth of the Worker Queue",
                "type":"integer",
                "minimum":"0",
                "maximum":"2147483647"
            },
            "timeQueueDepthHWMHit":{
                "description":"Time HWM Depth of the Worker Queue hit",
                "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"
                    }
                ]
            },
            "waitTime":{
                "description":"Total Wait time in milliseconds",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "lastTimeWorkerQueueFull":{
                "description":"Last Time the Worker Queue wax at max",
                "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"
                    }
                ]
            },
            "workerQueueDepthHWM":{
                "description":"HWM Depth of the Worker Queue",
                "type":"integer",
                "minimum":"0",
                "maximum":"2147483647"
            },
            "timesWorkerQueueFull":{
                "description":"Number of times the Worker Queue was Full",
                "type":"integer",
                "minimum":"0",
                "maximum":"2147483647"
            },
            "workerId":{
                "description":"Worker id number",
                "type":"integer",
                "minimum":"0",
                "maximum":"9223372036854776000"
            },
            "commitTimeHWM":{
                "description":"HWM in milliseconds of a commit operation",
                "type":"integer",
                "minimum":"0",
                "maximum":"2147483647"
            }
        },
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

appendTimeHWM: integer

Minimum Value: 0

Maximum Value: 2147483647

HWM in milliseconds of an append operation
commitTimeHWM: integer

Minimum Value: 0

Maximum Value: 2147483647

HWM in milliseconds of a commit operation
databasesAssigned: integer

Minimum Value: 0

Maximum Value: 2147483647

Total Number of Databases assigned to this worker
executionTime: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Total Execution Time in milliseconds
lastTimeWorkerQueueFull: lastTimeWorkerQueueFull

Last Time the Worker Queue wax at max
operationsProcessed: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Total Number of Operations Processed
threadId: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Thread id of the Worker Thread
threadName: string

Minimum Length: 1

Maximum Length: 64

Name of the Worker Thread
timeQueueDepthHWMHit: timeQueueDepthHWMHit

Time HWM Depth of the Worker Queue hit
timesWorkerQueueFull: integer

Minimum Value: 0

Maximum Value: 2147483647

Number of times the Worker Queue was Full
waitTime: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Total Wait time in milliseconds
workerId: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Worker id number
workerQueueDepth: integer

Minimum Value: 0

Maximum Value: 2147483647

Current Depth of the Worker Queue
workerQueueDepthHWM: integer

Minimum Value: 0

Maximum Value: 2147483647

HWM Depth of the Worker Queue
writeTimeHWM: integer

Minimum Value: 0

Maximum Value: 2147483647

HWM in milliseconds of a write operation

{
    "type":"object",
    "properties":{
        "executionTime":{
            "description":"Total Execution Time in milliseconds",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "writeTimeHWM":{
            "description":"HWM in milliseconds of a write operation",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        },
        "threadName":{
            "description":"Name of the Worker Thread",
            "type":"string",
            "minLength":"1",
            "maxLength":"64"
        },
        "databasesAssigned":{
            "description":"Total Number of Databases assigned to this worker",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        },
        "operationsProcessed":{
            "description":"Total Number of Operations Processed",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "threadId":{
            "description":"Thread id of the Worker Thread",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "appendTimeHWM":{
            "description":"HWM in milliseconds of an append operation",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        },
        "workerQueueDepth":{
            "description":"Current Depth of the Worker Queue",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        },
        "timeQueueDepthHWMHit":{
            "description":"Time HWM Depth of the Worker Queue hit",
            "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"
                }
            ]
        },
        "waitTime":{
            "description":"Total Wait time in milliseconds",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "lastTimeWorkerQueueFull":{
            "description":"Last Time the Worker Queue wax at max",
            "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"
                }
            ]
        },
        "workerQueueDepthHWM":{
            "description":"HWM Depth of the Worker Queue",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        },
        "timesWorkerQueueFull":{
            "description":"Number of times the Worker Queue was Full",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        },
        "workerId":{
            "description":"Worker id number",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000"
        },
        "commitTimeHWM":{
            "description":"HWM in milliseconds of a commit operation",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        }
    },
    "additionalProperties":false
}

Nested Schema : lastTimeWorkerQueueFull

Last Time the Worker Queue wax at max

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":"Last Time the Worker Queue wax at max",
    "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"
        }
    ]
}

Nested Schema : timeQueueDepthHWMHit

Time HWM Depth of the Worker Queue hit

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":"Time HWM Depth of the Worker Queue hit",
    "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:pmsrvrWorkerStats",
        "pmsrvrWorkerStats":[
            {
                "executionTime":"34213",
                "threadName":"CollectorWorker-1",
                "threadId":"12345",
                "workerQueueDepth":"0",
                "processesAssigned":"3",
                "timeQueueDepthHWMHit":"2015-06-05T13:22:18.034456Z",
                "waitTime":"34204",
                "bytesProcessed":"136932",
                "workerQueueDepthHWM":"3",
                "packetsProcessed":"79",
                "workerId":"1"
            },
            {
                "executionTime":"34213",
                "threadName":"CollectorWorker-2",
                "threadId":"12346",
                "workerQueueDepth":"0",
                "processesAssigned":"3",
                "timeQueueDepthHWMHit":"2015-06-05T13:22:18.034456Z",
                "waitTime":"34204",
                "bytesProcessed":"132343",
                "workerQueueDepthHWM":"21",
                "packetsProcessed":"73",
                "workerId":"2"
            },
            {
                "executionTime":"34213",
                "threadName":"CollectorWorker-3",
                "threadId":"12347",
                "workerQueueDepth":"0",
                "processesAssigned":"3",
                "timeQueueDepthHWMHit":"2015-06-05T13:22:18.034456Z",
                "waitTime":"34204",
                "bytesProcessed":"136932",
                "workerQueueDepthHWM":"2",
                "packetsProcessed":"79",
                "workerId":"3"
            }
        ]
    },
    "messages":[
    ],
    "links":[
    ]
}