Retrieve Restart Rule

get

/services/{version}/config/restart/{rule}

Retrieve a restart rule.

Request

Path Parameters
  • Minimum Length: 1
    Maximum Length: 32
    Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]*$

    Rule name, an alpha-numeric character followed by up to 31 alpha-numeric characters, '_' or '-'.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]

Response

Supported Media Types

200 Response

Restart rule retrieved successfully.

Body ()
Root Schema : Oracle GoldenGate ER Process Restart Rule
Type: object
Title: Oracle GoldenGate ER Process Restart Rule
Show Source
  • Allowed Values: [ "ogg:processRestart" ]
  • Minimum Value: 0
    Maximum Value: 3600
    Default Value: 120
    The amount of time, in seconds, to pause between discovering that a process has terminated abnormally and restarting the process.
  • Minimum Length: 1
    Maximum Length: 8
    Pattern: ^[*A-Z_$][*A-Z0-9_$]*$
    Wildcard name of process
  • Default Value: ER
    Allowed Values: [ "extract", "replicat", "ER" ]
    The type of process
  • Minimum Value: 0
    Maximum Value: 3600
    Default Value: 2
    The maximum number of times the task should be restarted before aborting retry efforts.
  • Minimum Value: 0
    Maximum Value: 604800
    Default Value: 7200
    The window of time, in seconds, during which retries are counted. The default is 7200 seconds (2 hours).
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/config/restart/Rule_001",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/config/restart/Rule_001",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/rule",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:processRestart",
        "delay":0,
        "processName":"EXT*",
        "processType":"extract",
        "retries":9,
        "window":5
    }
}