1. REST API for GoldenGate Veridata
  2. Tasks
  3. Monitor

Retrieve Compare Pair Statistics

get

http://{host}:{port}/veridata/v1/services/monitoring/cps

Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator

API to get Veridata Compare Pair monitoring details.

Request

Query Parameters
  • Compare Pair ID.
  • This parameter decides the number of completed statistics (current + previous run) to be shown in the response. Default is 5.
  • Defines the start date range (inclusive) to filter out the Compare Pair response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z' "
  • This parameter when set to true will include performance statistics. Default value: false.
  • Fetch Compare Pair stats of last x units. Supported units D(Days) or H(hours) or M(minutes). Example: 1D
  • The CP's Run ID. Example: runId=1024,1,1.
  • Defines the end date range (not inclusive) to filter out the Compare Pair response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z'.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Compare Pair statistics fetched successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Example:
[
    {
        "runId":{
            "asString":"10277/1/1",
            "comparePairNum":1,
            "groupNum":1,
            "runID":10277
        },
        "startTime":"2024-02-03T10:15:30Z",
        "endTime":"2024-02-03T10:15:30Z",
        "comparePairId":1027,
        "name":"SRC2=TRG2",
        "numRowsOos":9,
        "skippedRows":false,
        "phase":"FINISHED",
        "status":"OOS",
        "repairStatus":"SUCCESSFUL",
        "repairRunId":{
            "asString":"18970/0/0",
            "comparePairNum":0,
            "groupNum":0,
            "runID":18970
        },
        "errorMessage":"",
        "rowsFromTarget":15,
        "rowsFromSource":16,
        "numOfDeletes":3,
        "numOfUpdates":4,
        "numOfInserts":2,
        "perfStats":{
            "coosBytesPerSec":8,
            "coosDuration":{
                "hours":0,
                "minutes":0,
                "seconds":15,
                "totalSeconds":15
            },
            "coosRowsPerSec":1,
            "coosStartTime":"2024-02-03T10:15:30Z",
            "coosStopTime":"2024-02-03T10:15:30Z",
            "coosTotalBytes":120,
            "coosTotalRows":15,
            "initCompareBytesPerSec":8,
            "initCompareDuration":{
                "hours":0,
                "minutes":0,
                "seconds":15,
                "totalSeconds":15
            },
            "initCompareRowsPerSec":1,
            "initCompareStartTime":"2024-02-03T10:15:30Z",
            "initCompareStopTime":"2024-02-03T10:15:30Z",
            "initCompareTotalBytes":120,
            "initCompareTotalRows":15,
            "sortingSrcBytesPerSec":8,
            "sortingSrcDuration":{
                "hours":0,
                "minutes":0,
                "seconds":15,
                "totalSeconds":15
            },
            "sortingSrcTotalBytes":120,
            "sortingSrcStartTime":"2024-02-03T10:15:30Z",
            "sortingSrcStopTime":"2024-02-03T10:15:30Z",
            "sortingSrcTotalRows":15,
            "sortingSrcRowsPerSec":1,
            "sortingTgtBytesPerSec":8,
            "sortingTgtDuration":{
                "hours":0,
                "minutes":0,
                "seconds":16,
                "totalSeconds":16
            },
            "sortingTgtTotalBytes":128,
            "sortingTgtStartTime":"2024-02-03T10:15:30Z",
            "sortingTgtStopTime":"2024-02-03T10:15:30Z",
            "sortingTgtTotalRows":16,
            "sortingTgtRowsPerSec":1
        },
        "runningStats":{
            "insyncBeforeCOOSInBytes":72,
            "insyncBeforeCOOS":9,
            "updatesOOS":4,
            "updatesInsyncAfterInFlight":3,
            "updatesOOSBeforeCOOS":1,
            "updatesOOSInBytes":32,
            "deletesOOSInBytes":24,
            "deletesInsyncAfterInFlightInBytes":2,
            "deletesOOS":3,
            "deletesOOSBeforeCOOS":1,
            "deletesOOSBeforeCOOSInBytes":2,
            "insertsInsyncAfterInFlight":2,
            "insertsOOS":2,
            "insertsOOSBeforeCOOS":0,
            "insertsOOSInBytes":16,
            "insertsInsyncAfterInFlightInBytes":0,
            "rowsIntoTargetSort":16,
            "rowsIntoSourceSort":15,
            "deletesInsyncAfterInFlight":0,
            "rowsFromSource":7,
            "rowsFromTarget":9,
            "totalRowsFromSource":15,
            "totalRowsFromTarget":16,
            "fetchLatencyFromTarget":null,
            "remainingTimeFromTarget":5,
            "remainingTimeFromSource":5,
            "bytesFromTarget":24,
            "bytesFromSource":32,
            "bytesIntoSourceSort":16,
            "bytesIntoTargetSort":8
        }
    }
]
Nested Schema : ComparePairStats
Match All
Show Source
Nested Schema : ComparePairBaseStats
Match All
Show Source
Nested Schema : BaseStats
Type: object
Show Source
Nested Schema : ComparePairBaseStats-allOf[1]
Type: object
Show Source
Nested Schema : ComparePairStats-allOf[1]
Type: object
Show Source
Nested Schema : RunID
Type: object
Run ID.
Show Source
Nested Schema : DeltaStats
Type: object
Show Source
Nested Schema : PerformanceStats
Type: object
Show Source
Nested Schema : RunningComparePairStats
Type: object
This stats will only be available when the compare pair is running and runId query parameter is used.
Show Source
Nested Schema : coosDuration
Match All
Show Source
Nested Schema : initCompareDuration
Match All
Show Source
Nested Schema : sortingSrcDuration
Match All
Show Source
Nested Schema : sortingTgtDuration
Match All
Show Source
Nested Schema : Duration
Type: object
Show Source
Nested Schema : coosDuration-allOf[1]
Type: object
Nested Schema : initCompareDuration-allOf[1]
Type: object
Nested Schema : sortingSrcDuration-allOf[1]
Type: object
Nested Schema : sortingTgtDuration-allOf[1]
Type: object

400 Response

Bad Request.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 Response

"Unauthorized."
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 Response

"Not found."
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 Response

"Server error."
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}
Back to Top