Update Heartbeat Table
patch
/services/{version}/connections/{connection}/tables/heartbeat
Modify the heartbeat table parameters for a database connection.
Request
Supported Media Types
- application/json
Path Parameters
-
connection: string
Minimum Length:
1Maximum Length:61Pattern:^[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" ]
Root Schema : Oracle GoldenGate Heartbeat Table
Type:
objectTitle:
Show Source
Oracle GoldenGate Heartbeat Table-
$schema(optional):
Allowed Values:
[ "ogg:tablesHeartbeat" ] -
frequency(optional):
integer
Minimum Value:
0Maximum Value:7999Default Value:60Interval, in seconds, at which the heartbeat table is updated. -
partitioned(optional):
boolean
Default Value:
falseWhether the heartbeat history table is partitioned or not. -
purgeFrequency(optional):
integer
Minimum Value:
1Maximum Value:199Default Value:1Interval, in days, at which the heartbeat history table is purged. -
retentionTime(optional):
integer
Minimum Value:
1Maximum Value:2147483646Default Value:30Heartbeats older than this retention time (in days) will be deleted from the heartbeat table. -
targetOnly(optional):
boolean
Default Value:
falseBoolean value to enable or disable supplemental logging and the scheduler job for updating heartbeat seed and heartbeat tables. -
trackingExtractRestart(optional):
boolean
Default Value:
trueWhether current heartbeat table setup is tracking extract restart position or not. -
upgrade(optional):
boolean
Default Value:
falseBoolean value to detect when to upgrade the heartbeat tables.
Example Request (application/json)
{
"purgeFrequency":2
}Response
Supported Media Types
- application/json
200 Response
Heartbeat table modified successfully.
Root Schema : RESTful API Standard Response
Type:
objectTitle:
RESTful API Standard ResponseStandard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema(optional):
Allowed Values:
[ "api:standardResponse" ] -
links:
array links
Minimum Number of Items:
0Maximum Number of Items:16Oracle GoldenGate links for the request -
messages:
array messages
Minimum Number of Items:
0Maximum Number of Items:65535Oracle GoldenGate messages issued during the request -
response(optional):
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
16Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
65535Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
objectOracle GoldenGate document from the request
Nested Schema : items
Type:
Show Source
object-
$schema(optional):
Allowed Values:
[ "ogg:link" ] -
description(optional):
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this link. -
href:
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI for the link -
mediaType(optional):
string
Minimum Length:
6Maximum Length:255Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel:
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object-
$schema(optional):
Allowed Values:
[ "ogg:message" ] -
code:
string
Minimum Length:
9Maximum Length:9Pattern:^OGG[-][0-9]{5}$The Oracle GoldenGate message code -
issued:
string
Minimum Length:
20Maximum Length:32Pattern:^[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 -
severity:
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]The severity of the message -
title:
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type:
string
Minimum Length:
2Maximum Length:4095Pattern:^[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":"2019-03-15T14:40:44Z",
"severity":"INFO",
"title":"Frequency of purge scheduler job \"oggadmin\".\"GG_PURGE_HEARTBEATS\"\" modified.",
"type":"http://docs.oracle.com/goldengate/c1910/gg-winux/GMESG/oggus.htm#OGG-14030"
}
]
}