Jump to

• Request
• Response

Retrieve an existing Bounded Recovery Object Pool Information

get

/services/{version}/mpoints/{item}/brPoolsInfo

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 object pool information

Type: object

Title: Oracle GoldenGate Bounded Recovery object pool information

Show Source

• $schema(optional):
  Allowed Values: [ "mpoints:brPoolsInfo" ]
• pools(optional): array pools
  Minimum Number of Items: 0

  Maximum Number of Items: 2147483647

{
    "title":"Oracle GoldenGate Bounded Recovery object pool information",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "mpoints:brPoolsInfo"
            ]
        },
        "pools":{
            "type":"array",
            "minItems":0,
            "maxItems":2147483647,
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"Pool ID",
                        "type":"string",
                        "minLength":1,
                        "maxLength":64
                    },
                    "instance":{
                        "description":"Pool Instance",
                        "type":"integer",
                        "minimum":0,
                        "maximum":2147483647
                    },
                    "objectSizeBucketsLen":{
                        "description":"The length of object sizes array (the number of buckets)",
                        "type":"integer",
                        "minimum":0,
                        "maximum":2147483647
                    },
                    "extantObjectSizeBucketsLen":{
                        "description":"The length of extant object sizes array",
                        "type":"integer",
                        "minimum":0,
                        "maximum":2147483647
                    },
                    "objectAgeBucketsLen":{
                        "description":"The length of object ages array",
                        "type":"integer",
                        "minimum":0,
                        "maximum":2147483647
                    },
                    "extantObjectAgeBucketsLen":{
                        "description":"The length of extant object ages array",
                        "type":"integer",
                        "minimum":0,
                        "maximum":2147483647
                    }
                },
                "additionalProperties":false
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : pools

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

Show Source

• Array of: object items

{
    "type":"array",
    "minItems":0,
    "maxItems":2147483647,
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"Pool ID",
                "type":"string",
                "minLength":1,
                "maxLength":64
            },
            "instance":{
                "description":"Pool Instance",
                "type":"integer",
                "minimum":0,
                "maximum":2147483647
            },
            "objectSizeBucketsLen":{
                "description":"The length of object sizes array (the number of buckets)",
                "type":"integer",
                "minimum":0,
                "maximum":2147483647
            },
            "extantObjectSizeBucketsLen":{
                "description":"The length of extant object sizes array",
                "type":"integer",
                "minimum":0,
                "maximum":2147483647
            },
            "objectAgeBucketsLen":{
                "description":"The length of object ages array",
                "type":"integer",
                "minimum":0,
                "maximum":2147483647
            },
            "extantObjectAgeBucketsLen":{
                "description":"The length of extant object ages array",
                "type":"integer",
                "minimum":0,
                "maximum":2147483647
            }
        },
        "additionalProperties":false
    }
}

Nested Schema : items

Type: object

Show Source

• extantObjectAgeBucketsLen(optional): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The length of extant object ages array
• extantObjectSizeBucketsLen(optional): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The length of extant object sizes array
• id(optional): string
  Minimum Length: 1

  Maximum Length: 64

  Pool ID
• instance(optional): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  Pool Instance
• objectAgeBucketsLen(optional): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The length of object ages array
• objectSizeBucketsLen(optional): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The length of object sizes array (the number of buckets)

{
    "type":"object",
    "properties":{
        "id":{
            "description":"Pool ID",
            "type":"string",
            "minLength":1,
            "maxLength":64
        },
        "instance":{
            "description":"Pool Instance",
            "type":"integer",
            "minimum":0,
            "maximum":2147483647
        },
        "objectSizeBucketsLen":{
            "description":"The length of object sizes array (the number of buckets)",
            "type":"integer",
            "minimum":0,
            "maximum":2147483647
        },
        "extantObjectSizeBucketsLen":{
            "description":"The length of extant object sizes array",
            "type":"integer",
            "minimum":0,
            "maximum":2147483647
        },
        "objectAgeBucketsLen":{
            "description":"The length of object ages array",
            "type":"integer",
            "minimum":0,
            "maximum":2147483647
        },
        "extantObjectAgeBucketsLen":{
            "description":"The length of extant object ages array",
            "type":"integer",
            "minimum":0,
            "maximum":2147483647
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "response":{
        "pools":[
            {
                "id":"p3989_extr",
                "instance":1,
                "objectSizeBucketsLen":3,
                "extantObjectSizeBucketsLen":3,
                "objectAgeBucketsLen":4,
                "extantObjectAgeBucketsLen":4
            },
            {
                "id":"p3989_ORA-LOB-MEMPOOL",
                "instance":0,
                "objectSizeBucketsLen":2,
                "extantObjectSizeBucketsLen":2,
                "objectAgeBucketsLen":10,
                "extantObjectAgeBucketsLen":10
            }
        ],
        "$schema":"mpoints:brPoolsInfo"
    },
    "messages":[
    ],
    "links":[
    ]
}

Back to Top