REST API for GoldenGate Veridata

Update Server Log Configurations

patch

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

Required Role: Administrator, SuperUser, CommandLineOperator

Update Server Log configurations.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

level(required): string

Allowed Values: [ "ALL", "SEVERE", "WARNING", "INFO", "FINE", "FINER", "FINEST" ]

Log level
logComponents: string

Specific component settings, provided as a comma-separated key/value pair
logHandlers: string

Specific handler settings, provided as a comma-separated key/value pair

{
    "type":"object",
    "properties":{
        "level":{
            "type":"string",
            "description":"Log level",
            "enum":[
                "ALL",
                "SEVERE",
                "WARNING",
                "INFO",
                "FINE",
                "FINER",
                "FINEST"
            ]
        },
        "logComponents":{
            "type":"string",
            "description":"Specific component settings, provided as a comma-separated key/value pair\n"
        },
        "logHandlers":{
            "type":"string",
            "description":"Specific handler settings, provided as a comma-separated key/value pair\n"
        }
    },
    "example":{
        "level":"WARNING",
        "logHandlers":"FileHandler",
        "logComponents":"oracle.veridata.server.performance=FINEST, oracle.veridata.server=ALL"
    },
    "required":[
        "level"
    ]
}

Example:

{
    "level":"WARNING",
    "logHandlers":"FileHandler",
    "logComponents":"oracle.veridata.server.performance=FINEST, oracle.veridata.server=ALL"
}

Response

Supported Media Types

application/json

200 Response

Updated Server log configurations successfully.

Root Schema : ServerLogConfigUpdateResponse

Type: object

Show Source

logLevel: string

Updated log level
message: string

Confirmation message.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Confirmation message."
        },
        "logLevel":{
            "type":"string",
            "description":"Updated log level"
        }
    },
    "example":{
        "message":"Successfully set the log level!",
        "logLevel":"FINE"
    }
}

Example:

{
    "message":"Successfully set the log level!",
    "logLevel":"FINE"
}

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"
}