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
ソース・データベースの資格証明
- description(optional): string
最小長:
1
最大長:4095
プロセスの説明 - intent(optional):
デフォルト値:
Unidirectional
指定できる値:[ "High Availability", "Disaster Recovery", "Unidirectional", "N-Way", "Sharding" ]
データ取得ワークフローの目的 - 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
取得されるデータのターゲット
ネストされたスキーマ: alias
型:
ソースの表示
object
- manager(optional): object manager
使用するマネージャ・サーバー
- name(optional): string
最小長:
1
最大長:8
パターン:^[A-Z_$][A-Z0-9_$]*$
ソース上のパッシブExtractの名前 - proxy(optional): object proxy
ネストされたスキーマ: 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]
ネストされたスキーマ: credentials
ソース・データベースの資格証明
デフォルト値:
oracle.doceng.json.BetterJsonNull@6d0bcf8c
1つに一致
ソースの表示
ネストされたスキーマ: miningCredentials
ダウンストリーム・マイニング・データベースの資格証明
デフォルト値:
oracle.doceng.json.BetterJsonNull@7e43b342
1つに一致
ソースの表示
ネストされたスキーマ: registration
ソース・データベースへの登録
デフォルト値:
none
1つに一致
ソースの表示
- registration-x-oneOf[0]
-
指定できる値:
[ "none", "default" ]
ネストされたスキーマ: manager
型:
object
使用するマネージャ・サーバー
ソースの表示
- host: host
ホスト名またはIPアドレス
- port: integer
最小値:
1
最大値:65535
IPポート番号
ネストされたスキーマ: 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])[.]?)$
ネットワーク・ホスト名 - 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@738ed8f5
1つに一致
ソースの表示
ネストされたスキーマ: 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])[.]?)$
ネットワーク・ホスト名 - 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-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_#$]*$
ネストされたスキーマ: begin-x-oneOf[2]
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "type:position/atDbms" ]
- at: at
ネストされたスキーマ: at
1つに一致
ソースの表示
- object at-x-oneOf[0]
アーカイブ・ログでの位置(クラシック・モード、非スレッド)
- object at-x-oneOf[1]
アーカイブ・ログでの位置(クラシック・モード、スレッド)
- object at-x-oneOf[2]
特定のSCNの位置(統合モード)
ネストされたスキーマ: at-x-oneOf[0]
型:
object
アーカイブ・ログでの位置(クラシック・モード、非スレッド)
ソースの表示
- rba(optional): integer
最小値:
0
最大値:2147483647
デフォルト値:0
- seqno(optional): integer
最小値:
1
最大値:4.294967295E9
デフォルト値:1
いずれかに一致
ソースの表示
ネストされたスキーマ: at-x-oneOf[1]
型:
object
アーカイブ・ログでの位置(クラシック・モード、スレッド)
ソースの表示
- positions: array positions
最小アイテム数:
1
最大アイテム数:100
ネストされたスキーマ: positions
型:
array
最小アイテム数:
1
最大アイテム数:
ソースの表示
100
- 配列: object items
アーカイブ・ログでの位置(クラシックExtractの1スレッド)
ネストされたスキーマ: items
型:
object
アーカイブ・ログでの位置(クラシックExtractの1スレッド)
ソースの表示
- position: position
- thread: integer
最小値:
1
最大値:100
ネストされたスキーマ: position
1つに一致
ソースの表示
-
指定できる値:
[ "now" ]
- position-x-oneOf[1]
- 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 position-x-oneOf[3]
アーカイブ・ログでの位置(クラシック・モード、非スレッド)
ネストされたスキーマ: position-x-oneOf[3]
型:
object
アーカイブ・ログでの位置(クラシック・モード、非スレッド)
ソースの表示
- rba(optional): integer
最小値:
0
最大値:2147483647
デフォルト値:0
- seqno(optional): integer
最小値:
1
最大値:4.294967295E9
デフォルト値:1
いずれかに一致
ソースの表示
ネストされたスキーマ: 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_#$]*$
ネストされたスキーマ: 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]
クラシック・モードの登録オプション
- object registration-x-oneOf[0]-x-oneOf[1]
統合Extractの登録オプション
ネストされたスキーマ: registration-x-oneOf[0]-x-oneOf[0]
型:
object
クラシック・モードの登録オプション
ソースの表示
- logretention:
指定できる値:
[ true ]
ネストされたスキーマ: registration-x-oneOf[0]-x-oneOf[1]
型:
object
統合Extractの登録オプション
ソースの表示
- containers(optional): array containers
最小アイテム数:
0
最大アイテム数:256
- csn(optional): csn
- optimized(optional): boolean
デフォルト値:
false
- replace(optional): boolean
デフォルト値:
false
trueの場合、Extractの既存の登録の詳細を同じ名前で置換します - share(optional): share
いずれかに一致
ソースの表示
ネストされたスキーマ: source-x-oneOf[1]
1つに一致
ソースの表示
- object source-x-oneOf[1]-x-oneOf[0]
統合Extractでトランザクション・ログを使用します
- object source-x-oneOf[1]-x-oneOf[1]
クラシックExtractでトランザクション・ログを使用します
ネストされたスキーマ: source-x-oneOf[1]-x-oneOf[0]
型:
object
統合Extractでトランザクション・ログを使用します
ソースの表示
- tranlogs:
指定できる値:
[ "integrated" ]
ネストされたスキーマ: source-x-oneOf[1]-x-oneOf[1]
型:
object
クラシックExtractでトランザクション・ログを使用します
ソースの表示
- threads(optional): integer
最小値:
1
最大値:34
- tranlogs:
指定できる値:
[ "classic" ]
ネストされたスキーマ: items-x-oneOf[0]
型:
ソースの表示
object
- $schema(optional):
指定できる値:
[ "ogg:trail" ]
- name: string
最小長:
1
最大長:2
パターン:^[A-Za-z][A-Za-z0-9]?$
トレイルの名前 - offset(optional): integer
最小値:
0
最大値:2147483647
トレイル順序ファイルのオフセット - path(optional): string
最小長:
1
最大長:255
トレイル・データが格納されるパス - 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":{
"$schema":"ogg:extract",
"begin":"now",
"config":[
"Extract EXT2",
"ExtTrail X2 Format Release 12.3",
"UseridAlias oggadmin",
"Table oggadmin.*;"
],
"credentials":{
"alias":"oggadmin"
},
"registration":{
"csn":1526609
},
"source":{
"tranlogs":"integrated"
},
"status":"running",
"targets":[
{
"name":"X2",
"offset":3987,
"remote":false,
"sequence":0,
"sequenceLength":9,
"sequenceLengthFlip":false,
"sizeMB":500
}
]
}
}