Extractの取得
get
/services/{version}/extracts/{extract}
Extractプロセスの詳細を取得します。
リクエスト
パス・パラメータ
- extract: string
最小長:
1最大長:8パターン:^[A-Z_$][A-Z0-9_$]*$Extractの名前。Extract名は大文字で、先頭が英字、その後に英数字が最大で7文字続きます。
- version: string
Oracle GoldenGateサービスのAPIバージョン。
指定できる値:[ "v2" ]
レスポンス
サポートされるメディア・タイプ
- application/json
200レスポンス
Extractの詳細が正常に取得されました。
ルート・スキーマ: Oracle GoldenGate Extract
型:
objectタイトル:
ソースの表示
Oracle GoldenGate Extract- $schema(optional):
指定できる値:
[ "ogg:extract" ] - alias(optional): object alias
- begin(optional): begin
データ処理の開始位置
- config(optional): array config
最小アイテム数:
0最大アイテム数:32767 - credentials(optional): credentials
ソース・データベースの資格証明
- critical(optional): boolean
デフォルト値:
falseExtractがデプロイメントにとってクリティカルであることを示します - 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プロセスが管理される方法を制御します
- miningCredentials(optional): miningCredentials
ダウンストリーム・マイニング・データベースの資格証明
- passive(optional): boolean
デフォルト値:
falseターゲット上で別名によって制御されるパッシブExtract - registration(optional): registration
ソース・データベースへの登録
- rollover(optional):
指定できる値:
[ true ]Extractの再起動時に、次の順序のトレイル・ファイルに切り替えさせます。 - source(optional): source
処理するデータのソース
- status(optional):
デフォルト値:
stopped指定できる値:[ "starting", "running", "stopped", "killed", "abended" ]Oracle GoldenGateプロセスのステータス - targets(optional): array targets
最小アイテム数:
0最大アイテム数:1024取得されるデータのターゲット - type(optional):
指定できる値:
[ "Alias", "Classic", "Initial Load", "Integrated", "Passive", "Remote Task", "Source Extract" ]OGG Extractプロセス・タイプ(読取り専用)
ネストされたスキーマ: alias
型:
ソースの表示
object- manager(optional): object manager
使用するマネージャ・サーバー
- name(optional): string
最小長:
1最大長:8パターン:^[A-Z_$][A-Z0-9_$]*$ソース上のパッシブExtractの名前 - proxy(optional): object proxy
ネストされたスキーマ: begin
データ処理の開始位置
デフォルト値:
now1つに一致
ソースの表示
-
指定できる値:
[ "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]
ネストされたスキーマ: credentials
ソース・データベースの資格証明
デフォルト値:
oracle.doceng.json.BetterJsonNull@25df373d1つに一致
ソースの表示
ネストされたスキーマ: managedProcessSettings
Administration ServerでERプロセスが管理される方法を制御します
1つに一致
ソースの表示
- object managedProcessSettings-x-oneOf[0]
カスタム設定
- string
最小長:
1最大長:64パターン:^[A-Za-z0-9][A-Za-z0-9_:-]*$'ogg:managedProcessSettings'構成値の名前
ネストされたスキーマ: miningCredentials
ダウンストリーム・マイニング・データベースの資格証明
デフォルト値:
oracle.doceng.json.BetterJsonNull@48e2a9cb1つに一致
ソースの表示
ネストされたスキーマ: registration
ソース・データベースへの登録
デフォルト値:
none1つに一致
ソースの表示
- registration-x-oneOf[0]
-
指定できる値:
[ "none", "default" ]
ネストされたスキーマ: source
処理するデータのソース
1つに一致
ソースの表示
-
指定できる値:
[ "tables" ]表を使用(初期ロード) -
指定できる値:
[ "tranlogs" ]チェンジ・データ・キャプチャでのトランザクション・ログの使用 - object source-x-oneOf[2]
サポートされていないOGG 19c構文
ネストされたスキーマ: manager
型:
object使用するマネージャ・サーバー
ソースの表示
- host: host
ホスト名またはIPアドレス
- port: integer
最小値:
1最大値:65535IPポート番号
ネストされたスキーマ: proxy
型:
ソースの表示
object- credentials(optional): credentials
プロキシ・サーバーの資格証明
- host: host
プロキシ・サーバーのホスト名またはIPアドレス
- port: integer
最小値:
1最大値:65535プロキシ・サーバーのポート番号
ネストされたスキーマ: host
ホスト名またはIPアドレス
1つに一致
ソースの表示
- string
最小長:
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つに一致
ソースの表示
- string
最小長:
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アドレス - string
最小長:
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@5ec32f691つに一致
ソースの表示
ネストされたスキーマ: host
プロキシ・サーバーのホスト名またはIPアドレス
1つに一致
ソースの表示
- string
最小長:
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- $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_#$]*$
ネストされたスキーマ: host-x-oneOf[1]
ネットワークIPアドレス
1つに一致
ソースの表示
- string
最小長:
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アドレス - string
最小長:
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- $schema(optional):
指定できる値:
[ "type:position/atDbms" ] - at: object at
特定のSCNの位置(統合モード)
ネストされたスキーマ: 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
型:
objectERプロセスが終了した場合に、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
デフォルト値:
truetrueの場合、実行ウィンドウで実行試行がすべて失敗するとタスクが無効になります。 - enabled: boolean
デフォルト値:
false設定されると、タスクが終了した場合に再起動できます。 - failures(optional): integer
最小値:
0最大値:3600現在のウィンドウでタスクが失敗した回数。 - onSuccess(optional): boolean
デフォルト値:
falsefalseの場合、タスクが失敗した場合のみ再起動されます。 - retries(optional): integer
最小値:
0最大値:3600デフォルト値:9再試行操作が中止されるまでタスクを再起動する最大回数。 - window(optional): integer
最小値:
0最大値:604800デフォルト値:60再試行回数をカウントする時間枠(秒)。
ネストされたスキーマ: autoStart
型:
objectERプロセスがAdministration Serverで起動される方法の説明
ソースの表示
- delay(optional): integer
最小値:
0最大値:3600デフォルト値:0プロセスを起動するまでに待機する時間(秒) - enabled: boolean
デフォルト値:
false設定した場合、プロセスはAdministration Serverが起動されると起動されます
ネストされたスキーマ: miningCredentials-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_#$]*$
ネストされたスキーマ: registration-x-oneOf[0]
1つに一致
ソースの表示
- object registration-x-oneOf[0]-x-oneOf[0]
統合Extractの登録オプション
ネストされたスキーマ: registration-x-oneOf[0]-x-oneOf[0]
型:
object統合Extractの登録オプション
ソースの表示
- containers(optional): array containers
最小アイテム数:
0最大アイテム数:256 - csn(optional): csn
- optimized(optional): boolean
デフォルト値:
false - replace(optional): boolean
デフォルト値:
falsetrueの場合、Extractの既存の登録の詳細を同じ名前で置換します - share(optional): share
いずれかに一致
ソースの表示
ネストされたスキーマ: source-x-oneOf[2]
型:
objectサポートされていないOGG 19c構文
ソースの表示
- tranlogs:
指定できる値:
[ "integrated", "classic" ]
ネストされたスキーマ: items-x-oneOf[0]
型:
ソースの表示
object- $schema(optional):
指定できる値:
[ "ogg:trail" ] - name: string
最小長:
2最大長:2パターン:^[A-Za-z][A-Za-z0-9]$トレイルの名前 - offset(optional): integer
最小値:
0最大値:2147483647トレイル順序ファイルのオフセット - path(optional): string
最小長:
1最大長:4096トレイル・データが格納されるパス - remote(optional): boolean
デフォルト値:
falseトレイルがローカルかリモートかを示します - sequence(optional): integer
最小値:
0最大値:999999999デフォルト値:0トレイルの開始順序番号 - sequenceLength(optional):
デフォルト値:
9指定できる値:[ 6, 9 ]順序ファイル名の字数 - sequenceLengthFlip(optional): boolean
デフォルト値:
false順序番号の長さが変化することを示します - sizeMB(optional): integer
最小値:
1最大値:2000デフォルト値:500トレイル内のファイルの最大サイズ(MB)。
レスポンスの例(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"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/extract",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"begin":"now",
"config":[
"Extract EXT2",
"ExtTrail X2 Format Release 12.3",
"UseridAlias oggadmin",
"Table oggadmin.*;"
],
"encryptionProfile":"LocalWallet",
"$schema":"ogg:extract",
"status":"running",
"targets":[
{
"name":"X2",
"offset":4522,
"remote":false,
"sequence":0,
"sequenceLength":9,
"sequenceLengthFlip":false,
"sizeMB":500
}
],
"registration":{
"csn":1525908
},
"source":"tranlogs",
"type":"Integrated",
"credentials":{
"alias":"oggadmin"
}
}
}