1. Oracle GoldenGate
  2. Tasks
  3. Administrative Server
  4. Replicats

Issue Command

post

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

Execute a Replicat process command

Request

Supported Media Types
Path Parameters
  • Minimum Length: 1
    Maximum Length: 8
    Pattern: ^[A-Z_$][A-Z0-9_$]*$

    The name of the replicat. Replicat names are upper case, begin with an alphabetic character followed by up to seven alpha-numeric characters.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Body ()
Root Schema : Describes a command for an ER process to execute
Title: Describes a command for an ER process to execute
Match One
Show Source
Nested Schema : Describes a command for an ER process to execute-x-oneOf[0]
Type: object
Show Source
  • Allowed Values: [ "er:command" ]
  • Allowed Values: [ "FORCESTOP", "GETLAG", "GETTCPSTATS", "LOGEND", "LOGSTATS", "REPORT", "RESETTCPSTATS", "RESUME", "ROLLOVER", "STATUS", "STOP" ]
Nested Schema : Describes a command for an ER process to execute-x-oneOf[1]
Type: object
Show Source
  • Allowed Values: [ "er:command" ]
  • Minimum Length: 1
    Maximum Length: 4095
  • Allowed Values: [ "BR", "CACHEMGR", "DEPINFO", "DEPENDENCYINFO", "FORCETRANS", "GETPARAMINFO", "HANDLECOLLISIONS", "NOHANDLECOLLISIONS", "PROBE", "RTC", "SHOWTRANS", "SKIPTRANS", "STATS", "TRACE", "TRACE2", "TRACEINIT", "TRANLOGOPTIONS" ]
Nested Schema : Describes a command for an ER process to execute-x-oneOf[2]
Type: object
Show Source
  • Allowed Values: [ "er:command" ]
  • Minimum Length: 1
    Maximum Length: 4095
    Pattern: ^(INTEGRATEDPARAMS)[ ]*[(].*[)]$
Nested Schema : Describes a command for an ER process to execute-x-oneOf[3]
Type: object
Show Source
Nested Schema : credentials
Type: object
Show Source
  • Allowed Values: [ "ogg:credentialsRef" ]
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
  • Minimum Length: 1
    Maximum Length: 30
    Default Value: OracleGoldenGate
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Example Request (application/json)
{
    "command":"STATS",
    "arguments":"HOURLY"
}

Response

Supported Media Types

200 Response

Command executed successfully.

Body ()
Root Schema : Describes the results from an ER process executing a command
Type: object
Title: Describes the results from an ER process executing a command
Show Source
Nested Schema : reply
Match One
Show Source
Nested Schema : replyData
Match Any
Show Source
Nested Schema : reply-x-oneOf[1]
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
Show Source
Nested Schema : replyData-x-anyOf[0]
Type: object
Show Source
Nested Schema : replyData-x-anyOf[1]
Type: object
Show Source
Nested Schema : replyData-x-anyOf[2]
Type: object
Show Source
Nested Schema : replyData-x-anyOf[3]
Type: object
Nested Schema : lagResult
Match One
Show Source
Nested Schema : lagResult-x-oneOf[0]
Type: object
Show Source
Nested Schema : extdetail
Type: object
Show Source
Nested Schema : highWatermarkPosition
High watermark position
Match One
Show Source
Nested Schema : lowWatermarkPosition
Low watermark position
Match One
Show Source
Nested Schema : redoxportlag
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 500
Show Source
Nested Schema : highWatermarkPosition-x-oneOf[0]
Type: object
Position in archive logs (classic mode, non-threaded)
Show Source
  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 0
  • Minimum Value: 1
    Maximum Value: 4.294967295E9
    Default Value: 1
Match Any
Show Source
Nested Schema : highWatermarkPosition-x-oneOf[1]
Type: object
Position in archive logs (classic mode, threaded)
Show Source
Nested Schema : highWatermarkPosition-x-oneOf[2]
Type: object
Position at a specific SCN (integrated mode)
Show Source
Nested Schema : positions
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 100
Show Source
Nested Schema : items
Type: object
Position in archive logs for one thread in a classic extract
Show Source
Nested Schema : position
Match One
Show Source
  • Allowed Values: [ "now" ]
  • position-x-oneOf[1]
  • Minimum Length: 20
    Maximum Length: 32
    Pattern: ^[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 in archive logs (classic mode, non-threaded)
Nested Schema : position-x-oneOf[1]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : position-x-oneOf[3]
Type: object
Position in archive logs (classic mode, non-threaded)
Show Source
  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 0
  • Minimum Value: 1
    Maximum Value: 4.294967295E9
    Default Value: 1
Match Any
Show Source
Nested Schema : csn
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : lowWatermarkPosition-x-oneOf[0]
Type: object
Position in archive logs (classic mode, non-threaded)
Show Source
  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 0
  • Minimum Value: 1
    Maximum Value: 4.294967295E9
    Default Value: 1
Match Any
Show Source
Nested Schema : lowWatermarkPosition-x-oneOf[1]
Type: object
Position in archive logs (classic mode, threaded)
Show Source
Nested Schema : lowWatermarkPosition-x-oneOf[2]
Type: object
Position at a specific SCN (integrated mode)
Show Source
Nested Schema : positions
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 100
Show Source
Nested Schema : items
Type: object
Position in archive logs for one thread in a classic extract
Show Source
Nested Schema : position
Match One
Show Source
  • Allowed Values: [ "now" ]
  • position-x-oneOf[1]
  • Minimum Length: 20
    Maximum Length: 32
    Pattern: ^[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 in archive logs (classic mode, non-threaded)
Nested Schema : position-x-oneOf[1]
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : position-x-oneOf[3]
Type: object
Position in archive logs (classic mode, non-threaded)
Show Source
  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 0
  • Minimum Value: 1
    Maximum Value: 4.294967295E9
    Default Value: 1
Match Any
Show Source
Nested Schema : csn
Match One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : items
Type: object
Show Source
  • Minimum Value: 0
    Maximum Value: 9.223372036854776E18
    Lag value in seconds
  • Minimum Value: 0
    Maximum Value: 500
    ID of the thread
Nested Schema : status
Match One
Show Source
Example Response (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 2017-12-14 12:44:44.\n\nReplicating from OGGADMIN.GG_HEARTBEAT_SEED to OGGADMIN.GG_HEARTBEAT:\n\n*** Hourly statistics since 2017-12-14 12:44:01 ***\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\nReplicating from OGGADMIN.GG_HEARTBEAT_SEED to OGGADMIN.GG_HEARTBEAT_HISTORY:\n\n*** Hourly statistics since 2017-12-14 12:44:01 ***\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:44:01.394Z",
                    "sourceTable":"OGGADMIN.GG_HEARTBEAT_SEED",
                    "targetTable":"OGGADMIN.GG_HEARTBEAT"
                },
                {
                    "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:44:01.394Z",
                    "sourceTable":"OGGADMIN.GG_HEARTBEAT_SEED",
                    "targetTable":"OGGADMIN.GG_HEARTBEAT_HISTORY"
                }
            ]
        }
    }
}