1. Oracle GoldenGate 19c Microservices Architecture REST API
  2. タスク
  3. Administrative Server
  4. コマンド

コマンドの実行

post

/services/{version}/commands/execute

コマンドを実行します。レポート・コマンドは、「User」ロールを持つユーザーがアクセスできます。その他のコマンドには「Operator」ロールが必要です。

リクエスト

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

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

    指定できる値: [ "v2" ]
本文()
ルート・スキーマ: Oracle GoldenGate Task Manager Command
タイトル: Oracle GoldenGate Task Manager Command
1つに一致
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[0]
型: object
ExtractまたはReplicatの起動
ソースの表示
  • 指定できる値: [ "ogg:command" ]
  • after
    ExtractまたはReplicatに、指定したCSNを持つトランザクションの後の最初のトランザクションの先頭に開始位置を配置するように指示します。指定したCSN以下のCSN値が含まれているデータ・ソース内のトランザクションは、すべてスキップされます。
  • at
    ExtractまたはReplicatに、指定したCSNを持つトランザクションに開始位置を配置するように指示します。指定したCSNより小さいCSN値を持つデータ・ソース内のトランザクションはすべてスキップされます。
  • デフォルト値: true
    Replicatに、すでに処理されたトランザクションを無視させます。Extractが新しい開始ポイントに再配置され(ATCSNまたはAFTERCSNを使用)、Replicatの異常終了を引き起こす可能性のある重複トランザクションがトレイル内にあることが確認されたときに使用します。このオプションではチェックポイント表の使用が必要です。データベースがOracleの場合、このオプションは非統合モードのReplicatに対してのみ有効です。統合モードでは重複トランザクションが透過的に処理されます。デフォルトは、trueです。
  • 指定できる値: [ "start" ]
  • 最小長: 1
    最大長: 8
    パターン: ^[*A-Z_$][*A-Z0-9_$]*$
  • デフォルト値: ER
    指定できる値: [ "extract", "replicat", "ER" ]
  • デフォルト値: false
    Replicatに、起動時の位置以降の1番目のトランザクションをスキップさせます。この1番目のトランザクション内の操作は、すべて除外されます。
  • threads
    最小アイテム数: 1
    最大アイテム数: 500
    調整モードのReplicatでskipTransaction、atまたはafterと一緒に使用した場合に有効です。指定したReplicatスレッドを指定した場所で開始します。
すべてに一致
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[1]
型: object
ExtractまたはReplicatの停止
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[2]
型: object
ExtractまたはReplicatの中止
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[3]
型: object
ExtractまたはReplicatの実行
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[4]
型: object
Replicatの同期
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[5]
型: object
モニター・エージェントの実行
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[6]
型: object
プロセスのレポート
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[7]
型: object
プロセス・ラグのレポート
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[8]
型: object
オペレーティング・システムとデータベース・バージョン情報のレポート
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[9]
型: object
名前が入力指定に一致するデータベース内のスキーマをリストします
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[10]
型: object
名前が入力指定に一致するデータベース内の表をリストします
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[11]
型: object
名前が入力指定に一致するデータベース内のチェックポイント表をリストします
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[12]
型: object
名前が入力指定に一致するデータベース内のコンテナをリストします
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[13]
型: object
ERプロセスのチェックポイント履歴をパージします
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[14]
型: object
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[15]
型: object
不要になったトレイル・ファイルをパージします
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[16]
型: object
ExtractまたはReplicatのタスクをパージします
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[17]
型: object
不要になったファイルをパージします
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[18]
型: object
レプリケーション環境のインストール後、Extractがトランザクション・データの取得を開始した時点で初期REDOレコードが使用可能になるように、データベース順序を更新します。
ソースの表示
  • 指定できる値: [ "ogg:command" ]
  • credentials
    データベースの資格証明
  • 指定できる値: [ "flushSequence" ]
  • sequence
    データベース順序の所有者および名前。スキーマ名はNULLにすることはできません。順序名にはワイルドカード文字を使用できますが、所有者名には使用できません。
  • デフォルト値: false
    トレース・モードをオンにしてSQLプロシージャを呼び出して順序を更新するかどうか
ネストされたスキーマ: after
ExtractまたはReplicatに、指定したCSNを持つトランザクションの後の最初のトランザクションの先頭に開始位置を配置するように指示します。指定したCSN以下のCSN値が含まれているデータ・ソース内のトランザクションは、すべてスキップされます。
1つに一致
ソースの表示
  • 最小値: 0
    最大値: 9.223372036854776E18
    標準の形式
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    代替の形式
ネストされたスキーマ: at
ExtractまたはReplicatに、指定したCSNを持つトランザクションに開始位置を配置するように指示します。指定したCSNより小さいCSN値を持つデータ・ソース内のトランザクションはすべてスキップされます。
1つに一致
ソースの表示
  • 最小値: 0
    最大値: 9.223372036854776E18
    標準の形式
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    代替の形式
ネストされたスキーマ: threads
型: array
最小アイテム数: 1
最大アイテム数: 500
調整モードのReplicatでskipTransaction、atまたはafterと一緒に使用した場合に有効です。指定したReplicatスレッドを指定した場所で開始します。
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Task Manager Command-x-oneOf[0]-allOf[5]
いずれかに一致
ソースの表示
ネストされたスキーマ: thresholds
型: array
最小アイテム数: 1
最大アイテム数: 2
ソースの表示
ネストされたスキーマ: items
型: object
ソースの表示
ネストされたスキーマ: units
1つに一致
ソースの表示
  • 指定できる値: [ "seconds" ]
  • 指定できる値: [ "minutes" ]
  • 指定できる値: [ "hours" ]
ネストされたスキーマ: credentials
データベースの資格証明
デフォルト値: oracle.doceng.json.BetterJsonNull@e3899fd
1つに一致
ソースの表示
ネストされたスキーマ: credentials-x-oneOf[0]
型: object
ソースの表示
ネストされたスキーマ: credentials
型: object
データベースの資格証明
ソースの表示
ネストされたスキーマ: specification
スキーマ名(ワイルドカード文字を含むことができる)
いずれかに一致
ソースの表示
  • 最小長: 1
    最大長: 130
    パターン: ^([^."]{1,128}|["].{1,128}["])$
  • 最小長: 3
    最大長: 261
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
ネストされたスキーマ: credentials
型: object
データベースの資格証明
ソースの表示
ネストされたスキーマ: specification
1つの表または一連の表の名前(ワイルドカード文字を含むことができる)
いずれかに一致
ソースの表示
  • 最小長: 3
    最大長: 261
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • 最小長: 5
    最大長: 392
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
ネストされたスキーマ: credentials
型: object
データベースの資格証明
ソースの表示
ネストされたスキーマ: specification
1つのチェックポイント表または一連のチェックポイント表の名前(ワイルドカード文字を含むことができる)
いずれかに一致
ソースの表示
  • 最小長: 3
    最大長: 261
    パターン: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • 最小長: 5
    最大長: 392
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
ネストされたスキーマ: credentials
型: object
データベースの資格証明
ソースの表示
ネストされたスキーマ: keep
型: array
最小アイテム数: 1
最大アイテム数: 1
ソースの表示
ネストされたスキーマ: items
型: object
ソースの表示
ネストされたスキーマ: units
1つに一致
ソースの表示
  • 指定できる値: [ "checkpoints" ]
ネストされたスキーマ: credentials
型: object
データベースの資格証明
ソースの表示
ネストされたスキーマ: keep
型: array
最小アイテム数: 1
最大アイテム数: 2
ソースの表示
ネストされたスキーマ: items
1つに一致
ソースの表示
ネストされたスキーマ: items-x-oneOf[0]
型: object
最短時間数
ソースの表示
  • 指定できる値: [ "min" ]
  • 指定できる値: [ "hours" ]
  • 最小値: 1
    最大値: 1000
    hours値として指定できる値
ネストされたスキーマ: items-x-oneOf[1]
型: object
最長時間数
ソースの表示
  • 指定できる値: [ "max" ]
  • 指定できる値: [ "hours" ]
  • 最小値: 1
    最大値: 1000
    hours値として指定できる値
ネストされたスキーマ: items-x-oneOf[2]
型: object
最短日数
ソースの表示
  • 指定できる値: [ "min" ]
  • 指定できる値: [ "days" ]
  • 最小値: 1
    最大値: 365
    days値として指定できる値
ネストされたスキーマ: items-x-oneOf[3]
型: object
最長日数
ソースの表示
  • 指定できる値: [ "max" ]
  • 指定できる値: [ "days" ]
  • 最小値: 1
    最大値: 365
    days値として指定できる値
ネストされたスキーマ: keep
型: array
最小アイテム数: 1
最大アイテム数: 1
ソースの表示
ネストされたスキーマ: trails
型: array
最小アイテム数: 1
最大アイテム数: 1024
パージするトレイル
ソースの表示
ネストされたスキーマ: items
1つに一致
ソースの表示
ネストされたスキーマ: items-x-oneOf[0]
型: object
最短時間数
ソースの表示
  • 指定できる値: [ "min" ]
  • 指定できる値: [ "hours" ]
  • 最小値: 1
    最大値: 1000
    hours値として指定できる値
ネストされたスキーマ: items-x-oneOf[1]
型: object
最短日数
ソースの表示
  • 指定できる値: [ "min" ]
  • 指定できる値: [ "days" ]
  • 最小値: 1
    最大値: 365
    days値として指定できる値
ネストされたスキーマ: items-x-oneOf[2]
型: object
最小ファイル数
ソースの表示
ネストされたスキーマ: items
型: object
ソースの表示
  • 最小長: 1
    最大長: 2
    パターン: ^[A-Za-z*][A-Za-z0-9*]?$
    トレイルの名前、ワイルドカード使用可能
  • 最小長: 1
    最大長: 4096
    トレイル・データが格納されるパス
ネストされたスキーマ: keep
型: array
最小アイテム数: 1
最大アイテム数: 1
ソースの表示
ネストされたスキーマ: items
1つに一致
ソースの表示
ネストされたスキーマ: items-x-oneOf[0]
型: object
最短時間数
ソースの表示
  • 指定できる値: [ "min" ]
  • 指定できる値: [ "hours" ]
  • 最小値: 1
    最大値: 1000
    hours値として指定できる値
ネストされたスキーマ: items-x-oneOf[1]
型: object
最短日数
ソースの表示
  • 指定できる値: [ "min" ]
  • 指定できる値: [ "days" ]
  • 最小値: 1
    最大値: 365
    days値として指定できる値
ネストされたスキーマ: keep
型: array
最小アイテム数: 1
最大アイテム数: 1
ソースの表示
ネストされたスキーマ: items
1つに一致
ソースの表示
ネストされたスキーマ: items-x-oneOf[0]
型: object
最短時間数
ソースの表示
  • 指定できる値: [ "min" ]
  • 指定できる値: [ "hours" ]
  • 最小値: 1
    最大値: 1000
    hours値として指定できる値
ネストされたスキーマ: items-x-oneOf[1]
型: object
最短日数
ソースの表示
  • 指定できる値: [ "min" ]
  • 指定できる値: [ "days" ]
  • 最小値: 1
    最大値: 365
    days値として指定できる値
ネストされたスキーマ: credentials
型: object
データベースの資格証明
ソースの表示
ネストされたスキーマ: sequence
データベース順序の所有者および名前。スキーマ名はNULLにすることはできません。順序名にはワイルドカード文字を使用できますが、所有者名には使用できません。
いずれかに一致
ソースの表示
  • 最小長: 1
    最大長: 130
    パターン: ^([^."]{1,128}|["].{1,128}["])$
  • 最小長: 3
    最大長: 261
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • 最小長: 5
    最大長: 392
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
リクエストの例(application/json)
{
    "name":"report",
    "reportType":"lag",
    "thresholds":[
        {
            "type":"info",
            "units":"seconds",
            "value":0
        },
        {
            "type":"critical",
            "units":"seconds",
            "value":5
        }
    ]
}
先頭に戻る

レスポンス

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

200レスポンス

コマンドが正常に実行されました。

本文()
ルート・スキーマ: Oracle GoldenGate Task Manager Command Result
型: object
タイトル: Oracle GoldenGate Task Manager Command Result
ソースの表示
ネストされたスキーマ: containers
型: array
最小アイテム数: 0
最大アイテム数: 32767
ソースの表示
ネストされたスキーマ: items
型: array
最小アイテム数: 0
最大アイテム数: 1024
ソースの表示
ネストされたスキーマ: messages
型: array
最小アイテム数: 0
最大アイテム数: 1024
ソースの表示
ネストされたスキーマ: schemas
型: array
最小アイテム数: 0
最大アイテム数: 32767
ソースの表示
ネストされたスキーマ: tables
型: array
最小アイテム数: 0
最大アイテム数: 32767
ソースの表示
ネストされたスキーマ: versions
型: object
ソースの表示
ネストされたスキーマ: items
1つに一致
ソースの表示
  • 最小長: 1
    最大長: 130
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])$
ネストされたスキーマ: items
1つに一致
ソースの表示
ネストされたスキーマ: items-x-oneOf[0]
型: object
ソースの表示
ネストされたスキーマ: items-x-oneOf[1]
型: object
ソースの表示
ネストされたスキーマ: result
1つに一致
ソースの表示
ネストされたスキーマ: result-x-oneOf[1]
型: object
プロセス・ラグのレポート
ソースの表示
ネストされたスキーマ: processName
1つに一致
ソースの表示
  • 最小長: 1
    最大長: 8
    パターン: ^[A-Z_$][A-Z0-9_$]*$
  • 指定できる値: [ "Monitor Agent" ]
ネストされたスキーマ: 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]。
ネストされたスキーマ: items
いずれかに一致
ソースの表示
  • 最小長: 1
    最大長: 130
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])$
  • 最小長: 3
    最大長: 261
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
ネストされたスキーマ: 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}["])$
ネストされたスキーマ: build
型: object
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])$
    リリースがビルドされた日時
  • 最小長: 1
    最大長: 64
    Oracle GoldenGateの内部ラベル
  • 最適化されたビルド
  • 最小長: 10
    最大長: 21
    パターン: ^[1-9][0-9]([.][0-9]{1,3}){3}[.]([0-9]{1,3}|[0-9]{6})$
    Oracle GoldenGateリリース番号
  • 最小長: 1
    最大長: 64
    ターゲット・アーキテクチャ
  • 最小長: 1
    最大長: 64
    ターゲット・データベース
  • 最小長: 1
    最大長: 64
    ターゲット・データベースのバージョン
  • 最小長: 1
    最大長: 64
    ターゲット・オペレーティング・システム
ネストされたスキーマ: database
型: array
最小アイテム数: 1
最大アイテム数: 100
データベースのバージョン情報
ソースの表示
ネストされたスキーマ: operatingSystem
オペレーティング・システムのバージョン情報
1つに一致
ソースの表示
ネストされたスキーマ: operatingSystem-x-oneOf[0]
型: object
ソースの表示
ネストされたスキーマ: operatingSystem-x-oneOf[1]
型: object
ソースの表示
レスポンスの例(application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/commands/execute",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/commands/execute",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-00948",
            "issued":"2019-03-15T14:43:21Z",
            "severity":"INFO",
            "title":"Lag for EXTRACT EXT2 is 0:00:00.000 (checkpoint updated 0:00:53.380 ago)",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-00948"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-00948",
            "issued":"2019-03-15T14:43:21Z",
            "severity":"INFO",
            "title":"Lag for REPLICAT REP2 is 0:00:00.000 (checkpoint updated 0:00:04.309 ago)",
            "type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-00948"
        }
    ],
    "response":{
        "$schema":"ogg:commandResult",
        "items":[
            {
                "processName":"EXT2",
                "processType":"extract",
                "result":{
                    "lag":"0:00:00.000",
                    "lagSeconds":0,
                    "lastCheckpoint":"0:00:53.380",
                    "lastCheckpointSeconds":53.38
                },
                "severity":"info"
            },
            {
                "processName":"REP2",
                "processType":"replicat",
                "result":{
                    "lag":"0:00:00.000",
                    "lagSeconds":0,
                    "lastCheckpoint":"0:00:04.309",
                    "lastCheckpointSeconds":4.309
                },
                "severity":"info"
            }
        ]
    }
}
先頭に戻る