Jump to

• Request
• Response

Retrieve Process Heartbeat Records

get

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

Retrieve heartbeat table entries for an extract or replicat group.

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.

• process: string
  Minimum Length: 1

  Maximum Length: 8

  Pattern: ^[A-Z_$][A-Z0-9_$]*$

  The name of the extract or replicat process.

• version: string

  Oracle GoldenGate Service API version.

  Allowed Values: [ "v2" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Heartbeat table entries retrieved successfully.

Body ()

Root Schema : Oracle GoldenGate Process Heartbeat Details

Type: object

Title: Oracle GoldenGate Process Heartbeat Details

Show Source

• $schema(optional):
  Allowed Values: [ "ogg:processHeartbeat" ]
• heartbeats: array heartbeats
  Minimum Number of Items: 0

  Maximum Number of Items: 1024

  Heartbeat details

{
    "title":"Oracle GoldenGate Process Heartbeat Details",
    "required":[
        "heartbeats"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:processHeartbeat"
            ]
        },
        "heartbeats":{
            "description":"Heartbeat details",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "source":{
                        "description":"Source database name",
                        "type":"string",
                        "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                        "minLength":1,
                        "maxLength":130
                    },
                    "target":{
                        "description":"Target database name",
                        "type":"string",
                        "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                        "minLength":1,
                        "maxLength":130
                    },
                    "lagSeconds":{
                        "description":"Process lag in seconds",
                        "type":"number"
                    },
                    "ageSeconds":{
                        "description":"Heartbeat lag in seconds",
                        "type":"number"
                    },
                    "path":{
                        "description":"Replication path",
                        "type":"string",
                        "minLength":1,
                        "maxLength":4095
                    }
                },
                "required":[
                    "source",
                    "target",
                    "lagSeconds",
                    "ageSeconds",
                    "path"
                ],
                "additionalProperties":false
            },
            "minItems":0,
            "maxItems":1024
        }
    },
    "additionalProperties":false
}

Nested Schema : heartbeats

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 1024

Heartbeat details

Show Source

• Array of: object items

{
    "description":"Heartbeat details",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "source":{
                "description":"Source database name",
                "type":"string",
                "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                "minLength":1,
                "maxLength":130
            },
            "target":{
                "description":"Target database name",
                "type":"string",
                "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                "minLength":1,
                "maxLength":130
            },
            "lagSeconds":{
                "description":"Process lag in seconds",
                "type":"number"
            },
            "ageSeconds":{
                "description":"Heartbeat lag in seconds",
                "type":"number"
            },
            "path":{
                "description":"Replication path",
                "type":"string",
                "minLength":1,
                "maxLength":4095
            }
        },
        "required":[
            "source",
            "target",
            "lagSeconds",
            "ageSeconds",
            "path"
        ],
        "additionalProperties":false
    },
    "minItems":0,
    "maxItems":1024
}

Nested Schema : items

Type: object

Show Source

• ageSeconds: number
  Heartbeat lag in seconds
• lagSeconds: number
  Process lag in seconds
• path: string
  Minimum Length: 1

  Maximum Length: 4095

  Replication path
• source: string
  Minimum Length: 1

  Maximum Length: 130

  Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$

  Source database name
• target: string
  Minimum Length: 1

  Maximum Length: 130

  Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$

  Target database name

{
    "type":"object",
    "properties":{
        "source":{
            "description":"Source database name",
            "type":"string",
            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
            "minLength":1,
            "maxLength":130
        },
        "target":{
            "description":"Target database name",
            "type":"string",
            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
            "minLength":1,
            "maxLength":130
        },
        "lagSeconds":{
            "description":"Process lag in seconds",
            "type":"number"
        },
        "ageSeconds":{
            "description":"Heartbeat lag in seconds",
            "type":"number"
        },
        "path":{
            "description":"Replication path",
            "type":"string",
            "minLength":1,
            "maxLength":4095
        }
    },
    "required":[
        "source",
        "target",
        "lagSeconds",
        "ageSeconds",
        "path"
    ],
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/connections/OracleGoldenGate.oggadmin/tables/heartbeat/EXT2",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/connections/OracleGoldenGate.oggadmin/tables/heartbeat/EXT2",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/process",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:processHeartbeat",
        "heartbeats":[
            {
                "ageSeconds":97.78,
                "lagSeconds":53,
                "path":"EXT2 ==> REP2",
                "source":"ORCL",
                "target":"ORCL"
            }
        ]
    }
}

Back to Top