Oracle GoldenGate 19c Microservices Architecture REST API

プロセス・ハートビート・レコードの取得

get

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

ExtractまたはReplicatグループのハートビート表エントリを取得します。

リクエスト

パス・パラメータ

connection: string

最小長: 1

最大長: 61

パターン: ^[a-zA-Z][a-zA-Z0-9_#$]{1,29}([.][a-zA-Z][a-zA-Z0-9_#$]{1,29})?$

接続名。資格証明ストアの別名ごとに、domain.aliasという名前の接続が存在しています。
process: string

最小長: 1

最大長: 8

パターン: ^[A-Z_$][A-Z0-9_$]*$

ExtractまたはReplicatプロセスの名前。
version: string

Oracle GoldenGateサービスのAPIバージョン。

指定できる値: [ "v2" ]

先頭に戻る

レスポンス

サポートされるメディア・タイプ

application/json

200レスポンス

ハートビート表エントリが正常に取得されました。

ルート・スキーマ: Oracle GoldenGate Process Heartbeat Details

型: object

タイトル: Oracle GoldenGate Process Heartbeat Details

ソースの表示

$schema(optional):

指定できる値: [ "ogg:processHeartbeat" ]
heartbeats: array heartbeats

最小アイテム数: 0

最大アイテム数: 1024

ハートビートの詳細

{
    "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
}

ネストされたスキーマ: heartbeats

型: array

最小アイテム数: 0

最大アイテム数: 1024

ハートビートの詳細

ソースの表示

配列: 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
}

ネストされたスキーマ: items

型: object

ソースの表示

ageSeconds: number

ハートビート・ラグ(秒)
lagSeconds: number

プロセス・ラグ(秒)
path: string

最小長: 1

最大長: 4095

レプリケーション・パス
source: string

最小長: 1

最大長: 130

パターン: ^([^.*?"]{1,128}|["].{1,128}["])$

ソース・データベース名
target: string

最小長: 1

最大長: 130

パターン: ^([^.*?"]{1,128}|["].{1,128}["])$

ターゲット・データベース名

{
    "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
}

レスポンスの例(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"
            }
        ]
    }
}

先頭に戻る