1. Oracle GoldenGate 23ai Microservices Architecture REST API Documentation
  2. Tasks
  3. Administration Service
  4. Replicats

Issue Command

post

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

Required Role: User

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", "RESETTCPSTATS", "RESUME", "ROLLOVER", "STATUS", "STOP" ]
  • Default Value: false
    Indicates that the command results should be written to the report file
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", "REPORT", "RTC", "SHOWPARTITIONCACHE", "SHOWTABLECACHE", "SHOWTRANS", "SKIPTRANS", "STATS", "TRACE", "TRACE2", "TRACEINIT", "TRANLOGOPTIONS" ]
  • Default Value: false
    Indicates that the command results should be written to the report file
Nested Schema : Describes a command for an ER process to execute-x-oneOf[2]
Type: object
Show Source
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"
}
Back to Top

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
Show Source
Nested Schema : replyData-x-anyOf[4]
Type: object
Show Source
Nested Schema : replyData-x-anyOf[5]
Type: object
Show Source
Nested Schema : replyData-x-anyOf[6]
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
Type: object
High watermark position
Show Source
Nested Schema : lowWatermarkPosition
Type: object
Low watermark position
Show Source
Nested Schema : redoxportlag
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 500
Show Source
Nested Schema : csn
Match One
Show Source
  • Minimum Value: 0
    Maximum Value: 9223372036854776000
    System Change Number(Normal Format) for Oracle Database.
    Example: 6488359
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    System Change Number(Alternate Format) for Oracle Database.
    Example: 6488359.3456712
Nested Schema : csn
Match One
Show Source
  • Minimum Value: 0
    Maximum Value: 9223372036854776000
    System Change Number(Normal Format) for Oracle Database.
    Example: 6488359
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    System Change Number(Alternate Format) for Oracle Database.
    Example: 6488359.3456712
Nested Schema : items
Type: object
Show Source
  • Minimum Value: 0
    Maximum Value: 9223372036854776000
    Lag value in seconds
  • Minimum Value: 0
    Maximum Value: 500
    ID of the thread
Nested Schema : status
Match One
Show Source
Nested Schema : containers
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 4000
List of containers registered with the specified extract group.
Show Source
Nested Schema : items
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : tables
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1000000
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : name
fully qualified name of the table
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : partitionTables
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1000000
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : partitionDetails
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1024000
partition details
Show Source
Nested Schema : tableDetails
Type: object
table details
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : name
fully qualified name of the table
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Example Response (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"
                }
            ]
        }
    }
}
Back to Top