Retrieve Heartbeat Table Entries
get
/services/{version}/connections/{connection}/tables/heartbeatData
Required Role: User
Retrieve heartbeat/lag entries from a database connection.
Request
Path Parameters
-
connection(required): 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(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Query Parameters
-
limit: string
Number of historical heartbeat/lag records to retrieve
-
offset: string
Starting offset in result set
-
q: string
q Query Parameter Syntax
Response
Supported Media Types
- application/json
200 Response
Heartbeat/Lag entries retrieved.
Root Schema : Oracle GoldenGate Process Heartbeat Details
Type:
objectTitle:
Show Source
Oracle GoldenGate Process Heartbeat Details-
$schema:
Allowed Values:
[ "ogg:processHeartbeat" ] -
heartbeats(required):
heartbeats
Nested Schema : heartbeats
Match Any
Show Source
-
array heartbeats-x-anyOf[0]
Minimum Number of Items:
0Maximum Number of Items:1024Heartbeat details -
array heartbeats-x-anyOf[1]
Minimum Number of Items:
0Maximum Number of Items:4095Heartbeat details (Extended)
Nested Schema : heartbeats-x-anyOf[0]
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
1024Heartbeat details
Show Source
Nested Schema : heartbeats-x-anyOf[1]
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
4095Heartbeat details (Extended)
Show Source
Nested Schema : items
Type:
Show Source
object-
ageSeconds(required):
number
Heartbeat lag in seconds
-
lagSeconds(required):
number
Process lag in seconds
-
path(required):
string
Minimum Length:
1Maximum Length:4095Replication path -
source(required):
string
Minimum Length:
1Maximum Length:130Pattern:^([^.*?"]{1,128}|["].{1,128}["])$Source database name -
target(required):
string
Minimum Length:
1Maximum Length:130Pattern:^([^.*?"]{1,128}|["].{1,128}["])$Target database name
Nested Schema : items
Type:
Show Source
object-
ageSeconds:
number
Age of the lag in seconds
-
lagExtract:
number
lag from start to extraction of lcr into trail file
-
lagReplicat:
number
lag from replicat read point to after replicat apply
-
lagReplicatRead:
number
lag from routing point to replicat read point
-
lagRouting:
number
lag from extract to routing point, has not crossed network yet
-
lagSeconds(required):
number
Process lag in seconds
-
path(required):
string
Minimum Length:
1Maximum Length:4095Replication path -
processName(required):
string
Minimum Length:
1Maximum Length:8Pattern:^[A-Z_$][A-Z0-9_$]*$Process group name -
processType(required):
Allowed Values:
[ "extract", "replicat" ]Process group type -
recordedAt(required):
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])$Entry recorded at time -
source(required):
string
Minimum Length:
1Maximum Length:130Pattern:^([^.*?"]{1,128}|["].{1,128}["])$Source database name -
target(required):
string
Minimum Length:
1Maximum Length:130Pattern:^([^.*?"]{1,128}|["].{1,128}["])$Target database name
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/connections/OracleGoldenGate.oggadmin/tables/heartbeatData",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/connections/OracleGoldenGate.oggadmin/tables/heartbeatData",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/heartbeatData",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:processHeartbeat",
"heartbeats":[
]
}
}