REST API for GoldenGate Veridata

Retrieve Agent Log Configurations

get

http://{host}:{port}/veridata/v1/services/logs/agents/{Id}/configuration

Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator

Retrieve Agent Log configurations.

Request

Path Parameters

Id(required): integer

Agent ID.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Retrieved agent log configurations successfully.

Root Schema : LogParams

Type: object

Show Source

logParameters: array logParameters

{
    "type":"object",
    "properties":{
        "logParameters":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LogMetadata"
            }
        }
    }
}

Nested Schema : logParameters

Type: array

Show Source

Array of: object LogMetadata

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LogMetadata"
    }
}

Nested Schema : LogMetadata

Type: object

Show Source

defaultLevel: string

The default log level of the log component
description: string

The description of the log component
isDefault: boolean
level: string

The log level of the log component
name: string

The name of the log component
supportedLogLevels: array supportedLogLevels

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the log component"
        },
        "level":{
            "type":"string",
            "description":"The log level of the log component"
        },
        "defaultLevel":{
            "type":"string",
            "description":"The default log level of the log component"
        },
        "description":{
            "type":"string",
            "description":"The description of the log component"
        },
        "isDefault":{
            "type":"boolean"
        },
        "supportedLogLevels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "example":{
        "name":"oracle.veridata",
        "level":"OFF",
        "defaultLevel":"INFO",
        "description":"Veridata logs",
        "isDefault":false,
        "supportedLogLevels":[
            "INFO",
            "FINEST",
            "SEVERE"
        ]
    }
}

Example:

{
    "name":"oracle.veridata",
    "level":"OFF",
    "defaultLevel":"INFO",
    "description":"Veridata logs",
    "isDefault":false,
    "supportedLogLevels":[
        "INFO",
        "FINEST",
        "SEVERE"
    ]
}

Nested Schema : supportedLogLevels

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Bad Request.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 Response

Unauthorized.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 Response

Not Found.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 Response

Server Error.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}