GoldenGate Veridata REST API

修復ジョブ

post

http://{host}:{port}/veridata/v1/services/repair/jobs/{runId}

必要なロール: Administrator、SuperUser、CommandLineOperator、RepairOperator

Veridataジョブを修復します。

リクエスト

パス・パラメータ

runId(必須): string

比較ジョブの実行ID。たとえば、runId=1024,0,0です。これは、モニタリングAPIから取得できるジョブの実行の一意のIDを定義します。

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

application/json

ルート・スキーマ: schema

タイプ: object

ソースの表示

cps: array cps

修復する比較ペアのリスト。
operationType: string

指定できる値: [ "UPDATE", "DELETE", "INSERT" ]

操作タイプのフィルタ。
repairPassword: string (password)

ユーザー・パスワードを修復します。
repairSQL: boolean

デフォルト値: false

修復SQL問合せをターゲット・データベースで直接実行するのではなく、修復SQL問合せを生成して返すかどうかを決定するパラメータ。デフォルト値: false
repairStatus: string

指定できる値: [ "OOS", "WARNING", "ERRORS", "CANCELLED" ]

修復ステータスのフィルタ。修復ステータスと異なる方法でマッピングされたフィルタ。
repairUser: string

修復SQL問合せを実行するためにターゲット・データベースで使用されるユーザー資格証明

{
    "type":"object",
    "properties":{
        "repairUser":{
            "type":"string",
            "description":"User credentials to be used in target database to run repair SQL Queries"
        },
        "repairPassword":{
            "description":"Repair user Password.",
            "type":"string",
            "format":"password"
        },
        "repairSQL":{
            "description":"Parameter to decide if the repair SQL queries should be generated and returned instead of running repair SQL queries directly on the target database. Default value: false",
            "type":"boolean",
            "default":false
        },
        "repairStatus":{
            "description":"Comma seperated repair status of Out of sync rows. This is a filter of out of sync rows to be repaired.",
            "$ref":"#/components/schemas/RepairApplyStatusFilter"
        },
        "operationType":{
            "description":"Comma seperated Operation type of the Out of sync rows. This is a filter of out of sync rows to be repaired.",
            "$ref":"#/components/schemas/RepairApplyOperationTypeFilter"
        },
        "cps":{
            "description":"List of compare pairs to be repaired.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RepairCP"
            }
        }
    },
    "example":{
        "repairUser":"Ram,",
        "repairPassword":"Veridata@123",
        "repairSQL":"false,",
        "repairStatus":"OOS,",
        "operationType":"UPDATE,",
        "cps":[
            {
                "cpId":"1023,",
                "repairStatus":"OOS,",
                "operationType":"UPDATE,",
                "rowIds":[
                    "10, 20, 30"
                ]
            }
        ]
    }
}

例:

{
    "repairUser":"Ram,",
    "repairPassword":"Veridata@123",
    "repairSQL":"false,",
    "repairStatus":"OOS,",
    "operationType":"UPDATE,",
    "cps":[
        {
            "cpId":"1023,",
            "repairStatus":"OOS,",
            "operationType":"UPDATE,",
            "rowIds":[
                "10, 20, 30"
            ]
        }
    ]
}

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

タイプ: array

修復する比較ペアのリスト。

ソースの表示

配列: object RepairCP

{
    "description":"List of compare pairs to be repaired.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RepairCP"
    }
}

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

タイプ: object

ソースの表示

cpId: integer

比較ペアID。
operationType: string

指定できる値: [ "UPDATE", "DELETE", "INSERT" ]

操作タイプのフィルタ。
repairStatus: string

指定できる値: [ "OOS", "WARNING", "ERRORS", "CANCELLED" ]

修復ステータスのフィルタ。修復ステータスと異なる方法でマッピングされたフィルタ。
rowIds: array rowIds

各非同期行IDのリスト。GGROWHASH列の値は行のIDになります。INSERTの場合はソース側、DELETEの場合はターゲット側、およびUPDATEの場合はソース側とターゲット側をつなげたものを送信します。

{
    "type":"object",
    "properties":{
        "cpId":{
            "description":"Compare pair Id.",
            "type":"integer"
        },
        "repairStatus":{
            "description":"Comma seperated repair status of Out of sync rows. This is a filter of out of sync rows to be repaired.",
            "$ref":"#/components/schemas/RepairApplyStatusFilter"
        },
        "operationType":{
            "description":"Comma seperated Operation type of the Out of sync rows. This is a filter of out of sync rows to be repaired.",
            "$ref":"#/components/schemas/RepairApplyOperationTypeFilter"
        },
        "rowIds":{
            "description":"List of each Out Of Sync row ids. GGROWHASH column value will be the id for the row. Send source side for INSERT, target side for DELETE and source side concatenation with target side for UPDATE.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

タイプ: array

各非同期行IDのリスト。GGROWHASH列の値は行のIDになります。INSERTの場合はソース側、DELETEの場合はターゲット側、およびUPDATEの場合はソース側とターゲット側をつなげたものを送信します。

ソースの表示

配列: string

{
    "description":"List of each Out Of Sync row ids. GGROWHASH column value will be the id for the row. Send source side for INSERT, target side for DELETE and source side concatenation with target side for UPDATE.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

application/json

200 レスポンス

修復ジョブが正常に発行されました。次のレスポンスは、repairSQLがfalseの場合にのみ表示されます。それ以外の場合、バイトがレスポンスで返されます。

ルート・スキーマ: schema

タイプ: object

ソースの表示

runID: integer

修復ジョブ実行ID。

{
    "type":"object",
    "properties":{
        "runID":{
            "type":"integer",
            "description":"Repair Job Run ID."
        }
    }
}

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

先頭に戻る