移動

• リクエスト
• レスポンス

比較ペア統計の取得

get

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

必要なロール: Administrator、SuperUser、DetailMonitoringOperator、MonitoringOperator、CommandLineOperator

Veridata比較ペアの監視の詳細を取得するAPI。

リクエスト

問合せパラメータ

• cpId: integer
  比較ペアID。
• finishedStatsCount: integer
  このパラメータによって、レスポンスに表示される完了した統計(現在および前回の実行)の数が決まります。デフォルトは5です。
• fromDate: string
  日付範囲の始まり(指定した日付を含む)を定義して、比較ペアのレスポンスをフィルタで除外します。サポートされる形式は「yyyy-MM-dd'T'HH:mm:ss'Z'」です
• includePerformance: boolean
  このパラメータがtrueに設定されている場合、パフォーマンス統計が含められます。デフォルト値: false。
• last: string
  最後のx単位の比較ペア統計をフェッチします。サポートされる単位は、D (日)またはH (時間)またはM (分)です。例: 1D
• runId: string
  CPの実行ID。例: runId=1024,1,1。
• status:
• toDate: string
  日付範囲の終わり(指定した日を含まない)を定義して、比較ペアのレスポンスをフィルタで除外します。サポートされる形式は「yyyy-MM-dd'T'HH:mm:ss'Z'」です。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200 レスポンス

比較ペア統計が正常にフェッチされました。

本文()

ルート・スキーマ: schema

タイプ: array

ソースの表示

• 配列: ComparePairStats

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

ネストされたスキーマ: ComparePairStats

すべて一致

ソースの表示

• 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"
                }
            }
        }
    ]
}

ネストされたスキーマ: ComparePairBaseStats

すべて一致

ソースの表示

• 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"
                }
            }
        }
    ]
}

ネストされたスキーマ: BaseStats

タイプ: object

ソースの表示

• endTime: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• runId: object RunID
  実行ID。
• startTime: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 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"
        }
    }
}

ネストされたスキーマ: ComparePairBaseStats-allOf[1]

タイプ: object

ソースの表示

• comparePairId: integer (int64)
• errorMessage: string
• name: string
• numRowsOos: integer (int64)
  デフォルト値: 0
• phase: string
  指定できる値: [ "INITIALIZING", "INITCOMPARE", "INITCOMPARECOOS", "COOS", "SORTING", "FINISHED" ]

  比較フェーズの列挙。
• repairRunId: object RunID
  実行ID。
• repairStatus: string
  指定できる値: [ "PENDING", "RUNNING", "ERRORS", "WARNINGS", "SUCCESSFUL", "CANCELLED", "OOS" ]

  修復ステータス。
• skippedRows: boolean
  デフォルト値: false
• status: string
  指定できる値: [ "FAILED", "CANCELLED", "OUTOFSYNC", "INSYNC", "RUNNING", "FINISHED" ]

  ジョブ・ステータス。

{
    "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"
        }
    }
}

ネストされたスキーマ: ComparePairStats-allOf[1]

タイプ: object

ソースの表示

• deltaStartTime: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• deltaStats: object DeltaStats
• numOfDeletes: integer (int64)
  デフォルト値: 0
• numOfInserts: integer (int64)
  デフォルト値: 0
• numOfUpdates: integer (int64)
  デフォルト値: 0
• perfStats: object PerformanceStats
• rowsFromSource: integer (int64)
  デフォルト値: 0
• rowsFromTarget: integer (int64)
  デフォルト値: 0
• runningStats: object RunningComparePairStats
  この統計は、比較ペアが実行中で、runId問合せパラメータが使用されている場合にのみ使用できます。
• skippedRows: boolean
  デフォルト値: 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"
        }
    }
}

ネストされたスキーマ: RunID

タイプ: object

実行ID。

ソースの表示

• asString: string
  実行IDを文字列形式で表示します。
• comparePairNum: integer
  実行IDのpPart。
• groupNum: integer
  実行IDの一部
• runID: integer
  実行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."
        }
    }
}

ネストされたスキーマ: DeltaStats

タイプ: object

ソースの表示

• deltaRunId: string
  デルタ実行IDの例 - 1100,1,1
• deltaStartTime: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• srcDeltaInfo: string
  ソース・デルタ値。
• tgtDeltaInfo: string
  ターゲット・デルタ値。

{
    "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."
        }
    }
}

ネストされたスキーマ: PerformanceStats

タイプ: object

ソースの表示

• coosBytesPerSec: integer (int64)
  デフォルト値: 0
• coosDuration: coosDuration
• coosRowsPerSec: integer (int64)
  デフォルト値: 0
• coosStartTime: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• coosStopTime: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• coosTotalBytes: integer (int64)
  デフォルト値: 0
• coosTotalRows: integer (int64)
  デフォルト値: 0
• initCompareBytesPerSec: integer (int64)
  デフォルト値: 0
• initCompareDuration: initCompareDuration
• initCompareRowsPerSec: integer (int64)
  デフォルト値: 0
• initCompareStartTime: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• initCompareStopTime: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• initCompareTotalBytes: integer (int64)
  デフォルト値: 0
• initCompareTotalRows: integer (int64)
  デフォルト値: 0
• sortingSrcBytesPerSec: integer (int64)
  デフォルト値: 0
• sortingSrcDuration: sortingSrcDuration
• sortingSrcRowsPerSec: integer (int64)
  デフォルト値: 0
• sortingSrcStartTime: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• sortingSrcStopTime: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• sortingSrcTotalBytes: integer (int64)
  デフォルト値: 0
• sortingSrcTotalRows: integer (int64)
  デフォルト値: 0
• sortingTgtBytesPerSec: integer (int64)
  デフォルト値: 0
• sortingTgtDuration: sortingTgtDuration
• sortingTgtRowsPerSec: integer (int64)
  デフォルト値: 0
• sortingTgtStartTime: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• sortingTgtStopTime: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• sortingTgtTotalBytes: integer (int64)
  デフォルト値: 0
• sortingTgtTotalRows: integer (int64)
  デフォルト値: 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"
        }
    }
}

ネストされたスキーマ: RunningComparePairStats

タイプ: object

この統計は、比較ペアが実行中で、runId問合せパラメータが使用されている場合にのみ使用できます。

ソースの表示

• 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"
        }
    }
}

ネストされたスキーマ: coosDuration

すべて一致

ソースの表示

• object Duration
• object coosDuration-allOf[1]

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

ネストされたスキーマ: initCompareDuration

すべて一致

ソースの表示

• object Duration
• object initCompareDuration-allOf[1]

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

ネストされたスキーマ: sortingSrcDuration

すべて一致

ソースの表示

• object Duration
• object sortingSrcDuration-allOf[1]

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

ネストされたスキーマ: sortingTgtDuration

すべて一致

ソースの表示

• object Duration
• object sortingTgtDuration-allOf[1]

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

ネストされたスキーマ: Duration

タイプ: object

ソースの表示

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

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

ネストされたスキーマ: coosDuration-allOf[1]

タイプ: object

ネストされたスキーマ: initCompareDuration-allOf[1]

タイプ: object

ネストされたスキーマ: sortingSrcDuration-allOf[1]

タイプ: object

ネストされたスキーマ: sortingTgtDuration-allOf[1]

タイプ: object

400 レスポンス

不正なリクエスト。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

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

401 レスポンス

"権限がありません"。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

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

404 レスポンス

"見つかりません"。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

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

500 レスポンス

"サーバー・エラー"。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

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

先頭に戻る