Jump to

• Request
• Response

Update Server Log Configuration

patch

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

Required Role: Administrator, SuperUser, CommandLineOperator

Update Server Log Configuration

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - 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
  description: | Comma-separated key/value pairs of log components and their levels. Possible components include: `oracle.veridata.server.performance`, `oracle.veridata.server` Possible levels include: `ALL`, `SEVERE`, `WARNING`, `INFO`, `FINE`, `FINER`, `FINEST` Example: `oracle.veridata.server.performance=FINEST, oracle.veridata.server=ALL`
• logHandlers: string
  Comma-separated list of log handlers. Possible handlers include: `FileHandler`, `ConsoleHandler`

{
    "type":"object",
    "properties":{
        "level":{
            "type":"string",
            "description":"Log level",
            "enum":[
                "ALL",
                "SEVERE",
                "WARNING",
                "INFO",
                "FINE",
                "FINER",
                "FINEST"
            ]
        },
        "logComponents":{
            "type":"string",
            "description":"description: |\n  Comma-separated key/value pairs of log components and their levels.\n  Possible components include: `oracle.veridata.server.performance`, `oracle.veridata.server`\n  Possible levels include: `ALL`, `SEVERE`, `WARNING`, `INFO`, `FINE`, `FINER`, `FINEST`\n  Example: `oracle.veridata.server.performance=FINEST, oracle.veridata.server=ALL`\n"
        },
        "logHandlers":{
            "type":"string",
            "description":"Comma-separated list of log handlers.  \nPossible handlers include: `FileHandler`, `ConsoleHandler`\n"
        }
    },
    "example":{
        "level":"WARNING",
        "logHandlers":"FileHandler, ConsoleHandler",
        "logComponents":"oracle.veridata.server.performance=FINEST, oracle.veridata.server=ALL"
    },
    "required":[
        "level"
    ]
}

Example:

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Updated Server log configurations successfully

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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

Back to Top