Update
patch
/services/{version}/datastore
Required Role: Administrator
Change the datastore configuration used by the Performance Metrics Service. Changes to the datastore configuration will cause the Performance Metrics Service to restart.
Request
Supported Media Types
- application/json
Path Parameters
-
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Root Schema : Oracle GoldenGate Performance Metrics Service Data Store
Type:
objectTitle:
Show Source
Oracle GoldenGate Performance Metrics Service Data Store-
$schema:
Allowed Values:
[ "monitoring:datastore" ] -
collectorWorkerQueueLimit:
integer
Minimum Value:
5000Maximum Value:50000Default Value:10000Mpoint Collector Queue max size -
collectorWorkerThreads:
integer
Minimum Value:
3Maximum Value:25Default Value:5Mpoint Collector Number of Worker Threads -
dataStoreMaxDBs:
integer
Minimum Value:
5000Maximum Value:10000Default Value:5000Max Databases -
monitorHeartBeatTimeout:
integer
Minimum Value:
5Maximum Value:60Default Value:10Process monitoring heartbeat timeout in seconds -
path:
string
Minimum Length:
1Maximum Length:4096The path for the datastore storage. If not set, the datastore will be created in a default directory. -
reinitialize:
boolean
If set to true, the datastore will be reinitialized upon restart.
-
repair:
boolean
If set to true, the datastore will be repaired upon restart.
-
retentionDays:
integer
Minimum Value:
0Maximum Value:365Default Value:0The number of days to retain performance metrics data. If zero, data will be retained indefinitely. -
type(required):
Default Value:
BDBAllowed Values:[ "BDB", "LMDB" ]The type of datastore storage, either Berkeley Database (BDB) or Lightning Memory-Mapped Database (LMDB).
Example Request (application/json)
{
"type":"LMDB",
"retentionDays":"30",
"collectorWorkerThreads":"5",
"collectorWorkerQueueLimit":"10000",
"monitorHeartBeatTimeout":"10",
"dataStoreMaxDBs":"5000"
}Response
Supported Media Types
- application/json
200 Response
Datastore successfully updated.
Root Schema : RESTful API Standard Response
Type:
objectTitle:
RESTful API Standard ResponseStandard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema:
Allowed Values:
[ "api:standardResponse" ] -
links(required):
array links
Minimum Number of Items:
0Maximum Number of Items:16Oracle GoldenGate links for the request -
messages(required):
array messages
Minimum Number of Items:
0Maximum Number of Items:65535Oracle GoldenGate messages issued during the request -
response:
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
16Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
65535Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
objectOracle GoldenGate document from the request
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:link" ] -
description:
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this link. -
href(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI for the link -
mediaType:
string
Minimum Length:
6Maximum Length:255Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel(required):
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous", "ogg://service" ]Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:message" ] -
code(required):
string
Minimum Length:
9Maximum Length:9Pattern:^OGG[-][0-9]{5}$The Oracle GoldenGate message code -
issued(required):
string
Minimum Length:
20Maximum Length:32Pattern:^[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(required):
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]The severity of the message -
title(required):
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[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":[
{
"rel":"canonical",
"href":"http://127.0.0.1:9015/services/v2/datastore",
"mediaType":"application/json"
},
{
"rel":"self",
"href":"http://127.0.0.1:9015/services/v2/datastore",
"mediaType":"application/json"
}
],
"messages":[
]
}