REST API for GoldenGate Veridata

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

cpId: integer

Compare Pair ID.
finishedStatsCount: integer

This parameter decides the number of completed statistics (current + previous run) to be shown in the response. Default is 5.
fromDate: string

Defines the start date range (inclusive) to filter out the Compare Pair response. Supported format yyyy-MM-dd'T'HH:mm:ss'Z' "
includePerformance: boolean

This parameter when set to true will include performance statistics. Default value: false.
last: string

Fetch Compare Pair stats of last x units. Supported units D(Days) or H(hours) or M(minutes). Example: 1D
runId: string

The CP's Run ID. Example: runId=1024,1,1.
status:
toDate: string

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.

Response

Supported Media Types

application/json

200 Response

Compare Pair statistics fetched successfully.

Root Schema : schema

Type: array

Show Source

Array of: ComparePairStats

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ComparePairStats"
    }
}

Nested Schema : ComparePairStats

Match All

Show Source

allOf ComparePairBaseStats
object ComparePairStats-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ComparePairBaseStats"
        },
        {
            "type":"object",
            "properties":{
                "rowsFromTarget":{
                    "type":"integer",
                    "format":"int64",
                    "default":"0"
                },
                "rowsFromSource":{
                    "type":"integer",
                    "format":"int64",
                    "default":"0"
                },
                "numOfDeletes":{
                    "type":"integer",
                    "format":"int64",
                    "default":"0"
                },
                "numOfUpdates":{
                    "type":"integer",
                    "format":"int64",
                    "default":"0"
                },
                "numOfInserts":{
                    "type":"integer",
                    "format":"int64",
                    "default":"0"
                },
                "skippedRows":{
                    "type":"boolean",
                    "default":false
                },
                "deltaStartTime":{
                    "type":"string",
                    "format":"date-time",
                    "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
                    "example":"2024-02-03T10:15:30Z"
                },
                "srcTable":{
                    "type":"string"
                },
                "tgtTable":{
                    "type":"string"
                },
                "deltaStats":{
                    "$ref":"#/components/schemas/DeltaStats"
                },
                "perfStats":{
                    "$ref":"#/components/schemas/PerformanceStats"
                },
                "runningStats":{
                    "$ref":"#/components/schemas/RunningComparePairStats"
                }
            }
        }
    ]
}

Nested Schema : ComparePairBaseStats

Match All

Show Source

object BaseStats
object ComparePairBaseStats-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseStats"
        },
        {
            "type":"object",
            "properties":{
                "comparePairId":{
                    "type":"integer",
                    "format":"int64"
                },
                "name":{
                    "type":"string"
                },
                "numRowsOos":{
                    "type":"integer",
                    "format":"int64",
                    "default":"0"
                },
                "skippedRows":{
                    "type":"boolean",
                    "default":false
                },
                "phase":{
                    "$ref":"#/components/schemas/ComparisonPhase"
                },
                "status":{
                    "$ref":"#/components/schemas/JobFinishedStatus"
                },
                "repairStatus":{
                    "$ref":"#/components/schemas/RepairStatus"
                },
                "repairRunId":{
                    "$ref":"#/components/schemas/RunID",
                    "type":"object"
                },
                "errorMessage":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : BaseStats

Type: object

Show Source

endTime: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
runId: object RunID

Run ID.
startTime: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z

{
    "type":"object",
    "properties":{
        "runId":{
            "$ref":"#/components/schemas/RunID",
            "type":"object"
        },
        "startTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "endTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        }
    }
}

Nested Schema : ComparePairBaseStats-allOf[1]

Type: object

Show Source

comparePairId: integer (int64)
errorMessage: string
name: string
numRowsOos: integer (int64)

Default Value: 0
phase: string

Allowed Values: [ "INITIALIZING", "INITCOMPARE", "INITCOMPARECOOS", "COOS", "SORTING", "FINISHED" ]

enum for comparison phase.
repairRunId: object RunID

Run ID.
repairStatus: string

Allowed Values: [ "PENDING", "RUNNING", "ERRORS", "WARNINGS", "SUCCESSFUL", "CANCELLED", "OOS" ]

Repair Status.
skippedRows: boolean

Default Value: false
status: string

Allowed Values: [ "FAILED", "CANCELLED", "OUTOFSYNC", "INSYNC", "RUNNING", "FINISHED" ]

Job status.

{
    "type":"object",
    "properties":{
        "comparePairId":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "numRowsOos":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "skippedRows":{
            "type":"boolean",
            "default":false
        },
        "phase":{
            "$ref":"#/components/schemas/ComparisonPhase"
        },
        "status":{
            "$ref":"#/components/schemas/JobFinishedStatus"
        },
        "repairStatus":{
            "$ref":"#/components/schemas/RepairStatus"
        },
        "repairRunId":{
            "$ref":"#/components/schemas/RunID",
            "type":"object"
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

Nested Schema : ComparePairStats-allOf[1]

Type: object

Show Source

deltaStartTime: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
deltaStats: object DeltaStats
numOfDeletes: integer (int64)

Default Value: 0
numOfInserts: integer (int64)

Default Value: 0
numOfUpdates: integer (int64)

Default Value: 0
perfStats: object PerformanceStats
rowsFromSource: integer (int64)

Default Value: 0
rowsFromTarget: integer (int64)

Default Value: 0
runningStats: object RunningComparePairStats

This stats will only be available when the compare pair is running and runId query parameter is used.
skippedRows: boolean

Default Value: false
srcTable: string
tgtTable: string

{
    "type":"object",
    "properties":{
        "rowsFromTarget":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "rowsFromSource":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "numOfDeletes":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "numOfUpdates":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "numOfInserts":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "skippedRows":{
            "type":"boolean",
            "default":false
        },
        "deltaStartTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "srcTable":{
            "type":"string"
        },
        "tgtTable":{
            "type":"string"
        },
        "deltaStats":{
            "$ref":"#/components/schemas/DeltaStats"
        },
        "perfStats":{
            "$ref":"#/components/schemas/PerformanceStats"
        },
        "runningStats":{
            "$ref":"#/components/schemas/RunningComparePairStats"
        }
    }
}

Nested Schema : RunID

Type: object

Run ID.

Show Source

asString: string

Displays Run ID in string format.
comparePairNum: integer

pPart of the run ID.
groupNum: integer

Part of the run ID
runID: integer

Part of the run ID.

{
    "type":"object",
    "description":"Run ID.",
    "properties":{
        "asString":{
            "type":"string",
            "description":"Displays Run ID in string format."
        },
        "comparePairNum":{
            "type":"integer",
            "description":"pPart of the run ID."
        },
        "groupNum":{
            "type":"integer",
            "description":"Part of the run ID"
        },
        "runID":{
            "type":"integer",
            "description":"Part of the run ID."
        }
    }
}

Nested Schema : DeltaStats

Type: object

Show Source

deltaRunId: string

delta run ID Example - 1100,1,1
deltaStartTime: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
srcDeltaInfo: string

Source delta value.
tgtDeltaInfo: string

Target delta value.

{
    "type":"object",
    "properties":{
        "deltaRunId":{
            "type":"string",
            "description":"delta run ID Example - 1100,1,1"
        },
        "deltaStartTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "srcDeltaInfo":{
            "type":"string",
            "description":"Source delta value."
        },
        "tgtDeltaInfo":{
            "type":"string",
            "description":"Target delta value."
        }
    }
}

Nested Schema : PerformanceStats

Type: object

Show Source

coosBytesPerSec: integer (int64)

Default Value: 0
coosDuration: coosDuration
coosRowsPerSec: integer (int64)

Default Value: 0
coosStartTime: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
coosStopTime: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
coosTotalBytes: integer (int64)

Default Value: 0
coosTotalRows: integer (int64)

Default Value: 0
initCompareBytesPerSec: integer (int64)

Default Value: 0
initCompareDuration: initCompareDuration
initCompareRowsPerSec: integer (int64)

Default Value: 0
initCompareStartTime: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
initCompareStopTime: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
initCompareTotalBytes: integer (int64)

Default Value: 0
initCompareTotalRows: integer (int64)

Default Value: 0
sortingSrcBytesPerSec: integer (int64)

Default Value: 0
sortingSrcDuration: sortingSrcDuration
sortingSrcRowsPerSec: integer (int64)

Default Value: 0
sortingSrcStartTime: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
sortingSrcStopTime: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
sortingSrcTotalBytes: integer (int64)

Default Value: 0
sortingSrcTotalRows: integer (int64)

Default Value: 0
sortingTgtBytesPerSec: integer (int64)

Default Value: 0
sortingTgtDuration: sortingTgtDuration
sortingTgtRowsPerSec: integer (int64)

Default Value: 0
sortingTgtStartTime: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
sortingTgtStopTime: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
sortingTgtTotalBytes: integer (int64)

Default Value: 0
sortingTgtTotalRows: integer (int64)

Default Value: 0

{
    "type":"object",
    "properties":{
        "coosBytesPerSec":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "coosDuration":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Duration"
                },
                {
                    "type":"object"
                }
            ]
        },
        "coosRowsPerSec":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "coosStartTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "coosStopTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "coosTotalBytes":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "coosTotalRows":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "initCompareBytesPerSec":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "initCompareDuration":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Duration"
                },
                {
                    "type":"object"
                }
            ]
        },
        "initCompareRowsPerSec":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "initCompareStartTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "initCompareStopTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "initCompareTotalBytes":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "initCompareTotalRows":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "sortingSrcBytesPerSec":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "sortingSrcDuration":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Duration"
                },
                {
                    "type":"object"
                }
            ]
        },
        "sortingSrcTotalBytes":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "sortingSrcStartTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "sortingSrcStopTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "sortingSrcTotalRows":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "sortingSrcRowsPerSec":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "sortingTgtBytesPerSec":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "sortingTgtDuration":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Duration"
                },
                {
                    "type":"object"
                }
            ]
        },
        "sortingTgtTotalBytes":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "sortingTgtStartTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "sortingTgtStopTime":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "sortingTgtTotalRows":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        },
        "sortingTgtRowsPerSec":{
            "type":"integer",
            "format":"int64",
            "default":"0"
        }
    }
}

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

bytesFromSource: integer
bytesFromTarget: integer
bytesIntoSourceSort: integer
bytesIntoTargetSort: integer
deletesInsyncAfterInFlight: integer
deletesInsyncAfterInFlightInBytes: integer
deletesOOS: integer
deletesOOSBeforeCOOS: integer
deletesOOSBeforeCOOSInBytes: integer
deletesOOSInBytes: integer
fetchLatencyFromTarget: integer
insertsInsyncAfterInFlight: integer
insertsInsyncAfterInFlightInBytes: integer
insertsOOS: integer
insertsOOSBeforeCOOS: integer
insertsOOSInBytes: integer
insyncBeforeCOOS: integer
insyncBeforeCOOSInBytes: integer
remainingTimeFromSource: integer
remainingTimeFromTarget: integer
rowsFromSource: integer
rowsFromTarget: integer
rowsIntoSourceSort: integer
rowsIntoTargetSort: integer
totalRowsFromSource: integer
totalRowsFromTarget: integer
updatesInsyncAfterInFlight: integer
updatesOOS: string
updatesOOSBeforeCOOS: integer
updatesOOSInBytes: integer

{
    "type":"object",
    "description":"This stats will only be available when the compare pair is running and runId query parameter is used.",
    "properties":{
        "insyncBeforeCOOSInBytes":{
            "type":"integer"
        },
        "insyncBeforeCOOS":{
            "type":"integer"
        },
        "updatesOOS":{
            "type":"string"
        },
        "updatesInsyncAfterInFlight":{
            "type":"integer"
        },
        "updatesOOSBeforeCOOS":{
            "type":"integer"
        },
        "updatesOOSInBytes":{
            "type":"integer"
        },
        "deletesOOSInBytes":{
            "type":"integer"
        },
        "deletesInsyncAfterInFlightInBytes":{
            "type":"integer"
        },
        "deletesOOS":{
            "type":"integer"
        },
        "deletesOOSBeforeCOOS":{
            "type":"integer"
        },
        "deletesOOSBeforeCOOSInBytes":{
            "type":"integer"
        },
        "insertsInsyncAfterInFlight":{
            "type":"integer"
        },
        "insertsOOS":{
            "type":"integer"
        },
        "insertsOOSBeforeCOOS":{
            "type":"integer"
        },
        "insertsOOSInBytes":{
            "type":"integer"
        },
        "insertsInsyncAfterInFlightInBytes":{
            "type":"integer"
        },
        "rowsIntoTargetSort":{
            "type":"integer"
        },
        "rowsIntoSourceSort":{
            "type":"integer"
        },
        "deletesInsyncAfterInFlight":{
            "type":"integer"
        },
        "rowsFromSource":{
            "type":"integer"
        },
        "rowsFromTarget":{
            "type":"integer"
        },
        "totalRowsFromSource":{
            "type":"integer"
        },
        "totalRowsFromTarget":{
            "type":"integer"
        },
        "fetchLatencyFromTarget":{
            "type":"integer"
        },
        "remainingTimeFromTarget":{
            "type":"integer"
        },
        "remainingTimeFromSource":{
            "type":"integer"
        },
        "bytesFromTarget":{
            "type":"integer"
        },
        "bytesFromSource":{
            "type":"integer"
        },
        "bytesIntoSourceSort":{
            "type":"integer"
        },
        "bytesIntoTargetSort":{
            "type":"integer"
        }
    }
}

Nested Schema : coosDuration

Match All

Show Source

object Duration
object coosDuration-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Duration"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : initCompareDuration

Match All

Show Source

object Duration
object initCompareDuration-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Duration"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : sortingSrcDuration

Match All

Show Source

object Duration
object sortingSrcDuration-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Duration"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : sortingTgtDuration

Match All

Show Source

object Duration
object sortingTgtDuration-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Duration"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Duration

Type: object

Show Source

hours: integer
minutes: integer
seconds: integer
totalSeconds: integer

{
    "type":"object",
    "properties":{
        "hours":{
            "type":"integer"
        },
        "minutes":{
            "type":"integer"
        },
        "seconds":{
            "type":"integer"
        },
        "totalSeconds":{
            "type":"integer"
        }
    }
}

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.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

401 Response

"Unauthorized."

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

404 Response

"Not found."

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

500 Response

"Server error."

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}