1. Oracle GoldenGate 23ai Microservices Architecture REST API Documentation
  2. Tasks
  3. Administration Service
  4. Replicats

Retrieve Diagnostics

get

/services/{version}/replicats/{replicat}/info/diagnostics/{diagnostic}

Required Role: User

Retrieve a diagnostics result for the replicat process.

Request

Path Parameters
  • Minimum Length: 0
    Maximum Length: 22
    Pattern: ^(|[A-Z_$][A-Z0-9_$]{0,7}.diagnostics([.][1-9])?)$

    The name of the diagnostic results, which is the replicat name and '.diagnostics', followed by an optional revision number.

  • 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.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Query Parameters

  • The time that the diagnostics collection started. This query parameter applies only to the '{diagnostic}' resource without a revision number. For example: REPN.diagnostics?started=2022-08-04T19:40:07Z

Back to Top

Response

Supported Media Types

200 Response

Diagnostics retrieved successfully.

Body ()
Root Schema : Integrated Diagnostics Results
Type: object
Title: Integrated Diagnostics Results
Show Source
  • Allowed Values: [ "ogg:diagnostics" ]
  • Minimum Value: 1
    Maximum Value: 60
    Data collection duration in seconds
  • Minimum Value: 5
    Maximum Value: 60
    Data collection frequency in seconds
  • 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])$
    Date and time the diagnostics finished
  • samples
    Sampled statistics for the time period
  • 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])$
    Date and time the diagnostics started
  • Allowed Values: [ "starting", "running", "stopped", "killed", "abended" ]
    Status of the diagnostics process
Nested Schema : samples
Type: array
Sampled statistics for the time period
Show Source
Nested Schema : items
Type: object
Sampled statistics from all database processes for a point in time
Show Source
Nested Schema : processSamples
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 512
Database process statistics
Show Source
Nested Schema : items
Type: object
Sampled statistics from a database process
Show Source
Nested Schema : process
Process details
Match One
Show Source
Nested Schema : process-x-oneOf[0]
Type: object
Capture Process Details
Show Source
Nested Schema : process-x-oneOf[1]
Type: object
LogMiner Process Details
Show Source
  • Allowed Values: [ "reader", "preparer", "builder", "merger", "coordinator", "applier", "unknown" ]
    LogMiner Role
  • Allowed Values: [ "logminer" ]
    Process type
Nested Schema : process-x-oneOf[2]
Type: object
Apply Reader Process Details
Show Source
Nested Schema : process-x-oneOf[3]
Type: object
Apply Receiver Process Details
Show Source
Nested Schema : process-x-oneOf[4]
Type: object
Apply Coordinator Process Details
Show Source
Nested Schema : process-x-oneOf[5]
Type: object
Apply Server Process Details
Show Source
Nested Schema : state
Type: object
Database process state
Show Source
  • Minimum Length: 1
    Maximum Length: 128
    Detailed information for the database process
  • Allowed Values: [ "initializing", "waiting", "idle", "suspended", "aborting", "shutdown", "paused", "working", "other" ]
    Status of the database process
Nested Schema : state
Type: object
Database process state
Show Source
  • Minimum Length: 1
    Maximum Length: 128
    Detailed information for the database process
  • Allowed Values: [ "initializing", "waiting", "idle", "suspended", "aborting", "shutdown", "paused", "working", "other" ]
    Status of the database process
Nested Schema : state
Type: object
Database process state
Show Source
  • Minimum Length: 1
    Maximum Length: 128
    Detailed information for the database process
  • Allowed Values: [ "initializing", "waiting", "idle", "suspended", "aborting", "shutdown", "paused", "working", "other" ]
    Status of the database process
Nested Schema : state
Type: object
Database process state
Show Source
  • Minimum Length: 1
    Maximum Length: 128
    Detailed information for the database process
  • Allowed Values: [ "initializing", "waiting", "idle", "suspended", "aborting", "shutdown", "paused", "working", "other" ]
    Status of the database process
Nested Schema : state
Type: object
Database process state
Show Source
  • Minimum Length: 1
    Maximum Length: 128
    Detailed information for the database process
  • Allowed Values: [ "initializing", "waiting", "idle", "suspended", "aborting", "shutdown", "paused", "working", "other" ]
    Status of the database process
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/replicats/REPS/info/diagnostics/REPS.diagnostics",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/replicats/REPS/info/diagnostics/REPS.diagnostics",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/replicatDiagnosticsDiagnostic",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:diagnostics",
        "collectionDuration":"30",
        "collectionFrequency":"15",
        "samples":[
            {
                "collectionDate":"2024-04-03T22:36:00Z",
                "processSamples":[
                    {
                        "cpuPercent":"0.1095610186457634",
                        "idlePercent":"99.89044189453124",
                        "process":{
                            "bytesReceived":"3182",
                            "state":{
                                "detail":"IDLE",
                                "status":"idle"
                            },
                            "type":"reader"
                        },
                        "processId":"6143",
                        "sessionId":"4600"
                    },
                    {
                        "cpuPercent":"0",
                        "idlePercent":"100",
                        "process":{
                            "state":{
                                "detail":"IDLE",
                                "status":"idle"
                            },
                            "transactionsApplied":"0",
                            "type":"coordinator"
                        },
                        "processId":"6141",
                        "sessionId":"4480"
                    },
                    {
                        "cpuPercent":"0.0009960245806723833",
                        "idlePercent":"99.99900817871094",
                        "process":{
                            "messagesApplied":"0",
                            "state":{
                                "detail":"IDLE",
                                "status":"idle"
                            },
                            "type":"applier"
                        },
                        "processId":"6145",
                        "sessionId":"4723"
                    },
                    {
                        "cpuPercent":"0.0008919245447032154",
                        "idlePercent":"99.99910736083984",
                        "process":{
                            "messagesApplied":"0",
                            "state":{
                                "detail":"IDLE",
                                "status":"idle"
                            },
                            "type":"applier"
                        },
                        "processId":"6147",
                        "sessionId":"4843"
                    },
                    {
                        "cpuPercent":"0.0008593724342063069",
                        "idlePercent":"99.9991455078125",
                        "process":{
                            "messagesApplied":"0",
                            "state":{
                                "detail":"IDLE",
                                "status":"idle"
                            },
                            "type":"applier"
                        },
                        "processId":"6149",
                        "sessionId":"4965"
                    },
                    {
                        "cpuPercent":"0.001165360794402659",
                        "idlePercent":"99.99883270263672",
                        "process":{
                            "messagesApplied":"0",
                            "state":{
                                "detail":"IDLE",
                                "status":"idle"
                            },
                            "type":"applier"
                        },
                        "processId":"6151",
                        "sessionId":"5084"
                    }
                ]
            },
            {
                "collectionDate":"2024-04-03T22:36:15Z",
                "processSamples":[
                    {
                        "cpuPercent":"0.11647919565439224",
                        "idlePercent":"99.8835220336914",
                        "process":{
                            "bytesReceived":"20",
                            "state":{
                                "detail":"IDLE",
                                "status":"idle"
                            },
                            "type":"reader"
                        },
                        "processId":"6143",
                        "sessionId":"4600"
                    },
                    {
                        "cpuPercent":"0.005417629145085812",
                        "idlePercent":"99.99456787109376",
                        "process":{
                            "messagesReceived":"0",
                            "state":{
                                "detail":"Waiting for message from client",
                                "status":"waiting"
                            },
                            "transactionsReceived":"0",
                            "type":"receiver"
                        },
                        "processId":"6137",
                        "sessionId":"4116",
                        "topEvent":"[Network] SQL*Net message to client",
                        "topEventPercent":"0.000009995625987357926"
                    },
                    {
                        "cpuPercent":"0",
                        "idlePercent":"100",
                        "process":{
                            "state":{
                                "detail":"IDLE",
                                "status":"idle"
                            },
                            "transactionsApplied":"0",
                            "type":"coordinator"
                        },
                        "processId":"6141",
                        "sessionId":"4480"
                    },
                    {
                        "cpuPercent":"0.0009961500763893127",
                        "idlePercent":"99.99900817871094",
                        "process":{
                            "messagesApplied":"0",
                            "state":{
                                "detail":"IDLE",
                                "status":"idle"
                            },
                            "type":"applier"
                        },
                        "processId":"6145",
                        "sessionId":"4723"
                    },
                    {
                        "cpuPercent":"0.0008789592538960278",
                        "idlePercent":"99.9991226196289",
                        "process":{
                            "messagesApplied":"0",
                            "state":{
                                "detail":"IDLE",
                                "status":"idle"
                            },
                            "type":"applier"
                        },
                        "processId":"6147",
                        "sessionId":"4843"
                    },
                    {
                        "cpuPercent":"0.0010872278362512589",
                        "idlePercent":"99.99891662597656",
                        "process":{
                            "messagesApplied":"0",
                            "state":{
                                "detail":"IDLE",
                                "status":"idle"
                            },
                            "type":"applier"
                        },
                        "processId":"6149",
                        "sessionId":"4965"
                    },
                    {
                        "cpuPercent":"0.0012499920558184383",
                        "idlePercent":"99.99874877929688",
                        "process":{
                            "messagesApplied":"0",
                            "state":{
                                "detail":"IDLE",
                                "status":"idle"
                            },
                            "type":"applier"
                        },
                        "processId":"6151",
                        "sessionId":"5084"
                    }
                ]
            }
        ],
        "started":"2024-04-03T22:35:30Z",
        "status":"running"
    }
}
Back to Top