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

Update Heartbeat Table

patch

/services/{version}/connections/{connection}/tables/heartbeat

Modify the heartbeat table parameters for a database connection.

Request

Supported Media Types
Path Parameters
  • Minimum Length: 1
    Maximum Length: 61
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]{1,29}([.][a-zA-Z][a-zA-Z0-9_#$]{1,29})?$

    Connection name. For each alias in the credential store, a connection with the name 'domain.alias' exists.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Body ()
Root Schema : Oracle GoldenGate Heartbeat Table
Type: object
Title: Oracle GoldenGate Heartbeat Table
Show Source
  • Allowed Values: [ "ogg:tablesHeartbeat" ]
  • Default Value: true
    Boolean value to enable or disable trandata (suplemental logging) for heartbeat and seed tables.
  • Minimum Value: 0
    Maximum Value: 7999
    Default Value: 60
    Interval, in seconds, at which the heartbeat table is updated.
  • Default Value: false
    Whether the heartbeat history table is partitioned or not.
  • Minimum Value: 1
    Maximum Value: 199
    Default Value: 1
    Interval, in days, at which the heartbeat history table is purged.
  • Minimum Value: 1
    Maximum Value: 2147483646
    Default Value: 30
    Heartbeats older than this retention time (in days) will be deleted from the heartbeat table.
  • Default Value: false
    Boolean value to enable or disable supplemental logging and the scheduler job for updating heartbeat seed and heartbeat tables.
Example Request (application/json)
{
    "purgeFrequency":2
}

Response

Supported Media Types

200 Response

Heartbeat table modified successfully.

Body ()
Root Schema : RESTful API Standard Response
Type: object
Title: RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
Show Source
Nested Schema : messages
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 65535
Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type: object
Oracle GoldenGate document from the request
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "ogg:message" ]
  • Minimum Length: 9
    Maximum Length: 9
    Pattern: ^OGG[-][0-9]{5}$
    The Oracle GoldenGate message code
  • 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])$
    The date and time that the message was issued
  • Allowed Values: [ "INFO", "WARNING", "ERROR" ]
    The severity of the message
  • Minimum Length: 1
    Maximum Length: 4095
    A human-readable description that provides information and detail specific to this occurence of the information, warning or error.
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    An absolute URI [RFC3986] to a page that describes the info, warning or error type.
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/connections/OracleGoldenGate.oggadmin/tables/heartbeat",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/connections/OracleGoldenGate.oggadmin/tables/heartbeat",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-14030",
            "issued":"2017-12-14T12:42:07Z",
            "severity":"INFO",
            "title":"Frequency of purge scheduler job \"\"oggadmin\".\"GG_PURGE_HEARTBEATS\"\" modified.",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-14030"
        }
    ]
}