Oracle GoldenGate REST API 21c (21.1.0)

ハートビート表エントリの取得

get

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

データベース接続からハートビート/ラグ・エントリを取得します。

リクエスト

パス・パラメータ

connection: string

最小長: 1

最大長: 61

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

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

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

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

問合せパラメータ

limit(optional): string

取得する履歴ハートビート/ラグ・レコードの数
offset(optional): string

結果セットの開始オフセット
q(optional): string

q問合せパラメータの構文

先頭に戻る

レスポンス

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

application/json

200レスポンス

ハートビート/ラグ・エントリが取得されました。

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

型: object

タイトル: Oracle GoldenGate Process Heartbeat Details

ソースの表示

$schema(optional):

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

{
    "title":"Oracle GoldenGate Process Heartbeat Details",
    "required":[
        "heartbeats"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:processHeartbeat"
            ]
        },
        "heartbeats":{
            "x-anyOf":[
                {
                    "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
                },
                {
                    "description":"Heartbeat details (Extended)",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "processName":{
                                "description":"Process group name",
                                "type":"string",
                                "pattern":"^[A-Z_$][A-Z0-9_$]*$",
                                "minLength":1,
                                "maxLength":8
                            },
                            "lagReplicat":{
                                "description":"lag from replicat read point to after replicat apply",
                                "type":"number"
                            },
                            "lagExtract":{
                                "description":"lag from start to extraction of lcr into trail file",
                                "type":"number"
                            },
                            "path":{
                                "description":"Replication path",
                                "type":"string",
                                "minLength":1,
                                "maxLength":4095
                            },
                            "processType":{
                                "description":"Process group type",
                                "enum":[
                                    "extract",
                                    "replicat"
                                ]
                            },
                            "lagSeconds":{
                                "description":"Process lag in seconds",
                                "type":"number"
                            },
                            "ageSeconds":{
                                "description":"Age of the lag in seconds",
                                "type":"number"
                            },
                            "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
                            },
                            "recordedAt":{
                                "description":"Entry recorded at time",
                                "type":"string",
                                "pattern":"^[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])$",
                                "minLength":20,
                                "maxLength":32
                            },
                            "lagRouting":{
                                "description":"lag from extract to routing point, has not crossed network yet",
                                "type":"number"
                            },
                            "lagReplicatRead":{
                                "description":"lag from routing point to replicat read point",
                                "type":"number"
                            }
                        },
                        "required":[
                            "source",
                            "target",
                            "processName",
                            "processType",
                            "path",
                            "lagSeconds",
                            "recordedAt"
                        ],
                        "additionalProperties":false
                    },
                    "minItems":0,
                    "maxItems":4095
                }
            ]
        }
    },
    "additionalProperties":false
}

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

いずれかに一致

ソースの表示

array heartbeats-x-anyOf[0]

最小アイテム数: 0

最大アイテム数: 1024

ハートビートの詳細
array heartbeats-x-anyOf[1]

最小アイテム数: 0

最大アイテム数: 4095

ハートビートの詳細(拡張)

{
    "x-anyOf":[
        {
            "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
        },
        {
            "description":"Heartbeat details (Extended)",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "processName":{
                        "description":"Process group name",
                        "type":"string",
                        "pattern":"^[A-Z_$][A-Z0-9_$]*$",
                        "minLength":1,
                        "maxLength":8
                    },
                    "lagReplicat":{
                        "description":"lag from replicat read point to after replicat apply",
                        "type":"number"
                    },
                    "lagExtract":{
                        "description":"lag from start to extraction of lcr into trail file",
                        "type":"number"
                    },
                    "path":{
                        "description":"Replication path",
                        "type":"string",
                        "minLength":1,
                        "maxLength":4095
                    },
                    "processType":{
                        "description":"Process group type",
                        "enum":[
                            "extract",
                            "replicat"
                        ]
                    },
                    "lagSeconds":{
                        "description":"Process lag in seconds",
                        "type":"number"
                    },
                    "ageSeconds":{
                        "description":"Age of the lag in seconds",
                        "type":"number"
                    },
                    "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
                    },
                    "recordedAt":{
                        "description":"Entry recorded at time",
                        "type":"string",
                        "pattern":"^[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])$",
                        "minLength":20,
                        "maxLength":32
                    },
                    "lagRouting":{
                        "description":"lag from extract to routing point, has not crossed network yet",
                        "type":"number"
                    },
                    "lagReplicatRead":{
                        "description":"lag from routing point to replicat read point",
                        "type":"number"
                    }
                },
                "required":[
                    "source",
                    "target",
                    "processName",
                    "processType",
                    "path",
                    "lagSeconds",
                    "recordedAt"
                ],
                "additionalProperties":false
            },
            "minItems":0,
            "maxItems":4095
        }
    ]
}

ネストされたスキーマ: heartbeats-x-anyOf[0]

型: 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
}

ネストされたスキーマ: heartbeats-x-anyOf[1]

型: array

最小アイテム数: 0

最大アイテム数: 4095

ハートビートの詳細(拡張)

ソースの表示

配列: object items

{
    "description":"Heartbeat details (Extended)",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "processName":{
                "description":"Process group name",
                "type":"string",
                "pattern":"^[A-Z_$][A-Z0-9_$]*$",
                "minLength":1,
                "maxLength":8
            },
            "lagReplicat":{
                "description":"lag from replicat read point to after replicat apply",
                "type":"number"
            },
            "lagExtract":{
                "description":"lag from start to extraction of lcr into trail file",
                "type":"number"
            },
            "path":{
                "description":"Replication path",
                "type":"string",
                "minLength":1,
                "maxLength":4095
            },
            "processType":{
                "description":"Process group type",
                "enum":[
                    "extract",
                    "replicat"
                ]
            },
            "lagSeconds":{
                "description":"Process lag in seconds",
                "type":"number"
            },
            "ageSeconds":{
                "description":"Age of the lag in seconds",
                "type":"number"
            },
            "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
            },
            "recordedAt":{
                "description":"Entry recorded at time",
                "type":"string",
                "pattern":"^[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])$",
                "minLength":20,
                "maxLength":32
            },
            "lagRouting":{
                "description":"lag from extract to routing point, has not crossed network yet",
                "type":"number"
            },
            "lagReplicatRead":{
                "description":"lag from routing point to replicat read point",
                "type":"number"
            }
        },
        "required":[
            "source",
            "target",
            "processName",
            "processType",
            "path",
            "lagSeconds",
            "recordedAt"
        ],
        "additionalProperties":false
    },
    "minItems":0,
    "maxItems":4095
}

ネストされたスキーマ: 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
}

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

型: object

ソースの表示

ageSeconds(optional): number

ラグの経過期間(秒)
lagExtract(optional): number

開始からLCRのトレイル・ファイルへの抽出までのラグ
lagReplicat(optional): number

Replicat読取りポイントからReplicat適用後までのラグ
lagReplicatRead(optional): number

ルーティング・ポイントからReplicat読取りポイントまでのラグ
lagRouting(optional): number

Extractからルーティング・ポイントまでのラグがまだネットワークを超えていません
lagSeconds: number

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

最小長: 1

最大長: 4095

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

最小長: 1

最大長: 8

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

プロセス・グループ名
processType:

指定できる値: [ "extract", "replicat" ]

プロセス・グループ・タイプ
recordedAt: string

最小長: 20

最大長: 32

パターン: ^[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])$

時間に記録されたエントリ
source: string

最小長: 1

最大長: 130

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

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

最小長: 1

最大長: 130

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

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

{
    "type":"object",
    "properties":{
        "processName":{
            "description":"Process group name",
            "type":"string",
            "pattern":"^[A-Z_$][A-Z0-9_$]*$",
            "minLength":1,
            "maxLength":8
        },
        "lagReplicat":{
            "description":"lag from replicat read point to after replicat apply",
            "type":"number"
        },
        "lagExtract":{
            "description":"lag from start to extraction of lcr into trail file",
            "type":"number"
        },
        "path":{
            "description":"Replication path",
            "type":"string",
            "minLength":1,
            "maxLength":4095
        },
        "processType":{
            "description":"Process group type",
            "enum":[
                "extract",
                "replicat"
            ]
        },
        "lagSeconds":{
            "description":"Process lag in seconds",
            "type":"number"
        },
        "ageSeconds":{
            "description":"Age of the lag in seconds",
            "type":"number"
        },
        "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
        },
        "recordedAt":{
            "description":"Entry recorded at time",
            "type":"string",
            "pattern":"^[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])$",
            "minLength":20,
            "maxLength":32
        },
        "lagRouting":{
            "description":"lag from extract to routing point, has not crossed network yet",
            "type":"number"
        },
        "lagReplicatRead":{
            "description":"lag from routing point to replicat read point",
            "type":"number"
        }
    },
    "required":[
        "source",
        "target",
        "processName",
        "processType",
        "path",
        "lagSeconds",
        "recordedAt"
    ],
    "additionalProperties":false
}

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

先頭に戻る