Oracle GoldenGate REST API 21c (21.1.0)

サービス状態のサマリー

get

/services/{version}/config/health/check

サービス状態のサマリー情報を取得します。

リクエスト

パス・パラメータ

version: string

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

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: Oracle GoldenGate Service Health Summary

型: object

タイトル: Oracle GoldenGate Service Health Summary

このスキーマはOGGサービスの状態をまとめます

ソースの表示

$schema(optional):

指定できる値: [ "ogg:healthSummary" ]
deploymentId: string

最小長: 36

最大長: 36

パターン: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

このサービスのデプロイメントの一意の識別子
deploymentName: string

最小長: 1

最大長: 32

パターン: ^[A-Za-z][A-Za-z0-9-_.]*$

Oracle GoldenGateデプロイメントの名前
healthy: boolean

Microservice状態インジケータ
serviceId: string

最小長: 36

最大長: 36

パターン: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

このサービスの一意の識別子
serviceManagerId: string

最小長: 36

最大長: 36

パターン: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

このサービスを管理するService Managerサービスの一意の識別子
serviceName: string

最小長: 1

最大長: 64

OGG Microserviceの名前
started: 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])$

サービスが開始した日時

{
    "title":"Oracle GoldenGate Service Health Summary",
    "description":"This schema summarizes the health of an OGG service",
    "required":[
        "serviceManagerId",
        "deploymentId",
        "deploymentName",
        "serviceId",
        "serviceName",
        "started",
        "healthy"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:healthSummary"
            ]
        },
        "serviceManagerId":{
            "description":"The unique identifier for the Service Manager service that manages this service",
            "type":"string",
            "pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
            "minLength":36,
            "maxLength":36
        },
        "deploymentId":{
            "description":"The unique identifier for this service's deployment",
            "type":"string",
            "pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
            "minLength":36,
            "maxLength":36
        },
        "deploymentName":{
            "description":"Name of the Oracle GoldenGate deployment",
            "type":"string",
            "pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
            "minLength":1,
            "maxLength":32
        },
        "serviceId":{
            "description":"The unique identifier for this service",
            "type":"string",
            "pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
            "minLength":36,
            "maxLength":36
        },
        "serviceName":{
            "description":"Name of the OGG Microservice",
            "type":"string",
            "minLength":1,
            "maxLength":64
        },
        "started":{
            "description":"Date and time the service started",
            "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
        },
        "healthy":{
            "description":"Microservice health indicator",
            "type":"boolean"
        }
    },
    "additionalProperties":false
}

レスポンスの例(application/json)

{
    "$schema":"api:standardResponse",
    "links":[
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:healthSummary",
        "deploymentId":"ed2b52fe-59c2-489a-9920-7ce46e177ff7",
        "deploymentName":"Local",
        "healthy":true,
        "serviceId":"622ba937-3fb1-48ee-8f4a-9d9731632683",
        "serviceManagerId":"c6566f33-fafd-49a5-952f-ac96c99b83fa",
        "serviceName":"adminsrvr",
        "started":"2021-03-15T17:22:00.220Z"
    }
}

429レスポンス