Replicatの更新
patch
/services/{version}/replicats/{replicat}
既存のReplicatプロセスを更新します。
リクエスト
サポートされるメディア・タイプ
- application/json
パス・パラメータ
- replicat: string
最小長:
1
最大長:8
パターン:^[A-Z_$][A-Z0-9_$]*$
Replicatの名前。Replicat名は大文字で、先頭が英字、その後に英数字が最大で7文字続きます。
- version: string
Oracle GoldenGateサービスのAPIバージョン。
指定できる値:[ "v2" ]
ルート・スキーマ: Oracle GoldenGate Replicat
型:
object
タイトル:
ソースの表示
Oracle GoldenGate Replicat
- $schema(optional):
指定できる値:
[ "ogg:replicat" ]
- begin(optional): begin
データ処理の開始位置
- checkpoint(optional): checkpoint
チェックポイント・データの場所
- config(optional): array config
最小アイテム数:
0
最大アイテム数:32767
- credentials(optional): credentials
ターゲット・データベースの資格証明
- critical(optional): boolean
デフォルト値:
false
Replicatがデプロイメントにとってクリティカルであることを示します - description(optional): string
最小長:
1
最大長:4095
プロセスの説明 - encryptionProfile(optional): encryptionProfile
- intent(optional):
デフォルト値:
Unidirectional
指定できる値:[ "High Availability", "Disaster Recovery", "Unidirectional", "N-Way", "Sharding" ]
データ取得ワークフローの目的 - managedProcessSettings(optional): managedProcessSettings
Administration ServerでERプロセスが管理される方法を制御します
- mode(optional): mode
レプリケーションのモード
- registration(optional):
デフォルト値:
none
指定できる値:[ "none", "standard" ]
ターゲット・データベースへの登録 - source(optional): source
処理するデータのソース
- status(optional):
デフォルト値:
stopped
指定できる値:[ "starting", "running", "stopped", "killed", "abended" ]
Oracle GoldenGateプロセスのステータス - synchronized(optional): boolean
Replicatが同期状態で停止されることを示します
ネストされたスキーマ: begin
データ処理の開始位置
デフォルト値:
now
1つに一致
ソースの表示
-
指定できる値:
[ "now" ]
- string
最小長:
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])$
- object begin-x-oneOf[2]
ネストされたスキーマ: checkpoint
チェックポイント・データの場所
1つに一致
ソースの表示
-
指定できる値:
[ "files" ]
ローカル・ファイルシステムを使用してチェックポイント・データを格納します - object checkpoint-x-oneOf[1]
指定した表を使用してチェックポイント情報を格納します
ネストされたスキーマ: credentials
ターゲット・データベースの資格証明
デフォルト値:
oracle.doceng.json.BetterJsonNull@7139ff5a
1つに一致
ソースの表示
ネストされたスキーマ: managedProcessSettings
Administration ServerでERプロセスが管理される方法を制御します
1つに一致
ソースの表示
- object managedProcessSettings-x-oneOf[0]
カスタム設定
- string
最小長:
1
最大長:64
パターン:^[A-Za-z0-9][A-Za-z0-9_:-]*$
'ogg:managedProcessSettings'構成値の名前
ネストされたスキーマ: mode
レプリケーションのモード
1つに一致
ソースの表示
- object mode-x-oneOf[0]
標準の非統合Replicatを作成します
- object mode-x-oneOf[1]
(Oracleのみ)標準の統合Replicatを作成します
- object mode-x-oneOf[2]
(Oracleのみ)調整Replicat
ネストされたスキーマ: source
処理するデータのソース
1つに一致
ソースの表示
-
指定できる値:
[ "tables" ]
表を使用(初期ロード) - object source-x-oneOf[1]
- object source-x-oneOf[2]
ネストされたスキーマ: begin-x-oneOf[2]
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "type:position/atTrailRBA" ]
- offset(optional): integer
最小値:
0
最大値:2147483647
デフォルト値:0
トレイル順序ファイルのオフセット - sequence: integer
最小値:
0
最大値:999999999
デフォルト値:0
トレイル・ファイル順序番号
ネストされたスキーマ: credentials-x-oneOf[0]
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:credentialsRef" ]
- alias: string
最小長:
1
最大長:30
パターン:^[a-zA-Z][a-zA-Z0-9_#$]*$
- domain(optional): string
最小長:
1
最大長:30
デフォルト値:OracleGoldenGate
パターン:^[a-zA-Z][a-zA-Z0-9_#$]*$
ネストされたスキーマ: managedProcessSettings-x-oneOf[0]
型:
object
カスタム設定
ソースの表示
- $schema(optional):
指定できる値:
[ "ogg:managedProcessSettings" ]
- autoRestart(optional): object autoRestart
ERプロセスが終了した場合に、Administration Serverによって再起動される方法を制御します
- autoStart(optional): object autoStart
ERプロセスがAdministration Serverで起動される方法の説明
ネストされたスキーマ: autoRestart
型:
object
ERプロセスが終了した場合に、Administration Serverによって再起動される方法を制御します
デフォルト値:
ソースの表示
{ "enabled":false, "onSuccess":false, "delay":0, "retries":9, "window":60, "disableOnFailure":true }
- $schema(optional):
指定できる値:
[ "ogg:taskRestart" ]
- delay(optional): integer
最小値:
0
最大値:3600
デフォルト値:0
異常終了したプロセスの検出からプロセスの再起動までの待機時間(秒)。 - disableOnFailure(optional): boolean
デフォルト値:
true
trueの場合、実行ウィンドウで実行試行がすべて失敗するとタスクが無効になります。 - enabled: boolean
デフォルト値:
false
設定されると、タスクが終了した場合に再起動できます。 - failures(optional): integer
最小値:
0
最大値:3600
現在のウィンドウでタスクが失敗した回数。 - onSuccess(optional): boolean
デフォルト値:
false
falseの場合、タスクが失敗した場合のみ再起動されます。 - retries(optional): integer
最小値:
0
最大値:3600
デフォルト値:9
再試行操作が中止されるまでタスクを再起動する最大回数。 - window(optional): integer
最小値:
0
最大値:604800
デフォルト値:60
再試行回数をカウントする時間枠(秒)。
ネストされたスキーマ: autoStart
型:
object
ERプロセスがAdministration Serverで起動される方法の説明
ソースの表示
- delay(optional): integer
最小値:
0
最大値:3600
デフォルト値:0
プロセスを起動するまでに待機する時間(秒) - enabled: boolean
デフォルト値:
false
設定した場合、プロセスはAdministration Serverが起動されると起動されます
ネストされたスキーマ: mode-x-oneOf[0]
型:
object
標準の非統合Replicatを作成します
ソースの表示
- parallel(optional): boolean
デフォルト値:
false
複数の操作をパラレルで適用します - type:
指定できる値:
[ "nonintegrated" ]
ネストされたスキーマ: mode-x-oneOf[1]
型:
object
(Oracleのみ)標準の統合Replicatを作成します
ソースの表示
- parallel(optional): boolean
デフォルト値:
false
複数の操作をパラレルで適用します - type:
指定できる値:
[ "integrated" ]
ネストされたスキーマ: mode-x-oneOf[2]
型:
object
(Oracleのみ)調整Replicat
ソースの表示
- maxThreads(optional): integer
最小値:
1
最大値:500
デフォルト値:25
- threadNumber(optional): integer
最小値:
1
最大値:500
- type:
指定できる値:
[ "coordinated" ]
ネストされたスキーマ: source-x-oneOf[1]
型:
ソースの表示
object
- name: string
最小長:
2
最大長:2
パターン:^[A-Za-z][A-Za-z0-9]$
トレイルの名前 - path(optional): string
最小長:
1
最大長:4096
トレイル・データが格納されるパス
ネストされたスキーマ: source-x-oneOf[2]
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:file" ]
- filename: string
最小長:
1
最大長:4096
ファイルの名前 - remote(optional): boolean
デフォルト値:
false
ファイルがローカルかリモートかを示します
リクエストの例(application/json)
{
"status":"running"
}
レスポンス
サポートされるメディア・タイプ
- application/json
200レスポンス
Replicatプロセスが正常に変更されました。
ルート・スキーマ: RESTful API Standard Response
型:
object
タイトル:
RESTful API Standard Response
すべてのOracle GoldenGate RESTful APIコールの標準レスポンス
ソースの表示
- $schema(optional):
指定できる値:
[ "api:standardResponse" ]
- links: array links
最小アイテム数:
0
最大アイテム数:16
リクエストのOracle GoldenGateリンク - messages: array messages
最小アイテム数:
0
最大アイテム数:65535
リクエストの間に発行されるGoldenGateメッセージ - response(optional): object response
リクエストのOracle GoldenGateドキュメント
ネストされたスキーマ: response
型:
object
リクエストのOracle GoldenGateドキュメント
ネストされたスキーマ: items
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:link" ]
- description(optional): string
最小長:
1
最大長:4095
このリンク固有の情報と詳細を提供する、人が読むための説明。 - href: string
最小長:
2
最大長:4095
パターン:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
リンクの絶対URI - mediaType(optional): string
最小長:
6
最大長:255
パターン:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$
メディア・タイプ - RFC 4288 (https://tools.ietf.org/html/rfc4288)を参照 - rel:
指定できる値:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]
hrefとリクエスト対象のリンクlinkの関係
ネストされたスキーマ: items
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:message" ]
- code: string
最小長:
9
最大長:9
パターン:^OGG[-][0-9]{5}$
Oracle GoldenGateメッセージ・コード - issued: string
最小長:
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])$
メッセージが発行された日時 - severity:
指定できる値:
[ "INFO", "WARNING", "ERROR" ]
メッセージの重大度 - title: string
最小長:
1
最大長:4095
この情報、警告またはエラーに固有の情報と詳細を提供する、人が読むための説明。 - type: string
最小長:
2
最大長:4095
パターン:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
情報、警告またはエラーのタイプを説明するページの絶対URI [RFC3986]。
レスポンスの例(application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/replicats/REP2",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/replicats/REP2",
"mediaType":"application/json",
"rel":"self"
}
],
"messages":[
{
"$schema":"ogg:message",
"code":"OGG-00975",
"issued":"2021-03-15T17:23:51Z",
"severity":"INFO",
"title":"Replicat group REP2 starting.",
"type":"http://docs.oracle.com/goldengate/c2110/gg-winux/GMESG/oggus.htm#OGG-00975"
},
{
"$schema":"ogg:message",
"code":"OGG-15445",
"issued":"2021-03-15T17:23:51Z",
"severity":"INFO",
"title":"Replicat group REP2 started.",
"type":"http://docs.oracle.com/goldengate/c2110/gg-winux/GMESG/oggus.htm#OGG-15445"
}
]
}