Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve Status

get

/services/{version}/replicats/{replicat}/info/status

Required Role: User

Retrieve the current status of the replicat process.

Request

Path Parameters

replicat(required): string

Minimum Length: 1

Maximum Length: 8

Pattern: ^[A-Z_$][A-Z0-9_$]*$

The name of the replicat. Replicat names are upper case, begin with an alphabetic character followed by up to seven alpha-numeric characters.
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Process status retrieved successfully.

Root Schema : Replicat process status

Type: object

Title: Replicat process status

Show Source

$schema:

Allowed Values: [ "ogg:replicatStatus" ]
lag(required): integer

Minimum Value: 0

Maximum Value: 4294967295

Process lag in seconds
lastStarted(required): lastStarted
position: position
processId: integer

Minimum Value: 1

Maximum Value: 4294967295
sinceLagReported(required): integer

Minimum Value: 0

Maximum Value: 4294967295

Time in seconds since process lag was reported
status(required):

Allowed Values: [ "starting", "running", "stopped", "killed", "abended" ]
synchronized: boolean

{
    "title":"Replicat process status",
    "required":[
        "status",
        "lastStarted",
        "lag",
        "sinceLagReported"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:replicatStatus"
            ]
        },
        "status":{
            "enum":[
                "starting",
                "running",
                "stopped",
                "killed",
                "abended"
            ]
        },
        "synchronized":{
            "type":"boolean"
        },
        "lastStarted":{
            "x-oneOf":[
                {
                    "type":"string",
                    "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])$",
                    "minLength":"20",
                    "maxLength":"32"
                },
                {
                    "type":"null"
                }
            ]
        },
        "position":{
            "x-oneOf":[
                {
                    "type":"object",
                    "properties":{
                        "$schema":{
                            "enum":[
                                "ogg:trailPosition"
                            ]
                        },
                        "name":{
                            "description":"The name of the trail",
                            "type":"string",
                            "pattern":"^[a-zA-Z0-9_#$/-]*$",
                            "minLength":"2",
                            "maxLength":"512"
                        },
                        "path":{
                            "description":"The path where trail data is stored",
                            "type":"string",
                            "minLength":"1",
                            "maxLength":"4096"
                        },
                        "sequence":{
                            "description":"Trail file sequence number",
                            "type":"integer",
                            "minimum":"0",
                            "maximum":"999999999",
                            "default":"0"
                        },
                        "offset":{
                            "description":"Offset in trail sequence file",
                            "type":"integer",
                            "minimum":"0",
                            "default":"0",
                            "maximum":"2147483647"
                        }
                    },
                    "required":[
                        "name",
                        "sequence",
                        "offset"
                    ],
                    "additionalProperties":false
                },
                {
                    "type":"object",
                    "properties":{
                        "$schema":{
                            "enum":[
                                "ogg:filePosition"
                            ]
                        },
                        "name":{
                            "description":"The name of the file",
                            "type":"string",
                            "minLength":"1",
                            "maxLength":"4096"
                        },
                        "path":{
                            "description":"The path where file data is stored",
                            "type":"string",
                            "minLength":"1",
                            "maxLength":"4096"
                        },
                        "offset":{
                            "description":"Offset in file",
                            "type":"integer",
                            "minimum":"0",
                            "maximum":"2147483647"
                        }
                    },
                    "required":[
                        "name",
                        "path",
                        "offset"
                    ],
                    "additionalProperties":false
                }
            ]
        },
        "lag":{
            "description":"Process lag in seconds",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "sinceLagReported":{
            "description":"Time in seconds since process lag was reported",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "processId":{
            "type":"integer",
            "minimum":"1",
            "maximum":"4294967295"
        }
    },
    "additionalProperties":false
}

Nested Schema : lastStarted

Match One

Show Source

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])$
null

{
    "x-oneOf":[
        {
            "type":"string",
            "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])$",
            "minLength":"20",
            "maxLength":"32"
        },
        {
            "type":"null"
        }
    ]
}

Nested Schema : position

Match One

Show Source

object position-x-oneOf[0]
object position-x-oneOf[1]

{
    "x-oneOf":[
        {
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:trailPosition"
                    ]
                },
                "name":{
                    "description":"The name of the trail",
                    "type":"string",
                    "pattern":"^[a-zA-Z0-9_#$/-]*$",
                    "minLength":"2",
                    "maxLength":"512"
                },
                "path":{
                    "description":"The path where trail data is stored",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"4096"
                },
                "sequence":{
                    "description":"Trail file sequence number",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"999999999",
                    "default":"0"
                },
                "offset":{
                    "description":"Offset in trail sequence file",
                    "type":"integer",
                    "minimum":"0",
                    "default":"0",
                    "maximum":"2147483647"
                }
            },
            "required":[
                "name",
                "sequence",
                "offset"
            ],
            "additionalProperties":false
        },
        {
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:filePosition"
                    ]
                },
                "name":{
                    "description":"The name of the file",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"4096"
                },
                "path":{
                    "description":"The path where file data is stored",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"4096"
                },
                "offset":{
                    "description":"Offset in file",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"2147483647"
                }
            },
            "required":[
                "name",
                "path",
                "offset"
            ],
            "additionalProperties":false
        }
    ]
}

Nested Schema : position-x-oneOf[0]

Type: object

Show Source

$schema:

Allowed Values: [ "ogg:trailPosition" ]
name(required): string

Minimum Length: 2

Maximum Length: 512

Pattern: ^[a-zA-Z0-9_#$/-]*$

The name of the trail
offset(required): integer

Minimum Value: 0

Maximum Value: 2147483647

Default Value: 0

Offset in trail sequence file
path: string

Minimum Length: 1

Maximum Length: 4096

The path where trail data is stored
sequence(required): integer

Minimum Value: 0

Maximum Value: 999999999

Default Value: 0

Trail file sequence number

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:trailPosition"
            ]
        },
        "name":{
            "description":"The name of the trail",
            "type":"string",
            "pattern":"^[a-zA-Z0-9_#$/-]*$",
            "minLength":"2",
            "maxLength":"512"
        },
        "path":{
            "description":"The path where trail data is stored",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "sequence":{
            "description":"Trail file sequence number",
            "type":"integer",
            "minimum":"0",
            "maximum":"999999999",
            "default":"0"
        },
        "offset":{
            "description":"Offset in trail sequence file",
            "type":"integer",
            "minimum":"0",
            "default":"0",
            "maximum":"2147483647"
        }
    },
    "required":[
        "name",
        "sequence",
        "offset"
    ],
    "additionalProperties":false
}

Nested Schema : position-x-oneOf[1]

Type: object

Show Source

$schema:

Allowed Values: [ "ogg:filePosition" ]
name(required): string

Minimum Length: 1

Maximum Length: 4096

The name of the file
offset(required): integer

Minimum Value: 0

Maximum Value: 2147483647

Offset in file
path(required): string

Minimum Length: 1

Maximum Length: 4096

The path where file data is stored

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:filePosition"
            ]
        },
        "name":{
            "description":"The name of the file",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "path":{
            "description":"The path where file data is stored",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "offset":{
            "description":"Offset in file",
            "type":"integer",
            "minimum":"0",
            "maximum":"2147483647"
        }
    },
    "required":[
        "name",
        "path",
        "offset"
    ],
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/replicats/REPS/info/status",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/replicats/REPS/info/status",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/replicatStatus",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:replicatStatus",
        "lag":"0",
        "lastStarted":"2024-04-03T22:35:31.674Z",
        "position":{
            "name":"ea",
            "offset":"0",
            "path":"/u02/Deployment/var/lib/data/ggnorth/",
            "sequence":"0"
        },
        "processId":"787",
        "sinceLagReported":"0",
        "status":"running"
    }
}