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

Extractの更新

patch

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

既存のExtractプロセスを更新します。

リクエスト

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

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

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

    指定できる値: [ "v2" ]
本文()
ルート・スキーマ: Oracle GoldenGate Extract
型: object
タイトル: Oracle GoldenGate Extract
ソースの表示
  • 指定できる値: [ "ogg:extract" ]
  • alias
  • begin
    データ処理の開始位置
  • config
    最小アイテム数: 0
    最大アイテム数: 32767
  • credentials
    ソース・データベースの資格証明
  • 最小長: 1
    最大長: 4095
    プロセスの説明
  • デフォルト値: Unidirectional
    指定できる値: [ "High Availability", "Disaster Recovery", "Unidirectional", "N-Way", "Sharding" ]
    データ取得ワークフローの目的
  • miningCredentials
    ダウンストリーム・マイニング・データベースの資格証明
  • デフォルト値: false
    ターゲット上で別名によって制御されるパッシブExtract
  • registration
    ソース・データベースへの登録
  • 指定できる値: [ true ]
    Extractの再起動時に、次の順序のトレイル・ファイルに切り替えさせます。
  • source
    処理するデータのソース
  • デフォルト値: stopped
    指定できる値: [ "starting", "running", "stopped", "killed", "abended" ]
    Oracle GoldenGateプロセスのステータス
  • targets
    最小アイテム数: 0
    最大アイテム数: 1024
    取得されるデータのターゲット
ネストされたスキーマ: 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@506328aa
1つに一致
ソースの表示
ネストされたスキーマ: miningCredentials
ダウンストリーム・マイニング・データベースの資格証明
デフォルト値: oracle.doceng.json.BetterJsonNull@53a517e9
1つに一致
ソースの表示
ネストされたスキーマ: registration
ソース・データベースへの登録
デフォルト値: none
1つに一致
ソースの表示
ネストされたスキーマ: source
処理するデータのソース
1つに一致
ソースの表示
ネストされたスキーマ: 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])[.]?)$
    ネットワーク・ホスト名
  • 最小長: 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@2e66541a
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])[.]?)$
    ネットワーク・ホスト名
  • 最小長: 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-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_#$]*$
ネストされたスキーマ: begin-x-oneOf[2]
型: object
ソースの表示
ネストされたスキーマ: at
1つに一致
ソースの表示
ネストされたスキーマ: at-x-oneOf[0]
型: object
アーカイブ・ログでの位置(クラシック・モード、非スレッド)
ソースの表示
  • 最小値: 0
    最大値: 2147483647
    デフォルト値: 0
  • 最小値: 1
    最大値: 4.294967295E9
    デフォルト値: 1
いずれかに一致
ソースの表示
ネストされたスキーマ: at-x-oneOf[1]
型: object
アーカイブ・ログでの位置(クラシック・モード、スレッド)
ソースの表示
ネストされたスキーマ: at-x-oneOf[2]
型: object
特定のSCNの位置(統合モード)
ソースの表示
ネストされたスキーマ: positions
型: array
最小アイテム数: 1
最大アイテム数: 100
ソースの表示
  • items
    アーカイブ・ログでの位置(クラシックExtractの1スレッド)
ネストされたスキーマ: items
型: object
アーカイブ・ログでの位置(クラシックExtractの1スレッド)
ソースの表示
ネストされたスキーマ: position
1つに一致
ソースの表示
  • 指定できる値: [ "now" ]
  • position-x-oneOf[1]
  • 最小長: 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])$
  • position-x-oneOf[3]
    アーカイブ・ログでの位置(クラシック・モード、非スレッド)
ネストされたスキーマ: position-x-oneOf[1]
1つに一致
ソースの表示
  • 最小値: 1
    最大値: 9.223372036854776E18
    標準の形式
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    代替の形式
ネストされたスキーマ: position-x-oneOf[3]
型: object
アーカイブ・ログでの位置(クラシック・モード、非スレッド)
ソースの表示
  • 最小値: 0
    最大値: 2147483647
    デフォルト値: 0
  • 最小値: 1
    最大値: 4.294967295E9
    デフォルト値: 1
いずれかに一致
ソースの表示
ネストされたスキーマ: csn
1つに一致
ソースの表示
  • 最小値: 1
    最大値: 9.223372036854776E18
    標準の形式
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    代替の形式
ネストされたスキーマ: 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_#$]*$
ネストされたスキーマ: 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
クラシック・モードの登録オプション
ソースの表示
ネストされたスキーマ: registration-x-oneOf[0]-x-oneOf[1]
型: object
統合Extractの登録オプション
ソースの表示
いずれかに一致
ソースの表示
ネストされたスキーマ: containers
型: array
最小アイテム数: 0
最大アイテム数: 256
ソースの表示
ネストされたスキーマ: csn
1つに一致
ソースの表示
  • 最小値: 1
    最大値: 9.223372036854776E18
    標準の形式
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    代替の形式
ネストされたスキーマ: share
LogMinerデータ・ディクショナリを共有する方法を示します
デフォルト値: false
1つに一致
ソースの表示
  • 最小長: 1
    最大長: 8
    パターン: ^[A-Z_$][A-Z0-9_$]*$
ネストされたスキーマ: items
1つに一致
ソースの表示
  • 最小長: 1
    最大長: 130
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])$
ネストされたスキーマ: source-x-oneOf[1]
1つに一致
ソースの表示
ネストされたスキーマ: source-x-oneOf[1]-x-oneOf[0]
型: object
統合Extractでトランザクション・ログを使用します
ソースの表示
ネストされたスキーマ: source-x-oneOf[1]-x-oneOf[1]
型: object
クラシックExtractでトランザクション・ログを使用します
ソースの表示
ネストされたスキーマ: items
1つに一致
ソースの表示
ネストされたスキーマ: items-x-oneOf[0]
型: object
ソースの表示
  • 指定できる値: [ "ogg:trail" ]
  • 最小長: 1
    最大長: 2
    パターン: ^[A-Za-z][A-Za-z0-9]?$
    トレイルの名前
  • 最小値: 0
    最大値: 2147483647
    トレイル順序ファイルのオフセット
  • 最小長: 1
    最大長: 255
    トレイル・データが格納されるパス
  • デフォルト値: false
    トレイルがローカルかリモートかを示します
  • 最小値: 0
    最大値: 999999999
    デフォルト値: 0
    トレイルの開始順序番号
  • デフォルト値: 9
    指定できる値: [ 6, 9 ]
    順序ファイル名の字数
  • デフォルト値: false
    順序番号の長さが変化することを示します
  • 最小値: 1
    最大値: 2000
    デフォルト値: 500
    トレイル内のファイルの最大サイズ(MB)。
リクエストの例(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":"2017-12-14T12:42:16Z",
            "severity":"INFO",
            "title":"EXTRACT EXT2 starting",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-00975"
        }
    ]
}