1. Oracle GoldenGate 23ai Microservices Architecture REST APIドキュメンテーション
  2. タスク
  3. 管理サービス
  4. Replicat

Replicatの更新

patch

/services/{version}/replicats/{replicat}

必要なロール: オペレータ

既存のReplicatプロセスを更新します。「Operator」ロールを持つユーザーが、「status」プロパティを変更できます。その他の変更を行うには、「Administrator」ロールが必要です。

リクエスト

サポートされるメディア・タイプ
パス・パラメータ
  • 最小長: 1
    最大長: 8
    パターン: ^[A-Z_$][A-Z0-9_$]*$

    Replicatの名前。Replicat名は大文字で、先頭が英字、その後に英数字が最大で7文字続きます。

  • Oracle GoldenGateサービスのAPIバージョン。

    指定できる値: [ "v2" ]
本文()
ルート・スキーマ: Oracle GoldenGate Replicat
型: object
タイトル: Oracle GoldenGate Replicat
ソースの表示
ネストされたスキーマ: begin
データ処理の開始位置
デフォルト値: now
1つに一致
ソースの表示
  • 指定できる値: [ "now" ]
  • 最小長: 20
    最大長: 32
    パターン: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$
  • begin-x-oneOf[2]
ネストされたスキーマ: checkpoint
チェックポイント・データの場所
1つに一致
ソースの表示
  • 指定できる値: [ "files" ]
    ローカル・ファイルシステムを使用してチェックポイント・データを格納します
  • checkpoint-x-oneOf[1]
    指定した表を使用してチェックポイント情報を格納します
ネストされたスキーマ: config
型: array
最小アイテム数: 0
最大アイテム数: 32767
ソースの表示
ネストされたスキーマ: credentials
ターゲット・データベースの資格証明
デフォルト値: oracle.doceng.json.BetterJsonNull@7baf6acf
1つに一致
ソースの表示
ネストされたスキーマ: encryptionProfile
1つに一致
ソースの表示
  • 最小長: 1
    最大長: 64
    パターン: ^[A-Za-z0-9][A-Za-z0-9_:-]*$
    'ogg:encryptionProfile'構成値の名前
ネストされたスキーマ: managedProcessSettings
Administration ServerでERプロセスが管理される方法を制御します
1つに一致
ソースの表示
ネストされたスキーマ: mode
レプリケーションのモード
1つに一致
ソースの表示
ネストされたスキーマ: source
処理するデータのソース
1つに一致
ソースの表示
ネストされたスキーマ: begin-x-oneOf[2]
型: object
ソースの表示
  • 指定できる値: [ "type:position/atTrailRBA" ]
  • 最小値: 0
    最大値: 2147483647
    デフォルト値: 0
    トレイル順序ファイルのオフセット
  • 最小値: 0
    最大値: 999999999
    デフォルト値: 0
    トレイル・ファイル順序番号
ネストされたスキーマ: checkpoint-x-oneOf[1]
型: object
指定した表を使用してチェックポイント情報を格納します
ソースの表示
ネストされたスキーマ: table
いずれかに一致
ソースの表示
  • 最小長: 3
    最大長: 261
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
  • 最小長: 5
    最大長: 392
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
ネストされたスキーマ: credentials-x-oneOf[0]
型: object
ソースの表示
  • 指定できる値: [ "ogg:credentialsRef" ]
  • 最小長: 1
    最大長: 30
    パターン: ^[a-zA-Z][a-zA-Z0-9_#$]*$
  • 最小長: 1
    最大長: 30
    デフォルト値: OracleGoldenGate
    パターン: ^[a-zA-Z][a-zA-Z0-9_#$]*$
ネストされたスキーマ: managedProcessSettings-x-oneOf[0]
型: object
カスタム設定
ソースの表示
ネストされたスキーマ: autoRestart
型: object
ERプロセスが終了した場合に、Administration Serverによって再起動される方法を制御します
デフォルト値: { "enabled":false, "onSuccess":false, "delay":"0", "retries":"9", "window":"60", "disableOnFailure":true }
ソースの表示
  • 指定できる値: [ "ogg:taskRestart" ]
  • 最小値: 0
    最大値: 3600
    デフォルト値: 0
    異常終了したプロセスの検出からプロセスの再起動までの待機時間(秒)。
  • デフォルト値: true
    trueの場合、実行ウィンドウで実行試行がすべて失敗するとタスクが無効になります。
  • デフォルト値: false
    設定されると、タスクが終了した場合に再起動できます。
  • 最小値: 0
    最大値: 3600
    現在のウィンドウでタスクが失敗した回数。
  • デフォルト値: false
    falseの場合、タスクが失敗した場合のみ再起動されます。
  • 最小値: 0
    最大値: 3600
    デフォルト値: 9
    再試行操作が中止されるまでタスクを再起動する最大回数。
  • 最小値: 0
    最大値: 604800
    デフォルト値: 60
    再試行回数をカウントする時間枠(秒)。
ネストされたスキーマ: autoStart
型: object
ERプロセスがAdministration Serverで起動される方法の説明
ソースの表示
  • 最小値: 0
    最大値: 3600
    デフォルト値: 0
    プロセスを起動するまでに待機する時間(秒)
  • デフォルト値: false
    設定した場合、プロセスはAdministration Serverが起動されると起動されます
ネストされたスキーマ: mode-x-oneOf[0]
型: object
標準の非統合Replicatを作成します
ソースの表示
ネストされたスキーマ: mode-x-oneOf[1]
型: object
(Oracleのみ)標準の統合Replicatを作成します
ソースの表示
ネストされたスキーマ: mode-x-oneOf[2]
型: object
(Oracleのみ)調整Replicat
ソースの表示
ネストされたスキーマ: parallel
1つに一致
ソースの表示
  • デフォルト値: false
    複数の操作をパラレルで適用します
  • 指定できる値: [ "bidirectional", "unidirectional" ]
    (SQL Serverのみ)双方向パラレル・モードで複数の操作を適用します
ネストされたスキーマ: source-x-oneOf[1]
型: object
ソースの表示
ネストされたスキーマ: source-x-oneOf[2]
型: object
ソースの表示
  • 指定できる値: [ "ogg:trailRef" ]
  • 最小長: 2
    最大長: 512
    パターン: ^[a-zA-Z0-9_#$/-]*$
    トレイルの名前
  • 最小長: 1
    最大長: 4096
    トレイル・データが格納されるパス
リクエストの例(application/json)
{
    "status":"running"
}
先頭に戻る

レスポンス

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

200レスポンス

Replicatプロセスが正常に変更されました。

本文()
ルート・スキーマ: RESTful API Standard Response
型: object
タイトル: RESTful API Standard Response
すべてのOracle GoldenGate RESTful APIコールの標準レスポンス
ソースの表示
ネストされたスキーマ: messages
型: array
最小アイテム数: 0
最大アイテム数: 65535
リクエストの間に発行されるGoldenGateメッセージ
ソースの表示
ネストされたスキーマ: response
型: object
リクエストのOracle GoldenGateドキュメント
ネストされたスキーマ: items
型: object
ソースの表示
  • 指定できる値: [ "ogg:message" ]
  • 最小長: 9
    最大長: 9
    パターン: ^OGG[-][0-9]{5}$
    Oracle GoldenGateメッセージ・コード
  • 最小長: 20
    最大長: 32
    パターン: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$
    メッセージが発行された日時
  • 指定できる値: [ "INFO", "WARNING", "ERROR" ]
    メッセージの重大度
  • 最小長: 1
    最大長: 4095
    この情報、警告またはエラーに固有の情報と詳細を提供する、人が読むための説明。
  • 最小長: 2
    最大長: 4095
    パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    情報、警告またはエラーのタイプを説明するページの絶対URI [RFC3986]。
レスポンスの例(application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/replicats/REPS",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/replicats/REPS",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-00975",
            "issued":"2024-04-03T22:35:29Z",
            "severity":"INFO",
            "title":"Replicat group REPS starting.",
            "type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-15445",
            "issued":"2024-04-03T22:35:29Z",
            "severity":"INFO",
            "title":"Replicat group REPS started.",
            "type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
        }
    ]
}
先頭に戻る