1. Oracle GoldenGate Microservices REST API
  2. タスク
  3. Administrative Server
  4. Replicat

コマンドの発行

post

/services/{version}/replicats/{replicat}/command

必要なロール: ユーザー

Replicatプロセス・コマンドを実行します

リクエスト

サポートされるメディア・タイプ
パス・パラメータ
  • 最小長: 1
    最大長: 8
    パターン: ^[A-Z_$][A-Z0-9_$]*$

    Replicatの名前。Replicat名は大文字で、先頭が英字、その後に英数字が最大で7文字続きます。

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

    指定できる値: [ "v2" ]
本文()
ルート・スキーマ: Describes a command for an ER process to execute
タイトル: Describes a command for an ER process to execute
1つに一致
ソースの表示
ネストされたスキーマ: Describes a command for an ER process to execute-x-oneOf[0]
型: object
ソースの表示
  • 指定できる値: [ "er:command" ]
  • 指定できる値: [ "FORCESTOP", "GETLAG", "GETTCPSTATS", "LOGEND", "LOGSTATS", "RESETTCPSTATS", "RESUME", "ROLLOVER", "STATUS", "STOP" ]
  • デフォルト値: false
    コマンド結果をレポート・ファイルに書き込む必要があることを示します
ネストされたスキーマ: Describes a command for an ER process to execute-x-oneOf[1]
型: object
ソースの表示
  • 指定できる値: [ "er:command" ]
  • 最小長: 1
    最大長: 4095
  • 指定できる値: [ "BR", "CACHEMGR", "DEPINFO", "DEPENDENCYINFO", "FORCETRANS", "GETPARAMINFO", "HANDLECOLLISIONS", "NOHANDLECOLLISIONS", "PROBE", "REPORT", "RTC", "SHOWPARTITIONCACHE", "SHOWTABLECACHE", "SHOWTRANS", "SKIPTRANS", "STATS", "TRACE", "TRACE2", "TRACEINIT", "TRANLOGOPTIONS" ]
  • デフォルト値: false
    コマンド結果をレポート・ファイルに書き込む必要があることを示します
ネストされたスキーマ: Describes a command for an ER process to execute-x-oneOf[2]
型: object
ソースの表示
  • 指定できる値: [ "er:command" ]
  • 最小長: 1
    最大長: 4095
    パターン: ^(INTEGRATEDPARAMS)[ ]*[(].*[)]$
  • デフォルト値: false
    コマンド結果をレポート・ファイルに書き込む必要があることを示します
ネストされたスキーマ: Describes a command for an ER process to execute-x-oneOf[3]
型: object
ソースの表示
ネストされたスキーマ: credentials
型: object
ソースの表示
  • 指定できる値: [ "ogg:credentialsRef" ]
  • 最小長: 1
    最大長: 30
    パターン: ^[a-zA-Z][a-zA-Z0-9_#$]*$
  • 最小長: 1
    最大長: 30
    デフォルト値: OracleGoldenGate
    パターン: ^[a-zA-Z][a-zA-Z0-9_#$]*$
リクエストの例(application/json)
{
    "command":"STATS",
    "arguments":"HOURLY"
}
先頭に戻る

レスポンス

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

200レスポンス

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

本文()
ルート・スキーマ: Describes the results from an ER process executing a command
型: object
タイトル: Describes the results from an ER process executing a command
ソースの表示
ネストされたスキーマ: reply
1つに一致
ソースの表示
ネストされたスキーマ: replyData
いずれかに一致
ソースの表示
ネストされたスキーマ: reply-x-oneOf[1]
型: array
最小アイテム数: 0
最大アイテム数: 32767
ソースの表示
ネストされたスキーマ: replyData-x-anyOf[0]
型: object
ソースの表示
ネストされたスキーマ: replyData-x-anyOf[1]
型: object
ソースの表示
ネストされたスキーマ: replyData-x-anyOf[2]
型: object
ソースの表示
ネストされたスキーマ: replyData-x-anyOf[3]
型: object
ソースの表示
ネストされたスキーマ: replyData-x-anyOf[4]
型: object
ソースの表示
ネストされたスキーマ: replyData-x-anyOf[5]
型: object
ソースの表示
ネストされたスキーマ: replyData-x-anyOf[6]
型: object
ネストされたスキーマ: lagResult
1つに一致
ソースの表示
ネストされたスキーマ: lagResult-x-oneOf[0]
型: object
ソースの表示
ネストされたスキーマ: extdetail
型: object
ソースの表示
ネストされたスキーマ: highWatermarkPosition
型: object
高水位標位置
ソースの表示
ネストされたスキーマ: lowWatermarkPosition
型: object
低水位標位置
ソースの表示
ネストされたスキーマ: redoxportlag
型: array
最小アイテム数: 1
最大アイテム数: 500
ソースの表示
ネストされたスキーマ: csn
1つに一致
ソースの表示
  • 最小値: 0
    最大値: 9223372036854776000
    Oracle Databaseの場合のシステム変更番号(標準形式)。
    例: 6488359
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    Oracle Databaseの場合のシステム変更番号(代替形式)。
    例: 6488359.3456712
ネストされたスキーマ: csn
1つに一致
ソースの表示
  • 最小値: 0
    最大値: 9223372036854776000
    Oracle Databaseの場合のシステム変更番号(標準形式)。
    例: 6488359
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    Oracle Databaseの場合のシステム変更番号(代替形式)。
    例: 6488359.3456712
ネストされたスキーマ: items
型: object
ソースの表示
ネストされたスキーマ: status
1つに一致
ソースの表示
ネストされたスキーマ: containers
型: array
最小アイテム数: 1
最大アイテム数: 4000
指定された抽出グループに登録されているコンテナのリスト。
ソースの表示
ネストされたスキーマ: items
1つに一致
ソースの表示
  • 最小長: 1
    最大長: 130
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])$
ネストされたスキーマ: tables
型: array
最小アイテム数: 0
最大アイテム数: 1000000
ソースの表示
ネストされたスキーマ: items
型: object
ソースの表示
ネストされたスキーマ: name
表の完全修飾名
いずれかに一致
ソースの表示
  • 最小長: 3
    最大長: 261
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
  • 最小長: 5
    最大長: 392
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
ネストされたスキーマ: partitionTables
型: array
最小アイテム数: 0
最大アイテム数: 1000000
ソースの表示
ネストされたスキーマ: items
型: object
ソースの表示
ネストされたスキーマ: partitionDetails
型: array
最小アイテム数: 1
最大アイテム数: 1024000
パーティション詳細
ソースの表示
ネストされたスキーマ: tableDetails
型: object
表の詳細
ソースの表示
ネストされたスキーマ: items
型: object
ソースの表示
  • 最小値: 0
    最大値: 18446744073709552000
    表のパーティションID
  • 最小長: 1
    最大長: 130
    パターン: ^([^.*?"]{1,128}|["].{1,128}["])$
    パーティション名
ネストされたスキーマ: name
表の完全修飾名
いずれかに一致
ソースの表示
  • 最小長: 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)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/replicats/REP2/command",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/replicats/REP2/command",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"er:commandResult",
        "reply":"OKNODOT\t\nStart of statistics at 2021-07-13 16:39:38.\n\nReplicating from OGGADMIN.GG_HEARTBEAT_SEED to OGGADMIN.GG_HEARTBEAT:\n\n*** Hourly statistics since 2021-07-13 16:38:53 ***\n    Total inserts                              0.00\n    Total updates                              1.00\n    Total deletes                              0.00\n    Total upserts                              0.00\n    Total discards                             0.00\n    Total operations                           1.00\n\nReplicating from OGGADMIN.GG_HEARTBEAT_SEED to OGGADMIN.GG_HEARTBEAT_HISTORY:\n\n*** Hourly statistics since 2021-07-13 16:38:53 ***\n    Total inserts                              0.00\n    Total updates                              1.00\n    Total deletes                              0.00\n    Total upserts                              0.00\n    Total discards                             0.00\n    Total operations                           1.00\n\nEnd of statistics.",
        "replyData":{
            "$schema":"ogg:stats",
            "stats":[
                {
                    "operations":[
                        {
                            "count":"0",
                            "operation":"insert"
                        },
                        {
                            "count":"1",
                            "operation":"update"
                        },
                        {
                            "count":"0",
                            "operation":"before"
                        },
                        {
                            "count":"0",
                            "operation":"alterBefore"
                        },
                        {
                            "count":"0",
                            "operation":"delete"
                        },
                        {
                            "count":"0",
                            "operation":"upsert"
                        },
                        {
                            "count":"0",
                            "operation":"unsupported"
                        },
                        {
                            "count":"0",
                            "operation":"drop"
                        },
                        {
                            "count":"0",
                            "operation":"truncate"
                        },
                        {
                            "count":"0",
                            "operation":"discard"
                        },
                        {
                            "count":"0",
                            "operation":"ignore"
                        },
                        {
                            "count":"1",
                            "operation":"operations"
                        },
                        {
                            "count":"0",
                            "operation":"insertCollision"
                        },
                        {
                            "count":"0",
                            "operation":"updateCollision"
                        },
                        {
                            "count":"0",
                            "operation":"deleteCollision"
                        }
                    ],
                    "since":"2021-07-13T16:38:53.905Z",
                    "sourceTable":"OGGADMIN.GG_HEARTBEAT_SEED",
                    "targetTable":"OGGADMIN.GG_HEARTBEAT"
                },
                {
                    "operations":[
                        {
                            "count":"0",
                            "operation":"insert"
                        },
                        {
                            "count":"1",
                            "operation":"update"
                        },
                        {
                            "count":"0",
                            "operation":"before"
                        },
                        {
                            "count":"0",
                            "operation":"alterBefore"
                        },
                        {
                            "count":"0",
                            "operation":"delete"
                        },
                        {
                            "count":"0",
                            "operation":"upsert"
                        },
                        {
                            "count":"0",
                            "operation":"unsupported"
                        },
                        {
                            "count":"0",
                            "operation":"drop"
                        },
                        {
                            "count":"0",
                            "operation":"truncate"
                        },
                        {
                            "count":"0",
                            "operation":"discard"
                        },
                        {
                            "count":"0",
                            "operation":"ignore"
                        },
                        {
                            "count":"1",
                            "operation":"operations"
                        },
                        {
                            "count":"0",
                            "operation":"insertCollision"
                        },
                        {
                            "count":"0",
                            "operation":"updateCollision"
                        },
                        {
                            "count":"0",
                            "operation":"deleteCollision"
                        }
                    ],
                    "since":"2021-07-13T16:38:53.905Z",
                    "sourceTable":"OGGADMIN.GG_HEARTBEAT_SEED",
                    "targetTable":"OGGADMIN.GG_HEARTBEAT_HISTORY"
                }
            ]
        }
    }
}
先頭に戻る