Jump to

• Request
• Response

Retrieve an existing Bounded Recovery Status

get

/services/{version}/mpoints/{item}/brStatus

Request

Path Parameters

• item: string
  Minimum Length: 1

  Maximum Length: 32
• version: 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 Bounded Recovery status

Type: object

Title: Oracle GoldenGate Bounded Recovery status

Show Source

• $schema(optional):
  Allowed Values: [ "mpoints:brStatus" ]
• checkpointInterval(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  The time interval between two checkpoints
• forceCheckpointTime(optional): string
  Minimum Length: 1

  Maximum Length: 32

  Force Checkpoint time
• lastCheckpoint(optional): string
  Minimum Length: 1

  Maximum Length: 32

  Last checkpoint time
• lastCheckpointNum(optional): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of checkpoint up to now
• nextCheckpoint(optional): string
  Minimum Length: 1

  Maximum Length: 32

  Next checkpoint time
• outstandingDataSize(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Data size of all objects still remaining to be persisted at the BR checkpoint
• outstandingObjects(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Number of objects still remaining to be persisted at the BR checkpoint
• outstandingStateSize(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  State size of all objects still remaining to be persisted at the BR checkpoint
• status(optional): string
  Minimum Length: 1

  Maximum Length: 16

  The status of the BR
• totalDataSize(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Data size of all objects to be persisted at the BR checkpoint
• totalObjects(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  Number of objects to be persisted at the BR checkpoint
• totalStateSize(optional): integer
  Minimum Value: 0

  Maximum Value: 9.223372036854776E18

  State size of all objects to be persisted at the BR checkpoint

{
    "title":"Oracle GoldenGate Bounded Recovery status",
    "type":"object",
    "properties":{
        "lastCheckpointNum":{
            "description":"The number of checkpoint up to now",
            "type":"integer",
            "minimum":0,
            "maximum":2147483647
        },
        "outstandingDataSize":{
            "description":"Data size of all objects still remaining to be persisted at the BR checkpoint",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "lastCheckpoint":{
            "description":"Last checkpoint time",
            "type":"string",
            "minLength":1,
            "maxLength":32
        },
        "$schema":{
            "enum":[
                "mpoints:brStatus"
            ]
        },
        "outstandingStateSize":{
            "description":"State size of all objects still remaining to be persisted at the BR checkpoint",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "totalStateSize":{
            "description":"State size of all objects to be persisted at the BR checkpoint",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "status":{
            "description":"The status of the BR",
            "type":"string",
            "minLength":1,
            "maxLength":16
        },
        "checkpointInterval":{
            "description":"The time interval between two checkpoints",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "nextCheckpoint":{
            "description":"Next checkpoint time",
            "type":"string",
            "minLength":1,
            "maxLength":32
        },
        "outstandingObjects":{
            "description":"Number of objects still remaining to be persisted at the BR checkpoint",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "forceCheckpointTime":{
            "description":"Force Checkpoint time",
            "type":"string",
            "minLength":1,
            "maxLength":32
        },
        "totalDataSize":{
            "description":"Data size of all objects to be persisted at the BR checkpoint",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        "totalObjects":{
            "description":"Number of objects to be persisted at the BR checkpoint",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "response":{
        "lastCheckpointNum":129,
        "outstandingDataSize":233774152,
        "lastCheckpoint":"2020-02-24T19:51:48.044Z",
        "$schema":"mpoints:brStatus",
        "outstandingStateSize":74152,
        "totalStateSize":356816,
        "status":"inProgress",
        "checkpointInterval":40,
        "nextCheckpoint":"2020-02-24T19:52:28.044Z",
        "outstandingObjects":42,
        "forceCheckpointTime":"",
        "totalDataSize":315556816,
        "totalObjects":52
    },
    "messages":[
    ],
    "links":[
    ]
}

Back to Top