Oracle GoldenGate

Retrieve Heartbeat Table

get

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

Retrieve details of the heartbeat table for a database connection.

Request

Path Parameters

connection: string

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.
version: string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Heartbeat table details retrieved.

Root Schema : Oracle GoldenGate Heartbeat Table

Type: object

Title: Oracle GoldenGate Heartbeat Table

Show Source

$schema:

Allowed Values: [ "ogg:tablesHeartbeat" ]
addTrandata: boolean

Default Value: true

Boolean value to enable or disable trandata (suplemental logging) for heartbeat and seed tables.
frequency: integer

Minimum Value: 0

Maximum Value: 7999

Default Value: 60

Interval, in seconds, at which the heartbeat table is updated.
partitioned: boolean

Default Value: false

Whether the heartbeat history table is partitioned or not.
purgeFrequency: integer

Minimum Value: 1

Maximum Value: 199

Default Value: 1

Interval, in days, at which the heartbeat history table is purged.
retentionTime: integer

Minimum Value: 1

Maximum Value: 2147483646

Default Value: 30

Heartbeats older than this retention time (in days) will be deleted from the heartbeat table.
targetOnly: boolean

Default Value: false

Boolean value to enable or disable supplemental logging and the scheduler job for updating heartbeat seed and heartbeat tables.

{
    "title":"Oracle GoldenGate Heartbeat Table",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:tablesHeartbeat"
            ]
        },
        "frequency":{
            "description":"Interval, in seconds, at which the heartbeat table is updated.",
            "type":"integer",
            "default":60,
            "minimum":0,
            "maximum":7999
        },
        "retentionTime":{
            "description":"Heartbeats older than this retention time (in days) will be deleted from the heartbeat table.",
            "type":"integer",
            "default":30,
            "minimum":1,
            "maximum":2147483646
        },
        "purgeFrequency":{
            "description":"Interval, in days, at which the heartbeat history table is purged.",
            "type":"integer",
            "minimum":1,
            "default":1,
            "maximum":199
        },
        "partitioned":{
            "description":"Whether the heartbeat history table is partitioned or not.",
            "type":"boolean",
            "default":false
        },
        "addTrandata":{
            "description":"Boolean value to enable or disable trandata (suplemental logging) for heartbeat and seed tables.",
            "type":"boolean",
            "default":true
        },
        "targetOnly":{
            "description":"Boolean value to enable or disable supplemental logging and the scheduler job for updating heartbeat seed and heartbeat tables.",
            "type":"boolean",
            "default":false
        }
    },
    "additionalProperties":false
}

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"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/heartbeat",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-08100",
            "issued":"2017-12-14T12:42:08Z",
            "severity":"INFO",
            "title":"HEARTBEAT table oggadmin.gg_heartbeat exists.",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-08100"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-08100",
            "issued":"2017-12-14T12:42:08Z",
            "severity":"INFO",
            "title":"HEARTBEAT table oggadmin.gg_heartbeat_seed exists.",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-08100"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-08100",
            "issued":"2017-12-14T12:42:08Z",
            "severity":"INFO",
            "title":"HEARTBEAT table oggadmin.gg_heartbeat_history exists.",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-08100"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-08100",
            "issued":"2017-12-14T12:42:08Z",
            "severity":"INFO",
            "title":"HEARTBEAT table oggadmin.gg_heartbeat supplemental logging ENABLED.",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-08100"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-08100",
            "issued":"2017-12-14T12:42:08Z",
            "severity":"INFO",
            "title":"HEARTBEAT table oggadmin.gg_heartbeat_seed supplemental logging ENABLED.",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-08100"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-08100",
            "issued":"2017-12-14T12:42:08Z",
            "severity":"INFO",
            "title":"HEARTBEAT table oggadmin.gg_heartbeat_history partitioning DISABLED.",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-08100"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-08100",
            "issued":"2017-12-14T12:42:08Z",
            "severity":"INFO",
            "title":"Frequency interval: 60 seconds.",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-08100"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-08100",
            "issued":"2017-12-14T12:42:08Z",
            "severity":"INFO",
            "title":"Purge frequency interval: 2 days.",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-08100"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-08100",
            "issued":"2017-12-14T12:42:08Z",
            "severity":"INFO",
            "title":"Retention time: 30 days.",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-08100"
        }
    ],
    "response":{
        "$schema":"ogg:tablesHeartbeat",
        "addTrandata":true,
        "frequency":60,
        "partitioned":false,
        "purgeFrequency":2,
        "retentionTime":30,
        "targetOnly":false
    }
}