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

Issue Command

post

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

Required Role: User

Execute an Extract process command

Request

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

    The name of the extract. Extract 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/extracts/EXTN/command",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/extracts/EXTN/command",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"er:commandResult",
        "reply":"OKNODOT\t\nStart of statistics at 2024-04-03 22:35:21.\n\nOutput to north/ea:\n\nExtracting from DBNORTH_PDB1.GGADMIN.GG_HEARTBEAT_SEED to DBNORTH_PDB1.GGADMIN.GG_HEARTBEAT_SEED:\n\n*** Hourly statistics since 2024-04-03 22:34:36 ***\n    Total inserts                              0.00\n    Total updates                              3.00\n    Total deletes                              0.00\n    Total upserts                              0.00\n    Total discards                             0.00\n    Total operations                           3.00\n    Total metadata records                     1.00\n\nEnd of statistics.",
        "replyData":{
            "$schema":"ogg:stats",
            "stats":[
                {
                    "operations":[
                        {
                            "count":"0",
                            "operation":"insert"
                        },
                        {
                            "count":"3",
                            "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":"3",
                            "operation":"operations"
                        },
                        {
                            "count":"0",
                            "operation":"insertCollision"
                        },
                        {
                            "count":"0",
                            "operation":"updateCollision"
                        },
                        {
                            "count":"0",
                            "operation":"deleteCollision"
                        },
                        {
                            "count":"0",
                            "operation":"fetchAttempt"
                        },
                        {
                            "count":"1",
                            "operation":"metadataRecords"
                        }
                    ],
                    "since":"2024-04-03T22:34:36.288Z",
                    "sourceTable":"DBNORTH_PDB1.GGADMIN.GG_HEARTBEAT_SEED",
                    "targetTable":"DBNORTH_PDB1.GGADMIN.GG_HEARTBEAT_SEED"
                }
            ]
        }
    }
}
Back to Top