Jump to

• Request
• Response

Retrieve

get

/services/{version}/datastore

Required Role: User

Retrieve the details of the datastore

Request

Path Parameters

• 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 Performance Metrics Service Data Store

Type: object

Title: Oracle GoldenGate Performance Metrics Service Data Store

Show Source

• $schema:
  Allowed Values: [ "monitoring:datastore" ]
• collectorWorkerQueueLimit: integer
  Minimum Value: 5000

  Maximum Value: 50000

  Default Value: 10000

  Mpoint Collector Queue max size
• collectorWorkerThreads: integer
  Minimum Value: 3

  Maximum Value: 25

  Default Value: 5

  Mpoint Collector Number of Worker Threads
• dataStoreMaxDBs: integer
  Minimum Value: 5000

  Maximum Value: 10000

  Default Value: 5000

  Max Databases
• monitorHeartBeatTimeout: integer
  Minimum Value: 5

  Maximum Value: 60

  Default Value: 10

  Process monitoring heartbeat timeout in seconds
• path: string
  Minimum Length: 1

  Maximum Length: 4096

  The 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: 0

  Maximum Value: 365

  Default Value: 0

  The number of days to retain performance metrics data. If zero, data will be retained indefinitely.
• type(required):
  Default Value: BDB

  Allowed Values: [ "BDB", "LMDB" ]

  The type of datastore storage, either Berkeley Database (BDB) or Lightning Memory-Mapped Database (LMDB).

{
    "title":"Oracle GoldenGate Performance Metrics Service Data Store",
    "required":[
        "type"
    ],
    "type":"object",
    "properties":{
        "retentionDays":{
            "description":"The number of days to retain performance metrics data. If zero, data will be retained indefinitely.",
            "type":"integer",
            "minimum":"0",
            "maximum":"365",
            "default":"0"
        },
        "collectorWorkerThreads":{
            "description":"Mpoint Collector Number of Worker Threads",
            "type":"integer",
            "minimum":"3",
            "maximum":"25",
            "default":"5"
        },
        "path":{
            "description":"The path for the datastore storage. If not set, the datastore will be created in a default directory.",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "$schema":{
            "enum":[
                "monitoring:datastore"
            ]
        },
        "collectorWorkerQueueLimit":{
            "description":"Mpoint Collector Queue max size",
            "type":"integer",
            "minimum":"5000",
            "maximum":"50000",
            "default":"10000"
        },
        "monitorHeartBeatTimeout":{
            "description":"Process monitoring heartbeat timeout in seconds",
            "type":"integer",
            "minimum":"5",
            "maximum":"60",
            "default":"10"
        },
        "dataStoreMaxDBs":{
            "description":"Max Databases",
            "type":"integer",
            "minimum":"5000",
            "maximum":"10000",
            "default":"5000"
        },
        "reinitialize":{
            "description":"If set to true, the datastore will be reinitialized upon restart.",
            "type":"boolean"
        },
        "type":{
            "enum":[
                "BDB",
                "LMDB"
            ],
            "description":"The type of datastore storage, either Berkeley Database (BDB) or Lightning Memory-Mapped Database (LMDB).",
            "default":"BDB"
        },
        "repair":{
            "description":"If set to true, the datastore will be repaired upon restart.",
            "type":"boolean"
        }
    },
    "additionalProperties":false
}

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"
        },
        {
            "rel":"describedby",
            "href":"http://127.0.0.1:9015/services/v2/metadata-catalog/datastore",
            "mediaType":"application/schema+json"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"monitoring:datastore",
        "type":"LMDB",
        "retentionDays":"30",
        "collectorWorkerThreads":"5",
        "collectorWorkerQueueLimit":"10000",
        "monitorHeartBeatTimeout":"10",
        "dataStoreMaxDBs":"5000"
    }
}

Back to Top