Create Restart Rule
post
/services/{version}/config/restart/{rule}
Create a new restart rule.
Request
Supported Media Types
- application/json
Path Parameters
-
rule: string
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 '-'.
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Root Schema : Oracle GoldenGate ER Process Restart Rule
Type:
object
Title:
Show Source
Oracle GoldenGate ER Process Restart Rule
-
$schema:
Allowed Values:
[ "ogg:processRestart" ]
-
delay:
integer
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. -
processName:
string
Minimum Length:
1
Maximum Length:8
Pattern:^[*A-Z_$][*A-Z0-9_$]*$
Wildcard name of process -
processType:
Default Value:
ER
Allowed Values:[ "extract", "replicat", "ER" ]
The type of process -
retries:
integer
Minimum Value:
0
Maximum Value:3600
Default Value:2
The maximum number of times the task should be restarted before aborting retry efforts. -
window:
integer
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
- application/json
201 Response
Restart rule created successfully.
Root Schema : RESTful API Standard Response
Type:
object
Title:
RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema:
Allowed Values:
[ "api:standardResponse" ]
-
links:
array links
Minimum Number of Items:
0
Maximum Number of Items:16
Oracle GoldenGate links for the request -
messages:
array messages
Minimum Number of Items:
0
Maximum Number of Items:65535
Oracle GoldenGate messages issued during the request -
response:
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
16
Oracle GoldenGate links for the request
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:
Show Source
object
-
$schema:
Allowed Values:
[ "ogg:link" ]
-
description:
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this link. -
href:
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
An absolute URI for the link -
mediaType:
string
Minimum Length:
6
Maximum Length:255
Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$
Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel:
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]
Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object
-
$schema:
Allowed Values:
[ "ogg:message" ]
-
code:
string
Minimum Length:
9
Maximum Length:9
Pattern:^OGG[-][0-9]{5}$
The Oracle GoldenGate message code -
issued:
string
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 -
severity:
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]
The severity of the message -
title:
string
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. -
type:
string
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"
}
]
}