1. RESTful Server Configuration Management Interface for Oracle WebLogic Server
  2. Tasks
  3. Virtual Host

View This Virtual Host Collection

get

/management/weblogic/{version}/serverConfig/virtualHosts

View this virtual host collection.

Request

Path Parameters
Query Parameters
  • 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.
  • 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.
  • 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.
  • 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
Back to Top

Response

Supported Media Types

200 Response

Returns a list of virtual host entities.

Body ()
Root Schema : Items
Type: array
Title: Items
Show Source
Nested Schema : Virtual Host
Type: object
Show Source
  • Default Value: false

    Indicates whether this server allows the inclusion of the context path in the virtual path to context.getRealPath(). (If checked, you cannot use sub directories with the same name as contextPath). This is a compatibility switch that will be deprecated 9.0.0.0 in future releases.

    Gets the acceptContextPathInGetRealPath attribute of the WebServerMBean object

  • Default Value: true

    Whether authcookie feature is enabled or not.

  • Default Value: false

    Indicates whether the use of Chunk Transfer-Encoding in HTTP/1.1 is enabled.

  • Get the Client IP Header from WebSerevrMBean.

  • Returns the original context-root for the default Web application for this Web server. Alternatively, you can use the context-root attributes in application.xml or weblogic.xml to set a default Web application. The context-root for a default Web application is /. If "" (empty string) is specified, the Web server defaults to /.

  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 1000

    A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

    For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

    Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

  • Read Only: true
    Default Value: false

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

  • Default Value: oracle.doceng.json.BetterJsonNull@3c1fe350

    The name of the host to which all redirected URLs will be sent. If specified, WebLogic Server will use this value rather than the one in the HOST header.

    Sets the HTTP frontendHost Provides a method to ensure that the webapp will always have the correct HOST information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place.

  • Default Value: 0

    The name of the HTTP port to which all redirected URLs will be sent. If specified, WebLogic Server will use this value rather than the one in the HOST header.

    Sets the frontendHTTPPort Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place.

  • Default Value: 0

    The name of the secure HTTP port to which all redirected URLs will be sent. If specified, WebLogic Server will use this value rather than the one in the HOST header.

    Sets the frontendHTTPSPort Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place.

  • Minimum Value: 30
    Maximum Value: 360
    Default Value: 60

    The amount of time this server waits before closing an inactive HTTPS connection.

    Number of seconds to maintain HTTPS keep-alive before timing out the request.

  • Read Only: true

    Return the unique id of this MBean instance

  • Default Value: true

    Indicates whether there should be a persistent connection to this server. (This may improve the performance of your Web applications.)

    Gets the keepAliveEnabled attribute of the WebServerMBean object

  • Minimum Value: 5
    Maximum Value: 3600
    Default Value: 30

    The amount of time this server waits before closing an inactive HTTP connection.

    Number of seconds to maintain HTTP keep-alive before timing out the request.

  • Default Value: -1

    The maximum post size this server allows for reading HTTP POST and PUT data in a servlet request.

    A value less than 0 indicates an unlimited size.

    Gets the maxPostSize attribute of the WebServerMBean object

  • Default Value: -1

    Max Post Time (in seconds) for reading HTTP POST data in a servlet request. MaxPostTime < 0 means unlimited

    Gets the maxPostTimeSecs attribute of the WebServerMBean object

  • Default Value: 10000

    Max Request Parameter Count this server allows for reading maximum HTTP POST Parameters count in a servlet request.

    Gets the maxRequestParameterCount attribute of the WebServerMBean object

  • Default Value: -1

    The maximum size of a single header (name and value) that this server allows in a servlet request.

    A value less than 0 indicates an unlimited size.

    Gets the maxSingleHeaderSize attribute of the WebServerMBean object.

  • Default Value: 131072

    The maximum total headers size this server allows for reading HTTP headers in a servlet request.

    A value less than 0 indicates an unlimited size.

    Gets the maxTotalHeadersSize attribute of the WebServerMBean object.

  • 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

  • The dedicated server channel name (NetworkAccessPoint) for which this virtual host will serve http request. If the NetworkAccessPoint for a given http request doesn't match any virtual host's NetworkAccessPoint, incoming HOST header will be matched with the VirtualHostNames in order to resolve the right virtual host.

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

  • Minimum Value: 100
    Maximum Value: 599
    Default Value: 503

    Get the response code to be used when an application is overloaded. An application can get overloaded when the number of pending requests has reached the max capacity specified in the WorkManager or when the server is low on memory. The low memory condition is determined using OverloadProtectionMBean#getFreeMemoryPercentLowThreshold().

  • Minimum Value: 0
    Maximum Value: 120
    Default Value: 30

    Timeout (in seconds) for reading HTTP POST data in a servlet request. If the POST data is chunked, the amount of time the server waits between the end of receiving the last chunk of data and the end of receiving the next chunk of data in an HTTP POST before it times out. (This is used to prevent denial-of-service attacks that attempt to overload the server with POST data.)

    Gets the postTimeoutSecs attribute of the WebServerMBean object

  • Default Value: false

    Indicates whether this server name is sent with the HTTP response. (This is useful for wireless applications where there is limited space for headers.)

    Indicates whether this server instance includes its name and WebLogic Server version number in HTTP response headers.

  • Default Value: false

    Indicates whether the singleSignonDisabled attribute is enabled

  • Items
    Title: Items

    Return all tags on this Configuration MBean

  • Target References
    Title: Target References
    Contains the array of target references.

    You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

  • Read Only: true

    Returns the type of the MBean.

    Constraints

    • unharvestable
  • Default Value: false
  • Default Value: true

    Enables use of the highest compatible HTTP protocol version-string in the response. E.g. HTTP spec suggests that HTTP/1.1 version-string should be used in response to a request using HTTP/1.0. This does not necessarily affect the response format.

  • Items
    Title: Items

    The list of host names, separated by line breaks, for which this virtual host will serve requests.

  • Default Value: false

    Indicates whether the session ID should include JVM information. (Checking this box may be necessary when using URL rewriting with WAP devices that limit the size of the URL to 128 characters, and may also affect the use of replicated sessions in a cluster.) When this box is selected, the default size of the URL will be set at 52 characters, and it will not contain any special characters.

    Gets the WAPEnabled attribute of the WebServerMBean object

  • Read Only: true
    Default Value: 512

    The default size of the blocks to be written to the network layer.

    Gets the writeChunkBytes attribute of the WebServerMBean object

Nested Schema : Items
Type: array
Title: Items

Return all tags on this Configuration MBean

Show Source
Nested Schema : Target References
Type: array
Title: Target References
Contains the array of target references.

You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

Show Source
Nested Schema : Items
Type: array
Title: Items

The list of host names, separated by line breaks, for which this virtual host will serve requests.

Show Source
Nested Schema : Target Reference
Type: object
Title: Target Reference
Contains the target reference.
Show Source
  • Identity
    Title: Identity
    DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
Nested Schema : Identity
Type: array
Title: Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
Show Source
Back to Top