コマンドの発行

post

/services/{version}/extracts/{extract}/command

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

リクエスト

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

    Extractの名前。Extract名は大文字で、先頭が英字、その後に英数字が最大で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", "REPORT", "RESETTCPSTATS", "RESUME", "ROLLOVER", "STATUS", "STOP" ]
ネストされたスキーマ: 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", "RTC", "SHOWTRANS", "SKIPTRANS", "STATS", "TRACE", "TRACE2", "TRACEINIT", "TRANLOGOPTIONS" ]
ネストされたスキーマ: Describes a command for an ER process to execute-x-oneOf[2]
型: object
ソースの表示
  • 指定できる値: [ "er:command" ]
  • 最小長: 1
    最大長: 4095
    パターン: ^(INTEGRATEDPARAMS)[ ]*[(].*[)]$
ネストされたスキーマ: 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
ネストされたスキーマ: lagResult
1つに一致
ソースの表示
ネストされたスキーマ: lagResult-x-oneOf[0]
型: object
ソースの表示
ネストされたスキーマ: extdetail
型: object
ソースの表示
ネストされたスキーマ: highWatermarkPosition
高水位標位置
1つに一致
ソースの表示
ネストされたスキーマ: lowWatermarkPosition
低水位標位置
1つに一致
ソースの表示
ネストされたスキーマ: redoxportlag
型: array
最小アイテム数: 1
最大アイテム数: 500
ソースの表示
ネストされたスキーマ: highWatermarkPosition-x-oneOf[0]
型: object
アーカイブ・ログでの位置(クラシック・モード、非スレッド)
ソースの表示
  • 最小値: 0
    最大値: 2147483647
    デフォルト値: 0
  • 最小値: 1
    最大値: 4.294967295E9
    デフォルト値: 1
いずれかに一致
ソースの表示
ネストされたスキーマ: highWatermarkPosition-x-oneOf[1]
型: object
アーカイブ・ログでの位置(クラシック・モード、スレッド)
ソースの表示
ネストされたスキーマ: highWatermarkPosition-x-oneOf[2]
型: object
特定のSCNの位置(統合モード)
ソースの表示
ネストされたスキーマ: positions
型: array
最小アイテム数: 1
最大アイテム数: 100
ソースの表示
  • items
    アーカイブ・ログでの位置(クラシックExtractの1スレッド)
ネストされたスキーマ: items
型: object
アーカイブ・ログでの位置(クラシックExtractの1スレッド)
ソースの表示
ネストされたスキーマ: position
1つに一致
ソースの表示
  • 指定できる値: [ "now" ]
  • position-x-oneOf[1]
  • 最小長: 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])$
  • position-x-oneOf[3]
    アーカイブ・ログでの位置(クラシック・モード、非スレッド)
ネストされたスキーマ: position-x-oneOf[1]
1つに一致
ソースの表示
  • 最小値: 1
    最大値: 9.223372036854776E18
    標準の形式
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    代替の形式
ネストされたスキーマ: position-x-oneOf[3]
型: object
アーカイブ・ログでの位置(クラシック・モード、非スレッド)
ソースの表示
  • 最小値: 0
    最大値: 2147483647
    デフォルト値: 0
  • 最小値: 1
    最大値: 4.294967295E9
    デフォルト値: 1
いずれかに一致
ソースの表示
ネストされたスキーマ: csn
1つに一致
ソースの表示
  • 最小値: 1
    最大値: 9.223372036854776E18
    標準の形式
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    代替の形式
ネストされたスキーマ: lowWatermarkPosition-x-oneOf[0]
型: object
アーカイブ・ログでの位置(クラシック・モード、非スレッド)
ソースの表示
  • 最小値: 0
    最大値: 2147483647
    デフォルト値: 0
  • 最小値: 1
    最大値: 4.294967295E9
    デフォルト値: 1
いずれかに一致
ソースの表示
ネストされたスキーマ: lowWatermarkPosition-x-oneOf[1]
型: object
アーカイブ・ログでの位置(クラシック・モード、スレッド)
ソースの表示
ネストされたスキーマ: lowWatermarkPosition-x-oneOf[2]
型: object
特定のSCNの位置(統合モード)
ソースの表示
ネストされたスキーマ: positions
型: array
最小アイテム数: 1
最大アイテム数: 100
ソースの表示
  • items
    アーカイブ・ログでの位置(クラシックExtractの1スレッド)
ネストされたスキーマ: items
型: object
アーカイブ・ログでの位置(クラシックExtractの1スレッド)
ソースの表示
ネストされたスキーマ: position
1つに一致
ソースの表示
  • 指定できる値: [ "now" ]
  • position-x-oneOf[1]
  • 最小長: 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])$
  • position-x-oneOf[3]
    アーカイブ・ログでの位置(クラシック・モード、非スレッド)
ネストされたスキーマ: position-x-oneOf[1]
1つに一致
ソースの表示
  • 最小値: 1
    最大値: 9.223372036854776E18
    標準の形式
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    代替の形式
ネストされたスキーマ: position-x-oneOf[3]
型: object
アーカイブ・ログでの位置(クラシック・モード、非スレッド)
ソースの表示
  • 最小値: 0
    最大値: 2147483647
    デフォルト値: 0
  • 最小値: 1
    最大値: 4.294967295E9
    デフォルト値: 1
いずれかに一致
ソースの表示
ネストされたスキーマ: csn
1つに一致
ソースの表示
  • 最小値: 1
    最大値: 9.223372036854776E18
    標準の形式
  • 最小長: 3
    最大長: 64
    パターン: [0-9]+[.][0-9]+
    代替の形式
ネストされたスキーマ: items
型: object
ソースの表示
ネストされたスキーマ: status
1つに一致
ソースの表示
レスポンスの例(application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2/command",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2/command",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"er:commandResult",
        "reply":"OKNODOT\t\nStart of Statistics at 2017-12-14 12:43:48.\n\nOutput to X2:\n\nExtracting from OGGADMIN.GG_HEARTBEAT_SEED to OGGADMIN.GG_HEARTBEAT_SEED:\n\n*** Hourly statistics since 2017-12-14 12:43:10 ***\n\tTotal inserts                   \t           0.00\n\tTotal updates                   \t           1.00\n\tTotal deletes                   \t           0.00\n\tTotal discards                  \t           0.00\n\tTotal operations                \t           1.00\n\nEnd of Statistics.",
        "replyData":{
            "$schema":"ogg:stats",
            "stats":[
                {
                    "operations":[
                        {
                            "count":0,
                            "operation":"insert"
                        },
                        {
                            "count":1,
                            "operation":"update"
                        },
                        {
                            "count":0,
                            "operation":"delete"
                        },
                        {
                            "count":0,
                            "operation":"discard"
                        },
                        {
                            "count":1,
                            "operation":"operations"
                        }
                    ],
                    "since":"2017-12-14T12:43:10.000Z",
                    "sourceTable":"OGGADMIN.GG_HEARTBEAT_SEED",
                    "targetTable":"OGGADMIN.GG_HEARTBEAT_SEED"
                }
            ]
        }
    }
}