1. Oracle GoldenGate
  2. Tasks
  3. Administrative Server
  4. Configuration Settings

Create Restart Rule

post

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

Create a new restart rule.

Request

Supported Media Types
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" ]
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 Request (application/json)
{
    "processType":"ER",
    "processName":"EXT*",
    "delay":0,
    "retries":3,
    "window":5
}

Response

Supported Media Types

201 Response

Restart rule created successfully.

Body ()
Root Schema : RESTful API Standard Response
Type: object
Title: RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
Show Source
Nested Schema : messages
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 65535
Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type: object
Oracle GoldenGate document from the request
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "ogg:message" ]
  • Minimum Length: 9
    Maximum Length: 9
    Pattern: ^OGG[-][0-9]{5}$
    The Oracle GoldenGate message code
  • Minimum Length: 20
    Maximum Length: 32
    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])$
    The date and time that the message was issued
  • Allowed Values: [ "INFO", "WARNING", "ERROR" ]
    The severity of the message
  • Minimum Length: 1
    Maximum Length: 4095
    A human-readable description that provides information and detail specific to this occurence of the information, warning or error.
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    An absolute URI [RFC3986] to a page that describes the info, warning or error type.
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"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-08276",
            "issued":"2017-12-14T12:44:44Z",
            "severity":"INFO",
            "title":"Auto-restart rule 'Rule_001' has been added.",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-08276"
        }
    ]
}