Jump to

• Request
• Response

Retrieve an existing Service Health

get

/services/{version}/mpoints/{item}/serviceHealth

Required Role: User

Retrieve an existing Service Health

Request

Path Parameters

• item(required): string
  Minimum Length: 1

  Maximum Length: 32
• version(required): string

  Oracle GoldenGate Service API version.

  Allowed Values: [ "v2" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : Oracle GoldenGate Service Health

Type: object

Title: Oracle GoldenGate Service Health

Show Source

• $schema:
  Allowed Values: [ "mpoints:serviceHealth" ]
• criticalResourcesHealthy(required): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of healthy critical resources
• criticalResourcesUnhealthy(required): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of unhealthy critical resources
• isHealthy(required): boolean
  Indicates the overall health of the service

{
    "title":"Oracle GoldenGate Service Health",
    "required":[
        "isHealthy",
        "criticalResourcesHealthy",
        "criticalResourcesUnhealthy"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "mpoints:serviceHealth"
            ]
        },
        "isHealthy":{
            "description":"Indicates the overall health of the service",
            "type":"boolean"
        },
        "criticalResourcesHealthy":{
            "description":"The number of healthy critical resources",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        },
        "criticalResourcesUnhealthy":{
            "description":"The number of unhealthy critical resources",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "rel":"canonical",
            "href":"http://127.0.0.1:9015/services/v2/mpoints/ADMINSRVR/serviceHealth",
            "mediaType":"application/json"
        },
        {
            "rel":"self",
            "href":"http://127.0.0.1:9015/services/v2/mpoints/ADMINSRVR/serviceHealth",
            "mediaType":"application/json"
        },
        {
            "rel":"describedby",
            "href":"http://127.0.0.1:9015/services/v2/metadata-catalog/serviceHealth",
            "mediaType":"application/schema+json"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"mpoints:serviceHealth",
        "isHealthy":true,
        "criticalResourcesHealthy":"2",
        "criticalResourcesUnhealthy":"0"
    }
}

Back to Top