1. Oracle GoldenGate 23ai Microservices Architecture REST APIドキュメンテーション
  2. タスク
  3. 管理サービス
  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:9012/services/v2/replicats/REPS/command",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/replicats/REPS/command",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"er:commandResult",
        "reply":"OKNODOT\t\nNo active replication maps.\n\nIntegrated Replicat statistics:\n\n\tTotal transactions            \t\t           0.00\n\tRedirected                    \t\t           0.00\n\tReplicated procedures         \t\t           0.00\n\tDDL operations                \t\t           0.00\n\tStored procedures             \t\t           0.00\n\tDatatype functionality        \t\t           0.00\n\tOperation type functionality  \t\t           0.00\n\tEvent actions                 \t\t           0.00\n\tDatabase compatibility        \t\t           0.00\n\tDirect transactions ratio     \t\t           0.00%\n",
        "replyData":{
            "$schema":"ogg:stats",
            "stats":[
                {
                    "integratedReplicat":true,
                    "operations":[
                        {
                            "count":"0",
                            "operation":"transactions"
                        },
                        {
                            "count":"0",
                            "operation":"redirected"
                        },
                        {
                            "count":"0",
                            "operation":"replicatedProcedures"
                        },
                        {
                            "count":"0",
                            "operation":"ddlOperations"
                        },
                        {
                            "count":"0",
                            "operation":"storedProcedures"
                        },
                        {
                            "count":"0",
                            "operation":"datatypeFunctionality"
                        },
                        {
                            "count":"0",
                            "operation":"optypeFunctionality"
                        },
                        {
                            "count":"0",
                            "operation":"eventActions"
                        },
                        {
                            "count":"0",
                            "operation":"databaseCompatibility"
                        },
                        {
                            "count":"0",
                            "operation":"directTransactionRatio"
                        }
                    ],
                    "since":"startup"
                }
            ]
        }
    }
}
先頭に戻る