1. Oracle GoldenGate Microservices REST API
  2. タスク
  3. Administrative Server
  4. Extracts

Extractの更新

patch

/services/{version}/extracts/{extract}

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

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

リクエスト

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

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

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

    指定できる値: [ "v2" ]
本文()
ルート・スキーマ: Oracle GoldenGate Extract
型: object
タイトル: Oracle GoldenGate Extract
ソースの表示
ネストされたスキーマ: alias
型: object
ソースの表示
ネストされたスキーマ: 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]
ネストされたスキーマ: config
型: array
最小アイテム数: 0
最大アイテム数: 32767
ソースの表示
ネストされたスキーマ: credentials
ソース・データベースの資格証明
デフォルト値: oracle.doceng.json.BetterJsonNull@6d60899e
1つに一致
ソースの表示
ネストされたスキーマ: encryptionProfile
1つに一致
ソースの表示
  • 最小長: 1
    最大長: 64
    パターン: ^[A-Za-z0-9][A-Za-z0-9_:-]*$
    'ogg:encryptionProfile'構成値の名前
ネストされたスキーマ: managedProcessSettings
Administration ServerでERプロセスが管理される方法を制御します
1つに一致
ソースの表示
ネストされたスキーマ: miningCredentials
ダウンストリーム・マイニング・データベースの資格証明
デフォルト値: oracle.doceng.json.BetterJsonNull@107bfcb2
1つに一致
ソースの表示
ネストされたスキーマ: registration
ソース・データベースへの登録
デフォルト値: none
1つに一致
ソースの表示
ネストされたスキーマ: source
処理するデータのソース
1つに一致
ソースの表示
  • 指定できる値: [ "tables" ]
    表を使用(初期ロード)
  • 指定できる値: [ "tranlogs" ]
    チェンジ・データ・キャプチャでのトランザクション・ログの使用
  • source-x-oneOf[2]
    サポートされていないOGG 19c構文
ネストされたスキーマ: targets
型: array
最小アイテム数: 0
最大アイテム数: 1024
取得されるデータのターゲット
ソースの表示
ネストされたスキーマ: manager
型: object
使用するマネージャ・サーバー
ソースの表示
ネストされたスキーマ: proxy
型: object
ソースの表示
ネストされたスキーマ: host
ホスト名またはIPアドレス
1つに一致
ソースの表示
  • 最小長: 1
    最大長: 4095
    パターン: ^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$
    ネットワーク・ホスト名
  • host-x-oneOf[1]
    ネットワークIPアドレス
ネストされたスキーマ: host-x-oneOf[1]
ネットワークIPアドレス
1つに一致
ソースの表示
  • 最小長: 7
    最大長: 15
    パターン: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
    ネットワークIPv4アドレス
  • 最小長: 1
    最大長: 256
    パターン: ^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$
    ネットワークIPv6アドレス
ネストされたスキーマ: credentials
プロキシ・サーバーの資格証明
デフォルト値: oracle.doceng.json.BetterJsonNull@63d5874f
1つに一致
ソースの表示
ネストされたスキーマ: host
プロキシ・サーバーのホスト名またはIPアドレス
1つに一致
ソースの表示
  • 最小長: 1
    最大長: 4095
    パターン: ^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$
    ネットワーク・ホスト名
  • host-x-oneOf[1]
    ネットワークIPアドレス
ネストされたスキーマ: 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_#$]*$
ネストされたスキーマ: host-x-oneOf[1]
ネットワークIPアドレス
1つに一致
ソースの表示
  • 最小長: 7
    最大長: 15
    パターン: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
    ネットワークIPv4アドレス
  • 最小長: 1
    最大長: 256
    パターン: ^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$
    ネットワークIPv6アドレス
ネストされたスキーマ: begin-x-oneOf[2]
型: object
ソースの表示
ネストされたスキーマ: at
型: object
特定のSCNの位置(統合モード)
ソースの表示
ネストされたスキーマ: csn
1つに一致
ソースの表示
  • 最小値: 0
    最大値: 9223372036854776000
    Oracle Databaseの場合のシステム変更番号(標準形式)。
    例: 6488359
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    Oracle Databaseの場合のシステム変更番号(代替形式)。
    例: 6488359.3456712
ネストされたスキーマ: 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が起動されると起動されます
ネストされたスキーマ: miningCredentials-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_#$]*$
ネストされたスキーマ: registration-x-oneOf[0]
1つに一致
ソースの表示
ネストされたスキーマ: registration-x-oneOf[0]-x-oneOf[0]
型: object
統合Extractの登録オプション
ソースの表示
いずれかに一致
ソースの表示
ネストされたスキーマ: containers
型: array
最小アイテム数: 0
最大アイテム数: 256
ソースの表示
ネストされたスキーマ: csn
1つに一致
ソースの表示
  • 最小値: 0
    最大値: 9223372036854776000
    Oracle Databaseの場合のシステム変更番号(標準形式)。
    例: 6488359
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    Oracle Databaseの場合のシステム変更番号(代替形式)。
    例: 6488359.3456712
ネストされたスキーマ: share
LogMinerデータ・ディクショナリを共有する方法を示します
デフォルト値: false
1つに一致
ソースの表示
  • 最小長: 1
    最大長: 8
    パターン: ^[A-Z_$][A-Z0-9_$]*$
ネストされたスキーマ: items
1つに一致
ソースの表示
  • 最小長: 1
    最大長: 130
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])$
ネストされたスキーマ: source-x-oneOf[2]
型: object
サポートされていないOGG 19c構文
ソースの表示
ネストされたスキーマ: items
1つに一致
ソースの表示
ネストされたスキーマ: items-x-oneOf[0]
型: object
ソースの表示
  • 指定できる値: [ "ogg:trail" ]
  • 最小長: 2
    最大長: 2
    パターン: ^[A-Za-z][A-Za-z0-9]$
    トレイルの名前
  • 最小値: 0
    最大値: 2147483647
    トレイル順序ファイルのオフセット
  • 最小長: 1
    最大長: 4096
    トレイル・データが格納されるパス
  • デフォルト値: false
    トレイルがローカルかリモートかを示します
  • 最小値: 0
    最大値: 999999999
    デフォルト値: 0
    トレイルの開始順序番号
  • デフォルト値: 9
    指定できる値: [ "6", "9" ]
    順序ファイル名の字数
  • デフォルト値: false
    順序番号の長さが変化することを示します
  • 最小値: 0
    最大値: 999999999
    デフォルト値: 0
    デプロイメントに存在する最大のトレイル順序番号
  • 最小値: 0
    最大値: 999999999
    デフォルト値: 0
    使用されている最大のトレイル順序番号
  • 最小値: 0
    最大値: 999999999
    デフォルト値: 0
    デプロイメントに存在する最小のトレイル順序番号
  • 最小値: 0
    最大値: 999999999
    デフォルト値: 0
    使用されている最小のトレイル順序番号
  • 最小値: 1
    最大値: 2000
    デフォルト値: 500
    トレイル内のファイルの最大サイズ(MB)。
  • 最小値: 0
    最大値: 18446744073709552000
    すべてのトレイル順序によって消費されたバイト数
リクエストの例(application/json)
{
    "status":"running"
}
先頭に戻る

レスポンス

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

200レスポンス

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

本文()
ルート・スキーマ: 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:11001/services/v2/extracts/EXT2",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-00975",
            "issued":"2021-07-13T16:37:08Z",
            "severity":"INFO",
            "title":"Extract group EXT2 starting.",
            "type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-00975"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-15426",
            "issued":"2021-07-13T16:37:08Z",
            "severity":"INFO",
            "title":"Extract group EXT2 started.",
            "type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-15426"
        }
    ]
}
先頭に戻る