1. Oracle GoldenGate REST API 21c (21.1.0)
  2. タスク
  3. Distribution Server

既存のOracle GoldenGate分散パスの取得

get

/services/{version}/sources/{distpath}

リクエスト

パス・パラメータ
  • 最小長: 1
    最大長: 32
    パターン: ^[A-Za-z][A-Za-z0-9-_.]*$

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

    指定できる値: [ "v2" ]
先頭に戻る

レスポンス

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

200レスポンス

本文()
ルート・スキーマ: Oracle GoldenGate Distribution Path
型: object
タイトル: Oracle GoldenGate Distribution Path
ソースの表示
ネストされたスキーマ: begin
データ処理の開始位置
デフォルト値: { "sequence":0, "offset":0 }
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]
ネストされたスキーマ: options
型: object
分散パスのオプション
ソースの表示
ネストされたスキーマ: ruleset
1つに一致
ソースの表示
ネストされたスキーマ: source
型: object
パスのソース・エンドポイント
ソースの表示
ネストされたスキーマ: status
Oracle GoldenGateの分散パスのステータス
デフォルト値: stopped
1つに一致
ソースの表示
  • デフォルト値: stopped
    指定できる値: [ "paused", "running", "stopping", "stopped", "killed", "uninitialized" ]
  • status-x-oneOf[1]
    分散パスを開始するための拡張オプション
  • status-x-oneOf[2]
    分散パスを停止するための拡張オプション
ネストされたスキーマ: target
型: object
パスのターゲット・エンドポイント
ソースの表示
ネストされたスキーマ: begin-x-oneOf[2]
型: object
ソースの表示
ネストされたスキーマ: autoRestart
型: object
停止されたパスを自動的に再起動する必要があるかどうかを示します
ソースの表示
  • 最小値: 0
    最大値: 60
    デフォルト値: 2
    パスを再起動してから次に再起動するまでに一時停止する時間(分)。
  • 最小値: 0
    最大値: 3600
    デフォルト値: 10
    停止されたパスを再起動する再試行の最大回数。再試行回数を0に設定するとautoRestartが無効になります
ネストされたスキーマ: network
型: object
エンドポイントのネットワークの詳細
ソースの表示
ネストされたスキーマ: reportCount
型: object
DSによって処理されたトランザクション・レコードの数をレポートするレポート数オプション。
ソースの表示
  • 指定できる値: [ "ogg:reportcountOption" ]
  • 最小値: 1
    最大値: 4.294967295E9
    デフォルト値: 5000
    レコード数を出力する間隔。
  • 指定できる値: [ "records", "seconds", "minutes", "hours" ]
    カウントの単位。
  • デフォルト値: true
    1秒当たりの操作数、およびパフォーマンス指標として変更レートをレポートします。
ネストされたスキーマ: appOptions
型: object
アプリケーションのオプション
ソースの表示
ネストされたスキーマ: socketOptions
ソケットのオプション
1つに一致
ソースの表示
ネストされたスキーマ: socketOptions-x-oneOf[0]
型: object
ソースの表示
ネストされたスキーマ: socketOptions-x-oneOf[1]
型: object
ソースの表示
ネストされたスキーマ: tcpOptions
型: object
tcpチューニング・オプション
ソースの表示
ネストされたスキーマ: udpOptions
型: object
udpチューニング・オプション
ソースの表示
ネストされたスキーマ: ruleset-x-oneOf[0]
型: object
分散パスのルールセット
ソースの表示
ネストされたスキーマ: rules
型: array
最小アイテム数: 1
最大アイテム数: 1024
ソースの表示
ネストされたスキーマ: items
型: object
ソースの表示
ネストされたスキーマ: actions
型: array
最小アイテム数: 1
最大アイテム数: 128
ソースの表示
ネストされたスキーマ: filters
型: array
最小アイテム数: 1
最大アイテム数: 4096
ソースの表示
ネストされたスキーマ: items
型: object
ソースの表示
ネストされたスキーマ: items
1つに一致
ソースの表示
ネストされたスキーマ: items-x-oneOf[0]
型: object
ソースの表示
ネストされたスキーマ: items-x-oneOf[1]
型: object
ソースの表示
ネストされたスキーマ: items-x-oneOf[2]
型: object
ソースの表示
ネストされたスキーマ: items-x-oneOf[3]
型: object
ソースの表示
ネストされたスキーマ: items-x-oneOf[4]
型: object
ソースの表示
ネストされたスキーマ: items-x-oneOf[5]
型: object
ソースの表示
  • デフォルト値: false
    前述セットの否定
  • tags
    一連のタグ。有効なタグ値を含むLCRにはall、タグなしのLCRにはnoneを指定します
ネストされたスキーマ: items-x-oneOf[6]
型: object
ソースの表示
ネストされたスキーマ: items-x-oneOf[7]
型: object
ソースの表示
ネストされたスキーマ: chunkIds
型: array
最小アイテム数: 0
最大アイテム数: 2147483647
一連のチャンクID
ソースの表示
ネストされたスキーマ: chunkIdRanges
型: array
最小アイテム数: 1
最大アイテム数: 2147483647
一連のチャンクID範囲
ソースの表示
ネストされたスキーマ: items
型: object
ソースの表示
ネストされたスキーマ: objectNames
型: array
最小アイテム数: 1
最大アイテム数: 65535
一連のオブジェクト名
ソースの表示
  • items
    修飾された表名(すべての名前コンポーネントがワイルドカード文字を含むことができる)
ネストされたスキーマ: items
修飾された表名(すべての名前コンポーネントがワイルドカード文字を含むことができる)
いずれかに一致
ソースの表示
  • 最小長: 3
    最大長: 261
    パターン: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • 最小長: 5
    最大長: 392
    パターン: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
ネストされたスキーマ: objectTypes
型: array
最小アイテム数: 1
最大アイテム数: 7
一連のオブジェクト型
ソースの表示
  • 指定できる値: [ "DML", "DDL", "Procedure", "INSERT", "UPDATE", "UPSERT", "DELETE" ]
ネストされたスキーマ: columnValues
型: array
最小アイテム数: 1
最大アイテム数: 65535
一連の列値
ソースの表示
ネストされたスキーマ: items
型: object
ソースの表示
  • 最小長: 1
    最大長: 130
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])$
    列の名前
  • columnValue
    列データ。現在は文字と2進整数のみがサポートされます
  • デフォルト値: before
    指定できる値: [ "before", "after" ]
    列のビフォア・イメージまたはアフター・イメージ。INSERTはアフター・イメージのみ、DELETEはビフォア・イメージのみです。ビフォア・イメージとアフター・イメージの両方があるケースに適用されます。
  • デフォルト値: equalTo
    指定できる値: [ "equalTo", "notEqualTo", "lessThan", "lessThanOrEqualTo", "greaterThan", "greaterThanOrEqualTo" ]
    比較演算子
  • tableName
    列が存在する表の名前
ネストされたスキーマ: columnValue
列データ。現在は文字と2進整数のみがサポートされます
1つに一致
ソースの表示
ネストされたスキーマ: tableName
列が存在する表の名前
いずれかに一致
ソースの表示
  • 最小長: 3
    最大長: 261
    パターン: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • 最小長: 5
    最大長: 392
    パターン: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
ネストされたスキーマ: tags
一連のタグ。有効なタグ値を含むLCRにはall、タグなしのLCRにはnoneを指定します
1つに一致
ソースの表示
  • tags-x-oneOf[0]
    最小アイテム数: 1
    最大アイテム数: 2147483647
  • 指定できる値: [ "all", "none" ]
ネストされたスキーマ: tags-x-oneOf[0]
型: array
最小アイテム数: 1
最大アイテム数: 2147483647
ソースの表示
ネストされたスキーマ: items
1つに一致
ソースの表示
ネストされたスキーマ: items-x-oneOf[0]
型: object
タグ値を表すバイナリ文字列。
ソースの表示
ネストされたスキーマ: items-x-oneOf[1]
型: object
タグ値を表す16進文字列。
ソースの表示
ネストされたスキーマ: items-x-oneOf[2]
型: object
バイナリ・タグ・ビットマスク値。ビットAND演算子が、LCRに関連付けられたタグに対して実行されます。
ソースの表示
  • 最小長: 1
    最大長: 2000
    パターン: [01]{1,2000}
    タグ・マスク値を表すバイナリ文字列。
ネストされたスキーマ: items-x-oneOf[3]
型: object
16進タグ・ビットマスク値。ビットAND演算子が、LCRに関連付けられたタグに対して実行されます。
ソースの表示
  • 最小長: 1
    最大長: 2000
    パターン: [A-Fa-f0-9]{1,2000}
    タグ・マスク値を表す16進文字列。
ネストされたスキーマ: procedureFeatureNames
型: array
最小アイテム数: 1
最大アイテム数: 32
一連のプロシージャ機能名
ソースの表示
  • 最小長: 1
    最大長: 128
    パターン: ^[*a-zA-Z][*a-zA-Z0-9_#$]*$
ネストされたスキーマ: partitionNames
型: array
最小アイテム数: 1
最大アイテム数: 65535
一連のパーティション名
ソースの表示
  • items
    修飾されたパーティション名(すべての名前コンポーネントがワイルドカード文字を含むことができる)
ネストされたスキーマ: items
修飾されたパーティション名(すべての名前コンポーネントがワイルドカード文字を含むことができる)
いずれかに一致
ソースの表示
  • 最小長: 7
    最大長: 523
    パターン: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • 最小長: 5
    最大長: 392
    パターン: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
ネストされたスキーマ: authenticationMethod
パスの開始時に使用する認証方式
1つに一致
ソースの表示
ネストされたスキーマ: details
型: object
エンドポイント詳細情報
ネストされたスキーマ: proxy
型: object
ターゲットに接続するためのプロキシ
ソースの表示
  • 指定できる値: [ "ogg:distPathEndpointProxy" ]
  • 最小長: 1
    最大長: 30
    パターン: ^[a-zA-Z][a-zA-Z0-9_#$]*$
    資格証明ストアの別名
  • 最小長: 1
    最大長: 30
    デフォルト値: OracleGoldenGate
    パターン: ^[a-zA-Z][a-zA-Z0-9_#$]*$
    資格証明ストアのドメイン
  • 指定できる値: [ "SOCKS5", "HTTP" ]
    プロキシ・サーバーのタイプ
  • 最小長: 2
    最大長: 4095
    パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    プロキシ・サーバーのURI
ネストされたスキーマ: uri
エンドポイントURIの指定
1つに一致
ソースの表示
  • uri-x-oneOf[0]
    最小アイテム数: 1
    最大アイテム数: 2147483647
  • 最小長: 2
    最大長: 4095
    パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
ネストされたスキーマ: authenticationMethod-x-oneOf[1]
型: object
証明書認証
ソースの表示
  • 最小長: 1
    最大長: 32
    パターン: ^[A-Za-z0-9][A-Za-z0-9._-]*$
    証明書名
ネストされたスキーマ: authenticationMethod-x-oneOf[2]
型: object
資格証明の認証
ソースの表示
ネストされたスキーマ: uri-x-oneOf[0]
型: array
最小アイテム数: 1
最大アイテム数: 2147483647
ソースの表示
  • 最小長: 2
    最大長: 4095
    パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
ネストされたスキーマ: status-x-oneOf[1]
型: object
分散パスを開始するための拡張オプション
1つに一致
ソースの表示
ネストされたスキーマ: status-x-oneOf[2]
型: object
分散パスを停止するための拡張オプション
ソースの表示
ネストされたスキーマ: status-x-oneOf[1]-x-oneOf[0]
型: object
ソースの表示
ネストされたスキーマ: status-x-oneOf[1]-x-oneOf[1]
型: object
ソースの表示
ネストされたスキーマ: at
1つに一致
ソースの表示
  • 最小値: 0
    最大値: 9.223372036854776E18
    標準の形式
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    代替の形式
ネストされたスキーマ: after
1つに一致
ソースの表示
  • 最小値: 0
    最大値: 9.223372036854776E18
    標準の形式
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    代替の形式
ネストされたスキーマ: authenticationMethod
パスの開始時に使用する認証方式
1つに一致
ソースの表示
ネストされたスキーマ: details
型: object
エンドポイント詳細情報
ネストされたスキーマ: proxy
型: object
ターゲットに接続するためのプロキシ
ソースの表示
  • 指定できる値: [ "ogg:distPathEndpointProxy" ]
  • 最小長: 1
    最大長: 30
    パターン: ^[a-zA-Z][a-zA-Z0-9_#$]*$
    資格証明ストアの別名
  • 最小長: 1
    最大長: 30
    デフォルト値: OracleGoldenGate
    パターン: ^[a-zA-Z][a-zA-Z0-9_#$]*$
    資格証明ストアのドメイン
  • 指定できる値: [ "SOCKS5", "HTTP" ]
    プロキシ・サーバーのタイプ
  • 最小長: 2
    最大長: 4095
    パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    プロキシ・サーバーのURI
ネストされたスキーマ: uri
エンドポイントURIの指定
1つに一致
ソースの表示
  • uri-x-oneOf[0]
    最小アイテム数: 1
    最大アイテム数: 2147483647
  • 最小長: 2
    最大長: 4095
    パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
ネストされたスキーマ: authenticationMethod-x-oneOf[1]
型: object
証明書認証
ソースの表示
  • 最小長: 1
    最大長: 32
    パターン: ^[A-Za-z0-9][A-Za-z0-9._-]*$
    証明書名
ネストされたスキーマ: authenticationMethod-x-oneOf[2]
型: object
資格証明の認証
ソースの表示
ネストされたスキーマ: uri-x-oneOf[0]
型: array
最小アイテム数: 1
最大アイテム数: 2147483647
ソースの表示
  • 最小長: 2
    最大長: 4095
    パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
レスポンスの例(application/json)
{
    "$schema":"api:standardResponse",
    "response":{
        "begin":{
            "sequence":0,
            "offset":0
        },
        "name":"path1",
        "$schema":"ogg:distPath",
        "status":"running",
        "ruleset":{
            "name":"mypath1 ruleset",
            "rules":[
                {
                    "name":"chunkid rule",
                    "filters":[
                        {
                            "chunkIds":[
                                1,
                                2,
                                3
                            ]
                        },
                        {
                            "chunkIdRanges":[
                                {
                                    "chunkIdBegin":10,
                                    "chunkIdEnd":20
                                },
                                {
                                    "chunkIdBegin":30,
                                    "chunkIdEnd":50
                                }
                            ]
                        }
                    ],
                    "actions":[
                        {
                            "command":"keep"
                        }
                    ]
                }
            ]
        },
        "source":{
            "uri":"trail://localhost:9000/dirdat/a1"
        },
        "target":{
            "uri":"ogg://localhost:9000/dirdat/t1",
            "details":{
                "network":{
                    "tcpBufSize":27996
                },
                "trail":{
                    "seqLength":9,
                    "sizeMB":100
                }
            }
        },
        "options":{
            "includeAll":false
        },
        "description":"my test distPath"
    },
    "messages":[
    ],
    "links":[
    ]
}
先頭に戻る