Jump to

• Request
• Response

View This Web Server Log

get

/management/weblogic/{version}/serverConfig/serverTemplates/{name}/webServer/webServerLog

View this web server log.

Request

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Query Parameters

• excludeFields(optional): string
  The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
• excludeLinks(optional): string
  The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
• fields(optional): string
  The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
• links(optional): string
  The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.
• Monitor: basic
  Type: basic

  Description: A user in the Monitor security role.
• Operator: basic
  Type: basic

  Description: A user in the Operator security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this web server log.

Body ()

Root Schema : Web Server Log

Type: object

Show Source

• bufferSizeKB(optional): integer(int32)
  Default Value: 8

  Gets the underlying log buffer size in kilobytes

• dateFormatPattern(optional): string

  The date format pattern used for rendering dates in the log. The DateFormatPattern string conforms to the specification of the java.text.SimpleDateFormat class.

  Constraints

  • legal null
• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

  Return whether the MBean was created dynamically or is persisted to config.xml

• ELFFields(optional): string
  Default Value: date time cs-method cs-uri sc-status

  Returns the list of fields specified for the extended logging format for access.log.

• fileCount(optional): integer(int32)
  Minimum Value: 1

  Maximum Value: 99999

  Default Value: 7

  The maximum number of log files that the server creates when it rotates the log. This number does not include the file that the server uses to store current messages. (Requires that you enable Number of Files Limited.)

  Constraints

  • production mode default : 100
• fileMinSize(optional): integer(int32)
  Minimum Value: 1

  Maximum Value: 2097150

  Default Value: 500

  The size (1 - 2097150 kilobytes) that triggers the server to move log messages to a separate file. The default is 500 kilobytes. After the log file reaches the specified minimum size, the next time the server checks the file size, it will rename the current log file as SERVER_NAME.lognnnnn and create a new one to store subsequent messages. (Requires that you specify a file rotation type of Size.)

  Constraints

  • production mode default : 5000
• fileName(optional): string

  The name of the log file.

• fileTimeSpan(optional): integer(int32)
  Minimum Value: 1

  Default Value: 24

  The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a file rotation type of TIME.)

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

• logFileFormat(optional): string
  Default Value: common

  Allowed Values: [ "common", "extended" ]

  The format of the HTTP log file. Both formats are defined by the W3C. With the extended log format, you use server directives in the log file to customize the information that the server records.

• logFileRotationDir(optional): string

  The directory where the rotated log files will be stored. By default the rotated files are stored in the same directory where the log file is stored.

• loggingEnabled(optional): boolean
  Default Value: true

  Indicates whether this server logs HTTP requests. (The remaining fields on this page are relevant only if you select this check box.)

  Gets the loggingEnabled attribute of the WebServerMBean object.

  Constraints

  • secure default : true
• logTimeInGMT(optional): boolean
  Default Value: false

  Specifies whether the time stamps for HTTP log messages are in Greenwich Mean Time (GMT) regardless of the local time zone that the host computer specifies.

  Use this method to comply with the W3C specification for Extended Format log files. The specification states that all time stamps for Extended Format log entries be in GMT.

  This method applies only if you have specified the extended message format.

• name(optional): string
  Read Only: true

  The user-specified name of this MBean instance.

  This name is included as one of the key properties in the MBean's javax.management.ObjectName

  Name=user-specified-name

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this configuration.

  WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

  Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• numberOfFilesLimited(optional): boolean
  Default Value: true

  Indicates whether to limit the number of log files that this server instance creates to store old messages. (Requires that you specify a file rotation type of SIZE or TIME.)

  After the server reaches this limit, it deletes the oldest log file and creates a new log file with the latest suffix.

  If you do not enable this option, the server creates new files indefinitely and you must clean up these files as you require.

  Constraints

  • production mode default : true
• rotateLogOnStartup(optional): boolean
  Default Value: true

  Specifies whether a server rotates its log file during its startup cycle. The default value in production mode is false.

  Constraints

  • production mode default : false
• rotationTime(optional): string
  Default Value: 00:00

  Determines the start time (hour and minute) for a time-based rotation sequence.

  At the time that this value specifies, the server renames the current log file. Thereafter, the server renames the log file at an interval that you specify in File Time Span.

  Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.

  Use the following format: H:mm, where

  • is Hour in day (0-23)

  • mm is the minute in hour

• rotationType(optional): string
  Default Value: bySize

  Allowed Values: [ "bySize", "byTime", "none", "bySizeOrTime" ]

  Criteria for moving old log messages to a separate file.

  • NONE Messages accumulate in a single file. You must erase the contents of the file when the size is too large. Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.

  • SIZE When the log file reaches the size that you specify in FileMinSize, the server renames the file as SERVER_NAME.lognnnnn

  • TIME At each time interval that you specify in TimeSpan, the server renames the file as SERVER_NAME.lognnnnn

  After the server renames a file, subsequent messages accumulate in a new file with the name that you specified as the log file name.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "ELFFields":{
            "default":"date time cs-method cs-uri sc-status",
            "type":"string",
            "description":"<p>Returns the list of fields specified for the <code>extended</code> logging format for access.log. </p>"
        },
        "bufferSizeKB":{
            "default":8,
            "type":"integer",
            "format":"int32",
            "description":"<p>Gets the underlying log buffer size in kilobytes</p>"
        },
        "dateFormatPattern":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The date format pattern used for rendering dates in the  log. The DateFormatPattern string conforms to the specification of the <code>java.text.SimpleDateFormat</code> class.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "fileCount":{
            "default":7,
            "x-weblogic-productionDefault":100,
            "minimum":1,
            "maximum":99999,
            "type":"integer",
            "format":"int32",
            "description":"<p>The maximum number of log files that the server creates when it rotates the log. This number does not include the file that the server uses to store current messages. (Requires that you enable Number of Files Limited.)</p><p><h5>Constraints</h5></p><ul><li>production mode default : 100</li></ul>"
        },
        "fileMinSize":{
            "default":500,
            "x-weblogic-productionDefault":5000,
            "minimum":1,
            "maximum":2097150,
            "type":"integer",
            "format":"int32",
            "description":"<p>The size (1 - 2097150 kilobytes) that triggers the server to move log messages to a separate file. The default is 500 kilobytes. After the log file reaches the specified minimum size, the next time the server checks the file size, it will rename the current log file as <code><i>SERVER_NAME</i>.log<i>nnnnn</i></code> and create a new one to store subsequent messages. (Requires that you specify a file rotation type of <code>Size</code>.)</p><p><h5>Constraints</h5></p><ul><li>production mode default : 5000</li></ul>"
        },
        "fileName":{
            "type":"string",
            "description":"<p>The name of the log file.</p>"
        },
        "fileTimeSpan":{
            "default":24,
            "minimum":1,
            "type":"integer",
            "format":"int32",
            "description":"<p>The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a file rotation type of <code>TIME</code>.)</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "logFileFormat":{
            "default":"common",
            "enum":[
                "common",
                "extended"
            ],
            "type":"string",
            "description":"<p>The format of the HTTP log file. Both formats are defined by the W3C. With the extended log format, you use server directives in the log file to customize the information that the server records.</p>"
        },
        "logFileRotationDir":{
            "type":"string",
            "description":"<p>The directory where the rotated log files will be stored. By default the rotated files are stored in the same directory where the log file is stored.</p>"
        },
        "logTimeInGMT":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether the time stamps for HTTP log messages are in Greenwich Mean Time (GMT) regardless of the local time zone that the host computer specifies.</p><p>Use this method to comply with the W3C specification for Extended Format log files. The specification states that all time stamps for Extended Format log entries be in GMT.</p><p>This method applies only if you have specified the <code>extended</code> message format.</p>"
        },
        "loggingEnabled":{
            "x-weblogic-secureDefault":true,
            "default":true,
            "type":"boolean",
            "description":"<p>Indicates whether this server logs HTTP requests. (The remaining fields on this page are relevant only if you select this check box.)</p><p>Gets the loggingEnabled attribute of the WebServerMBean object.</p><p><h5>Constraints</h5></p><ul><li>secure default : true</li></ul>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "numberOfFilesLimited":{
            "default":true,
            "x-weblogic-productionDefault":true,
            "type":"boolean",
            "description":"<p>Indicates whether to limit the number of log files that this server instance creates to store old messages. (Requires that you specify a file rotation type of <code>SIZE</code> or <code>TIME</code>.)</p><p>After the server reaches this limit, it deletes the oldest log file and creates a new log file with the latest suffix.</p><p>If you do not enable this option, the server creates new files indefinitely and you must clean up these files as you require.</p><p><h5>Constraints</h5></p><ul><li>production mode default : true</li></ul>"
        },
        "rotateLogOnStartup":{
            "default":true,
            "x-weblogic-productionDefault":false,
            "type":"boolean",
            "description":"<p>Specifies whether a server rotates its log file during its startup cycle. The default value in production mode is false.</p><p><h5>Constraints</h5></p><ul><li>production mode default : false</li></ul>"
        },
        "rotationTime":{
            "default":"00:00",
            "type":"string",
            "description":"<p>Determines the start time (hour and minute) for a time-based rotation sequence.</p><p>At the time that this value specifies, the server renames the current log file. Thereafter, the server renames the log file at an interval that you specify in File Time Span.</p><p>Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.</p><p>Use the following format: <code>H:mm</code>, where</p><ul><li><p><code></code> is Hour in day (0-23)</p></li><li><p><code>mm</code> is the minute in hour</p></li></ul>"
        },
        "rotationType":{
            "default":"bySize",
            "enum":[
                "bySize",
                "byTime",
                "none",
                "bySizeOrTime"
            ],
            "type":"string",
            "description":"<p>Criteria for moving old log messages to a separate file.</p><ul><li><p><code>NONE</code> Messages accumulate in a single file. You must erase the contents of the file when the size is too large. Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.</p></li><li><p><code>SIZE</code> When the log file reaches the size that you specify in <code>FileMinSize</code>, the server renames the file as <code><i>SERVER_NAME</i>.log<i>nnnnn</i></code></p></li><li><p><code>TIME</code> At each time interval that you specify in <code>TimeSpan</code>, the server renames the file as <code><i>SERVER_NAME</i>.log<i>nnnnn</i></code></p></li></ul><p>After the server renames a file, subsequent messages accumulate in a new file with the name that you specified as the log file name.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

Back to Top