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

Retrieve Log

get

/services/{version}/extracts/{extract}/info/logs/{log}

Required Role: Administrator

Retrieve a log from the extract process.

Request

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.

  • Minimum Length: 5
    Maximum Length: 14
    Pattern: ^[A-Z_$][A-Z0-9_$]{0,7}[-]{0,1}[1-9]{0,1}?[.](log)$

    The name of the log, which is the extract name, followed by an optional revision number(as -number) and '.log'

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Back to Top

Response

Supported Media Types

200 Response

Log retrieved successfully.

Body ()
Root Schema : Oracle GoldenGate Process Report
Type: object
Title: Oracle GoldenGate Process Report
Process Report
Show Source
Nested Schema : lines
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 100000
Show Source
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2/info/logs/EXT2.log",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2/info/logs/EXT2.log",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/extractLog",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:log",
        "lines":[
            "",
            "INFO  2021-07-28 09:01:17.000191 [main] - Kafka Capture loading the properties from the file [dirprm/.KC.properties]",
            "INFO  2021-07-28 09:01:17.000207 [main] - Kafka Capture configuration properties.",
            "Configuration property key [wildcardTableEntriesString] value [qasource=benchmktst;].",
            "Configuration property key [kafkaConsumerConfig] value [kafka_producer.properties].",
            "Configuration property key [processLoopMillis] value [5000].",
            "Configuration property key [nodes] value [localhost].",
            "Configuration property key [port] value [9092].",
            "Configuration property key [vamPositionType] value [GG_ATTR_DS_TIME].",
            "Configuration property key [startTimestamp] value [2021-07-28 09:00:38.114992].",
            "",
            "WARN  2021-07-28 09:01:17.000207 [main] - Kafka Capture, unknown configuration property [nodes].",
            "WARN  2021-07-28 09:01:17.000208 [main] - Kafka Capture, unknown configuration property [port].",
            "INFO  2021-07-28 09:01:17.000289 [main] - Setting Kafka Capture start time to [2021-07-28 09:00:38.114992] Java epoch [1627488038114].",
            "INFO  2021-07-28 09:01:17.000290 [main] - Kafka Capture loading the Kafka Configuration from the file [dirprm/kafka_producer.properties]",
            "INFO  2021-07-28 09:01:17.000341 [main] - Stopping the Kafka Capture processing thread.",
            "INFO  2021-07-28 09:03:04.000012 [main] - Kafka Capture loading the properties from the file [dirprm/.KC.properties]",
            "INFO  2021-07-28 09:03:04.000034 [main] - Kafka Capture configuration properties."
        ]
    }
}
Back to Top