GoldenGate Veridata REST API

ジョブ統計の取得

get

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

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

このAPIは、実行中のジョブおよび完了したジョブを監視するために使用されます。デフォルトでは、最新のジョブ統計が返されます。

リクエスト

問合せパラメータ

fromDate: string

日付範囲の始まり(指定した日付を含む)を定義して、ジョブのレスポンスをフィルタで除外します。サポートされる形式は「yyyy-MM-dd'T'HH:mm:ss'Z'」です。
jobId: string

ジョブID。レスポンスには、最後に完了した実行のグループおよび比較ペアが含められます。
last: string

最後のx単位のジョブ統計をフェッチします。サポートされる単位は、D (日)またはH (時間)またはM (分)です。例: 1D
runId: string

ジョブの実行ID。例: runId=1024,0,0。ジョブrunIdは、モニタリングAPIから取得できます。
status:
toDate: string

日付範囲の終わり(指定した日付を含まない)を定義して、ジョブのレスポンスをフィルタで除外します。サポートされる形式は「yyyy-MM-dd'T'HH:mm:ss'Z'」です。
type: string

サポートされている値: GROUP/CP。ジョブrunIdが問合せパラメータに渡される場合にのみ有効です。type=GROUPの場合、グループ基本統計情報が返され、type=CPの場合、グループ統計と比較ペア統計の両方がジョブ統計とともに返されます

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

先頭に戻る

レスポンス

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

application/json

200 レスポンス

完了したジョブのコレクションを統計とともに返します。

ルート・スキーマ: schema

タイプ: array

ソースの表示

配列: JobStats

実行中または完了したジョブの統計。

{ "type":"array", "items":{ "$ref":"#/components/schemas/JobStats" }, "example":[ { "runId":{ "asString":"12377/0/0", "comparePairNum":0, "groupNum":0, "runID":12377 }, "startTime":"2024-02-03T10:15:30Z", "endTime":"2024-02-03T10:15:30Z", "jobId":1017, "jobName":"repairTestJob", "status":"OOS", "repairStatus":"OOS", "repairRunId":{ "asString":"10207/0/0", "comparePairNum":0, "groupNum":0, "runID":"10207" }, "comparePairsTotal":1, "comparePairsProcessed":1, "comparePairsWithErrors":0, "comparePairsWithOOS":1, "comparePairsWithNoOOS":0, "comparePairsCancelled":0, "comparePairsRunning":0, "comparePairsPending":0, "skippedRows":false, "group":[ { "runId":{ "asString":"12377/1/0", "comparePairNum":0, "groupNum":1, "runID":12377 }, "startTime":"2024-02-03T10:15:30Z", "endTime":"2024-02-03T10:15:30Z", "grpId":1007, "name":"base", "numOfComparePairs":1, "comparePairs":[ { "runId":{ "asString":"12377/1/1", "comparePairNum":1, "groupNum":1, "runID":12377 }, "startTime":"2024-02-03T10:15:30Z", "endTime":"2024-02-03T10:15:30Z", "comparePairId":1017, "name":"SRC1=TRG1", "numRowsOos":7, "skippedRows":false, "phase":"FINISHED", "status":"OOS", "repairStatus":"OOS", "repairRunId":{ "asString":"10207/1/1", "comparePairNum":1, "groupNum":1, "runID":10207 }, "errorMessage":"" } ], "skippedRows":false, "repairStatus":"OOS", "repairRunId":{ "asString":"10207/1/0", "comparePairNum":0, "groupNum":1, "runID":10207 }, "srcConnection":{ "name":"oracleLocal", "id":1014, "dbType":"oracle" }, "trgConnection":{ "name":"oracleLocal", "id":1014, "dbType":"oracle" } } ], "repairJobs":[ { "repairRunId":{ "asString":"10207/0/0", "comparePairNum":0, "groupNum":0, "runID":10207 }, "repairStatus":"OOS", "startTime":"2024-02-03T10:15:30Z", "endTime":"2024-02-03T10:15:30Z" } ] } ] }

例:

[ { "runId":{ "asString":"12377/0/0", "comparePairNum":0, "groupNum":0, "runID":12377 }, "startTime":"2024-02-03T10:15:30Z", "endTime":"2024-02-03T10:15:30Z", "jobId":1017, "jobName":"repairTestJob", "status":"OOS", "repairStatus":"OOS", "repairRunId":{ "asString":"10207/0/0", "comparePairNum":0, "groupNum":0, "runID":"10207" }, "comparePairsTotal":1, "comparePairsProcessed":1, "comparePairsWithErrors":0, "comparePairsWithOOS":1, "comparePairsWithNoOOS":0, "comparePairsCancelled":0, "comparePairsRunning":0, "comparePairsPending":0, "skippedRows":false, "group":[ { "runId":{ "asString":"12377/1/0", "comparePairNum":0, "groupNum":1, "runID":12377 }, "startTime":"2024-02-03T10:15:30Z", "endTime":"2024-02-03T10:15:30Z", "grpId":1007, "name":"base", "numOfComparePairs":1, "comparePairs":[ { "runId":{ "asString":"12377/1/1", "comparePairNum":1, "groupNum":1, "runID":12377 }, "startTime":"2024-02-03T10:15:30Z", "endTime":"2024-02-03T10:15:30Z", "comparePairId":1017, "name":"SRC1=TRG1", "numRowsOos":7, "skippedRows":false, "phase":"FINISHED", "status":"OOS", "repairStatus":"OOS", "repairRunId":{ "asString":"10207/1/1", "comparePairNum":1, "groupNum":1, "runID":10207 }, "errorMessage":"" } ], "skippedRows":false, "repairStatus":"OOS", "repairRunId":{ "asString":"10207/1/0", "comparePairNum":0, "groupNum":1, "runID":10207 }, "srcConnection":{ "name":"oracleLocal", "id":1014, "dbType":"oracle" }, "trgConnection":{ "name":"oracleLocal", "id":1014, "dbType":"oracle" } } ], "repairJobs":[ { "repairRunId":{ "asString":"10207/0/0", "comparePairNum":0, "groupNum":0, "runID":10207 }, "repairStatus":"OOS", "startTime":"2024-02-03T10:15:30Z", "endTime":"2024-02-03T10:15:30Z" } ] } ]

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

実行中または完了したジョブの統計。

すべて一致

実行中または完了したジョブの統計。

ソースの表示

allOf JobsStats

実行中または完了したジョブの統計。
object JobStats-allOf[1]

{ "description":"Statistics of Running or Completed Job.", "allOf":[ { "$ref":"#/components/schemas/JobsStats" }, { "type":"object", "properties":{ "group":{ "type":"array", "items":{ "$ref":"#/components/schemas/GroupStats" } }, "repairJobs":{ "type":"array", "items":{ "$ref":"#/components/schemas/RepairJobBase" } } } } ] }

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

実行中または完了したジョブの統計。

すべて一致

実行中または完了したジョブの統計。

ソースの表示

object BaseStats
object JobsStats-allOf[1]

{ "description":"Statistics of Running or Completed Jobs.", "allOf":[ { "$ref":"#/components/schemas/BaseStats" }, { "type":"object", "properties":{ "jobId":{ "type":"integer", "format":"int64" }, "jobName":{ "type":"string" }, "status":{ "$ref":"#/components/schemas/JobFinishedStatus" }, "repairStatus":{ "$ref":"#/components/schemas/RepairStatus" }, "repairRunId":{ "$ref":"#/components/schemas/RunID", "type":"object" }, "comparePairsTotal":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsProcessed":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsWithErrors":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsWithOOS":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsWithNoOOS":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsCancelled":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsRunning":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsPending":{ "type":"integer", "format":"int32", "default":0 }, "skippedRows":{ "type":"boolean", "default":false } } } ] }

ネストされたスキーマ: 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" } } }

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

タイプ: object

ソースの表示

comparePairsCancelled: integer (int32)

デフォルト値: 0
comparePairsPending: integer (int32)

デフォルト値: 0
comparePairsProcessed: integer (int32)

デフォルト値: 0
comparePairsRunning: integer (int32)

デフォルト値: 0
comparePairsTotal: integer (int32)

デフォルト値: 0
comparePairsWithErrors: integer (int32)

デフォルト値: 0
comparePairsWithNoOOS: integer (int32)

デフォルト値: 0
comparePairsWithOOS: integer (int32)

デフォルト値: 0
jobId: integer (int64)
jobName: string
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":{ "jobId":{ "type":"integer", "format":"int64" }, "jobName":{ "type":"string" }, "status":{ "$ref":"#/components/schemas/JobFinishedStatus" }, "repairStatus":{ "$ref":"#/components/schemas/RepairStatus" }, "repairRunId":{ "$ref":"#/components/schemas/RunID", "type":"object" }, "comparePairsTotal":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsProcessed":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsWithErrors":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsWithOOS":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsWithNoOOS":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsCancelled":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsRunning":{ "type":"integer", "format":"int32", "default":0 }, "comparePairsPending":{ "type":"integer", "format":"int32", "default":0 }, "skippedRows":{ "type":"boolean", "default":false } } }

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

タイプ: object

ソースの表示

group: array group
repairJobs: array repairJobs

{ "type":"object", "properties":{ "group":{ "type":"array", "items":{ "$ref":"#/components/schemas/GroupStats" } }, "repairJobs":{ "type":"array", "items":{ "$ref":"#/components/schemas/RepairJobBase" } } } }

ネストされたスキーマ: 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." } } }

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

タイプ: array

ソースの表示

配列: GroupStats

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

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

タイプ: array

ソースの表示

配列: object RepairJobBase

RepairJobベース・オブジェクト。

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

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

すべて一致

ソースの表示

object BaseStats
object GroupStats-allOf[1]

{ "allOf":[ { "$ref":"#/components/schemas/BaseStats" }, { "type":"object", "properties":{ "grpId":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" }, "numOfComparePairs":{ "type":"integer", "format":"int64", "default":0 }, "comparePairs":{ "type":"array", "items":{ "$ref":"#/components/schemas/ComparePairBaseStats" } }, "skippedRows":{ "type":"boolean", "default":false }, "repairStatus":{ "$ref":"#/components/schemas/RepairStatus" }, "repairRunId":{ "$ref":"#/components/schemas/RunID", "type":"object" }, "srcConnection":{ "type":"object", "properties":{ "name":{ "type":"string" }, "id":{ "type":"integer" }, "dbType":{ "type":"string" } } }, "trgConnection":{ "type":"object", "properties":{ "name":{ "type":"string" }, "id":{ "type":"integer" }, "dbType":{ "type":"string" } } } } } ] }

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

タイプ: object

ソースの表示

comparePairs: array comparePairs
grpId: integer (int64)
name: string
numOfComparePairs: integer (int64)

デフォルト値: 0
repairRunId: object RunID

実行ID。
repairStatus: string

指定できる値: [ "PENDING", "RUNNING", "ERRORS", "WARNINGS", "SUCCESSFUL", "CANCELLED", "OOS" ]

修復ステータス。
skippedRows: boolean

デフォルト値: false
srcConnection: object srcConnection
trgConnection: object trgConnection

{ "type":"object", "properties":{ "grpId":{ "type":"integer", "format":"int64" }, "name":{ "type":"string" }, "numOfComparePairs":{ "type":"integer", "format":"int64", "default":0 }, "comparePairs":{ "type":"array", "items":{ "$ref":"#/components/schemas/ComparePairBaseStats" } }, "skippedRows":{ "type":"boolean", "default":false }, "repairStatus":{ "$ref":"#/components/schemas/RepairStatus" }, "repairRunId":{ "$ref":"#/components/schemas/RunID", "type":"object" }, "srcConnection":{ "type":"object", "properties":{ "name":{ "type":"string" }, "id":{ "type":"integer" }, "dbType":{ "type":"string" } } }, "trgConnection":{ "type":"object", "properties":{ "name":{ "type":"string" }, "id":{ "type":"integer" }, "dbType":{ "type":"string" } } } } }

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

タイプ: array

ソースの表示

配列: ComparePairBaseStats

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

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

タイプ: object

ソースの表示

dbType: string
id: integer
name: string

{ "type":"object", "properties":{ "name":{ "type":"string" }, "id":{ "type":"integer" }, "dbType":{ "type":"string" } } }

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

タイプ: object

ソースの表示

dbType: string
id: integer
name: string

{ "type":"object", "properties":{ "name":{ "type":"string" }, "id":{ "type":"integer" }, "dbType":{ "type":"string" } } }

ネストされたスキーマ: 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" } } } ] }

ネストされたスキーマ: 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" } } }

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

タイプ: object

RepairJobベース・オブジェクト。

ソースの表示

endTime: string (date-time)

パターン: YYYY-MM-DDTHH:mm:ss.sssZ

例: 2024-02-03T10:15:30Z
repairRunId: repairRunId
repairStatus: string

修復操作のステータス。
startTime: string (date-time)

パターン: YYYY-MM-DDTHH:mm:ss.sssZ

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

{ "type":"object", "description":"RepairJob Base object.", "properties":{ "repairRunId":{ "allOf":[ { "type":"object" }, { "$ref":"#/components/schemas/RunID" } ] }, "repairStatus":{ "type":"string", "description":"Status of Repair operation." }, "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" } } }

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

すべて一致

ソースの表示

object repairRunId-allOf[0]
object RunID

実行ID。

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

ネストされたスキーマ: repairRunId-allOf[0]

タイプ: 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." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

例:

{ "errCode":"OGGV-00001", "errMsg":"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." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

例:

{ "errCode":"OGGV-00001", "errMsg":"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." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

例:

{ "errCode":"OGGV-00001", "errMsg":"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." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

例:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }

先頭に戻る