1. RESTful Edit Management Interface for Oracle WebLogic Server
  2. Tasks
  3. Cluster

View This Cluster

get

/management/weblogic/{version}/edit/clusters/{name}

View this cluster.

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 '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.
Security
Back to Top

Response

Supported Media Types

200 Response

Returns this cluster.

This method can return the following links:

  • rel=JTACluster uri=/management/weblogic/{version}/edit/clusters/{name}/JTACluster

    This resource's JTACluster singleton resource.

  • rel=coherenceClusterSystemResource

    This resource's coherenceClusterSystemResource reference to a coherence cluster system resource resource.

  • rel=coherenceTier uri=/management/weblogic/{version}/edit/clusters/{name}/coherenceTier

    This resource's coherenceTier singleton resource.

  • rel=dataSourceForAutomaticMigration

    This resource's dataSourceForAutomaticMigration reference to a JDBC system resource resource.

  • rel=dataSourceForJobScheduler

    This resource's dataSourceForJobScheduler reference to a JDBC system resource resource.

  • rel=dataSourceForSessionPersistence

    This resource's dataSourceForSessionPersistence reference to a JDBC system resource resource.

  • rel=databaseLessLeasingBasis uri=/management/weblogic/{version}/edit/clusters/{name}/databaseLessLeasingBasis

    This resource's databaseLessLeasingBasis singleton resource.

  • rel=dynamicServers uri=/management/weblogic/{version}/edit/clusters/{name}/dynamicServers

    This resource's dynamicServers singleton resource.

  • rel=overloadProtection uri=/management/weblogic/{version}/edit/clusters/{name}/overloadProtection

    This resource's overloadProtection singleton resource.

Body ()
Root Schema : Cluster
Type: object
Show Source
  • Default Value: 3

    A migratable server could fail to come up on every possible configured machine. This attribute controls how many further attempts, after the first one, should be tried.

    Note that each attempt specified here indicates another full circuit of migrations amongst all the configured machines. So for a 3-server cluster, and the default value of 3, a total of 9 migrations will be attempted.

    If it is set to -1, migrations will go on forever until the server starts.

  • Default Value: 30

    Interval in seconds until the producer thread will wait for the AsyncSessionQueue to become unblocked. Should be similar to the RequestTimeOut as that will determine the longest that the queue should remain full.

  • Default Value: ACTIVE

    Return the name of the table to be used for server migration.

  • Machine References
    Title: Machine References
    Contains the array of machine references.

    The set of machines (and order of preference) on which Node Manager will restart failed servers. (Requires you to enable each server for automatic migration.)

    Each server can specify a subset of these cluster-wide candidates, which limits the machines on which the server can be restarted. Servers can also specify their own order of preference.

    Constraints

    • restart required
  • Default Value: false

    Specifies whether to honor the WL-Proxy-Client-Cert header coming with the request or not.

    Constraints

    • secure default : false

  • The address that forms a portion of the URL a client uses to connect to this cluster, and that is used for generating EJB handles and entity EJB failover addresses. (This address may be either a DNS host name that maps to multiple IP addresses or a comma-separated list of single address host names or IP addresses.)

    Defines the address to be used by clients to connect to this cluster. This address may be either a DNS host name that maps to multiple IP addresses or a comma separated list of single address host names or IP addresses. If network channels are configured, it is possible to set the cluster address on a per channel basis.

  • Specifies the channel used to handle communications within a cluster. If no channel is specified the default channel is used.

    ClusterBroadcastChannel is only are supported if the unicast messaging type is used.

  • Default Value: unicast
    Allowed Values: [ "multicast", "unicast" ]

    Specifies the messaging type used in the cluster.

    Multicast messaging is provided for backwards compatibility.

  • Default Value: none
    Allowed Values: [ "none", "wan", "man" ]

    Optimizes cross-cluster replication for the type of network that servers in the clusters use for administrative communication.

    To enhance the reliability of HTTP sessions, you can configure servers in one cluster to replicate the session data to servers in a different cluster. In such an environment, configure the clusters to be one of the following types:

    • man

      If the clustered servers can send their data through a metro area network (man) in which latency is negligible. With this ClusterType value, servers replicate session state synchronously and in memory only. For example, when serverA in cluster1 starts an HTTP session, its backup server, serverB in cluster2, immediately replicates this session in memory to Server B.

    • wan

      If the clusters are far apart or send their data through a wide area network (wan) that experiences significant network latency. With this ClusterType value, a server replicates session state synchronously to the backup server in the same cluster and asynchronously to a server in the remote cluster. For example, when serverA in cluster1 starts an HTTP session, it sends the data to serverB in cluster1 and then asynchronously sends data to serverX in cluster 2. ServerX will persist the session state in the database.

      If you persist session data in a replicating database, and if you prefer to use the database to replicate the data instead of WebLogic Server, choose a cluster type of wan and leave the remote cluster address undefined. WebLogic Server saves the session data to the local database and assumes that the database replicates data as needed.

  • Coherence Cluster System Resource Reference
    Title: Coherence Cluster System Resource Reference
    Contains the coherence cluster system resource reference.

    Coherence Cluster associated with this cluster.

    Constraints

    • restart required
  • Default Value: false

    Specifies whether to allow the concurrent activation, deactivation, or restart of two or more singleton services.

  • Minimum Value: 1
    Default Value: 1

    The maximum number of times Database Leasing will try to obtain a valid connection from the Data Source.

  • Default Value: 1000

    The length of time, in milliseconds,Database Leasing will wait before attempting to obtain a new connection from the Data Source when a connection has failed.

  • JDBC System Resource Reference
    Title: JDBC System Resource Reference
    Contains the JDBC system resource reference.

    The data source used by servers in the cluster during migration. (You must configure each Migratable Server within the cluster to use this data source.)

    Constraints

    • restart required
  • JDBC System Resource Reference
    Title: JDBC System Resource Reference
    Contains the JDBC system resource reference.

    Data source required to support persistence of jobs scheduled with the job scheduler

    Constraints

    • restart required
  • JDBC System Resource Reference
    Title: JDBC System Resource Reference
    Contains the JDBC system resource reference.

    To support HTTP Session failover across data centers, a datasource is required to dump session state on disk.

    Constraints

    • restart required
  • Default Value: round-robin
    Allowed Values: [ "round-robin", "weight-based", "random", "round-robin-affinity", "weight-based-affinity", "random-affinity" ]

    Defines the algorithm to be used for load-balancing between replicated services if none is specified for a particular service. The round-robin algorithm cycles through a list of WebLogic Server instances in order. Weight-based load balancing improves on the round-robin algorithm by taking into account a pre-assigned weight for each server. In random load balancing, requests are routed to servers at random.

  • Read Only: true
    Default Value: false

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

  • Default Value: 30000

    During automatic migration, if the Cluster Master determines a server to be dead, it waits for this period of time (in milliseconds) before the Cluster Master migrates the service to another server in the cluster.

  • Default Value: oracle.doceng.json.BetterJsonNull@212a3f47

    The name of the host to which all redirected URLs will be sent.

    Sets the HTTP FrontendHost for the default webserver (not virtual hosts) for all the servers in the cluster. 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, when constructing the absolute urls for redirects.

  • Default Value: 0

    The name of the HTTP port to which all redirected URLs will be sent.

    Sets the FrontendHTTPPort for the default webserver (not virtual hosts) for all the servers in the cluster. 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, when constructing the absolute urls for redirects.

  • Default Value: 0

    The name of the secure HTTP port to which all redirected URLs will be sent.

    Sets the FrontendHTTPSPort for the default webserver (not virtual hosts) for all the servers in the cluster. 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, when constructing the absolute urls for redirects.

  • Default Value: 3

    Interval in seconds until HTTP Sessions are periodically flushed to secondary server.

  • Default Value: 10000

    Interval in milliseconds at which Migratable Servers and Cluster Masters prove their liveness via the database.

  • Minimum Value: 2
    Default Value: 3

    Maximum number of periods that a cluster member will wait before timing out a Cluster Master and also the maximum number of periods the Cluster Master will wait before timing out a Migratable Server.

  • Default Value: false

    Returns the value of HttpTraceSupportEnabled.

  • Read Only: true

    Return the unique id of this MBean instance

  • Minimum Value: 3
    Default Value: 3

    Maximum number of periods that a cluster member will wait before timing out a member of a cluster.

    Maximum number of periods that a cluster member will wait before timing out a member of a cluster.

  • Default Value: 30000

    If the cluster link between two clusters goes down, a trigger will run periodically to see if the link is restored. The duration is specified in milliseconds.

  • Default Value: WEBLOGIC_TIMERS

    The table name to use for storing timers active with the job scheduler

  • Default Value: false

    Enables faster Automatic Service Migration times with Database Leasing Basis.

  • Minimum Value: 0

    Maximum number of seconds that a cluster member will wait to discover and synchronize with other servers in the cluster. Normally, the member will be able to sync in 30 seconds. If the value of this attribute is higher, that does not necessarily mean that it will take longer for the member to warmup. Instead it defines an upper bound on the time that a server will wait to sync with the servers that it has discovered. If the value is set 0, servers will not attempt to discover other running server in the cluster during server initialization

  • Default Value: true

    Forces unicast messages to be processed in order. There are scenarios where JMS may update JNDI very frequently. It will result in a lot of messages over unicast. Due to the close proximity of messages the probability of out of order handling of messages increases which would trigger frequent state dumps. Frequent JNDI tree refresh may result in NameNotFoundException. Use this property to prevent out of order handling of messages.

  • Migratable Target References
    Title: Migratable Target References
    Read Only: true
    Contains the array of migratable target references.

    Returns all the MigratableTargets for this cluster

  • Default Value: database
    Allowed Values: [ "database", "consensus" ]

    Controls the mechanism used for server and service migration.

    • Database -- Requires the availability of a high-availability database, such as Oracle RAC, to store leasing information.

    • Consensus -- Stores the leasing information in-memory within a cluster member. This option requires Node Manager to be configured and running.

    Note: Within a WebLogic Server installation, you can only use one type of leasing. Although it is possible to implement multiple features that use leasing within your environment, each must use the same kind of leasing.

  • Default Value: 180000

    Controls how long of a pause there should be between the migration attempts described in getAdditionalAutoMigrationAttempts(). Note that this delay only happens when the server has failed to come up on every machine.

  • Default Value: 239.192.0.0

    The multicast address used by cluster members to communicate with each other.

    The valid range is from from 224.0.0.0 to 239.255.255.255. The default value used by WebLogic Server is 239.192.0.0. You should avoid using multicast addresses in the range x.0.0.1

    This address should be unique to this cluster and should not be shared by other applications.

  • Minimum Value: 64
    Default Value: 64

    The multicast socket send/receive buffer size (at least 64 kilobytes).

    Returns the multicast socket send/receive buffer size.

  • Default Value: false

    Enables multicast data to be encrypted. Only the multicast data is encrypted. Multicast header information is not encrypted.

  • Minimum Value: 1
    Maximum Value: 65535
    Default Value: 7001

    The multicast port (between 1 and 65535) used by cluster members to communicate with each other.

    Defines the multicast port used by cluster members to communicate with each other.

  • Minimum Value: 0
    Maximum Value: 250
    Default Value: 3

    The amount of time (between 0 and 250 milliseconds) to delay sending message fragments over multicast in order to avoid OS-level buffer overflow.

    Defines the number of milliseconds to delay sending message fragments over multicast in order to avoid OS-level buffer overflow.

  • Minimum Value: 1
    Maximum Value: 255
    Default Value: 1

    The number of network hops (between 1 and 255) that a cluster multicast message is allowed to travel.

    Defines the number of network hops that a cluster multicast message is allowed to travel. 1 restricts the cluster to one subnet.

  • 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

  • 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: 1
    Default Value: 3

    Number of servers to be listed from this cluster when generating a cluster address automatically. This setting has no effect if Cluster Address is explicitly set.

  • Default Value: false

    Indicates if one-way RMI is being used for replication. One-way RMI also requires configuring replication ports on each server in the cluster.

  • When shutting down servers, sessions are not updated. If the primary and secondary servers of a session are shut down with no session updates, the session will be lost. Turning on PersistSessionsOnShutdown will save any active sessions to the database specified in ClusterMBean#getDataSourceForSessionPersistence() when a server is shutdown. The sessions will not be written at any other time. (For example, they are not saved via this mechanism if there is a server crash.)

    This attribute is applicable both to session persistence on server shutdown or session persistence across a WAN.

    Rolling upgrade can potentially have a bad interaction with traditional in-memory session replication. As managed servers are shutdown and upgraded, in-memory servlet sessions will be lost if both primary and secondary are rebooted before a new request arrives for the session.

  • Set the foreign cluster. Cluster infrastructure uses this address to connect to foreign cluster for HTTP Session WAN/MAN failover.

  • Default Value: ReplicationChannel

    The channel name to be used for replication traffic. Cluster infrastructure uses this channel to send updates for HTTP sessions and stateful session beans. If none is set then the default channel will be used.

    In order for this feature to work, the named channel must exist on all members of the cluster and must be configured to use the same protocol. It is valid for the selected channel to be configured to use a secure protocol.

  • Default Value: true

    Indicates if timeout should be applied to session replication calls.

  • Default Value: false

    Servers in a cluster replicate session data. If a replication channel is defined then the session data will be sent using the replication channel protocol and secured replication settings will be ignored. If no replication channel is defined and secured replication is enabled then session data for in-memory replication will be sent over SSL using the default secured channel. However, this added security for replication traffic comes with a significant cluster performance degradation. It should only be enabled if security is of greater concern than performance degradation.

    Constraints

    • secure default : true
  • Server References
    Title: Server References
    Read Only: true
    Contains the array of server references.

    The servers which have declared membership in this cluster.

  • Default Value: 0

    The maximum time, in milliseconds seconds, for services to wait for response from cluster members.

  • Minimum Value: 0
    Maximum Value: 65534
    Default Value: 180

    The number of seconds (between 0 and 65534) by which the age of two conflicting services must differ before one is considered older than the other.

    Defines the number of seconds by which the age of two conflicting services must differ before one is considered older than the other.

  • Default Value: 180

    Interval in seconds until HTTP Sessions are periodically flushed to the backup cluster to dump session state on disk.

  • Default Value: 10000

    When number of sessions to be flushed reaches this threshold limit, sessions will be flushed to the backup cluster before the flush interval. This helps the server to flush sessions faster under load.

  • Enables increased efficiency with session replication. Enabling this attribute should be used only when configuring a WebLogic domain for Oracle Exalogic.

  • Default Value: false

    Indicates if session state query protocol is enabled. The Session State Query protocol will query the local cluster for the location of a session state instance if a request arrives at a server that is neither the primary or secondary server.

  • Minimum Value: 1
    Default Value: 30

    The maximum time, in seconds, for session state query request to wait for response from cluster members.

  • Default Value: 30000

    The maximum time, in milliseconds, for service activation requests will wait for response from cluster members.

    A value of means that the request will wait indefinitely to complete.

  • The name of the site this cluster is associated with.

  • Items
    Title: Items

    Return all tags on this Configuration MBean

  • Default Value: false

    If enabled, a server's transaction requests go to servers in the cluster that are already participating in the global transaction.

  • Read Only: true

    Returns the type of the MBean.

    Constraints

    • unharvestable
  • Default Value: 15000

    The specified read timeout, in milliseconds, on a unicast connection. A timeout of zero is interpreted as an infinite timeout, that is blocking read forever.

  • Default Value: WLS_WAN_PERSISTENCE_TABLE

    Return the name of the table to be used for WAN session persistence.

  • Default Value: false

    Specifies if this cluster will receive requests from a proxy plug-in or HttpClusterServlet

    Set this attribute to true if the cluster will receive requests from a proxy plug-in or HttpClusterServlet. A call to getRemoteAddr will return the address of the browser client from the proprietary WL-Proxy-Client-IP header instead of the Web server.

    Set this attribute to false to disable the weblogic-plugin-enabled parameter, weblogic-plugin-enabled=false, in the config.xmlfile.

    Note: If you are using Oracle HTTP Server, the WebLogic Proxy Plug-In, or Oracle Traffic Director to distribute client requests to a Managed Server or a cluster, Oracle recommends setting this attribute to true

    Constraints

    • secure default : false
Nested Schema : Machine References
Type: array
Title: Machine References
Contains the array of machine references.

The set of machines (and order of preference) on which Node Manager will restart failed servers. (Requires you to enable each server for automatic migration.)

Each server can specify a subset of these cluster-wide candidates, which limits the machines on which the server can be restarted. Servers can also specify their own order of preference.

Constraints

  • restart required
Show Source
Nested Schema : Coherence Cluster System Resource Reference
Type: array
Title: Coherence Cluster System Resource Reference
Contains the coherence cluster system resource reference.

Coherence Cluster associated with this cluster.

Constraints

  • restart required
Show Source
Nested Schema : JDBC System Resource Reference
Type: array
Title: JDBC System Resource Reference
Contains the JDBC system resource reference.

The data source used by servers in the cluster during migration. (You must configure each Migratable Server within the cluster to use this data source.)

Constraints

  • restart required
Show Source
Nested Schema : JDBC System Resource Reference
Type: array
Title: JDBC System Resource Reference
Contains the JDBC system resource reference.

Data source required to support persistence of jobs scheduled with the job scheduler

Constraints

  • restart required
Show Source
Nested Schema : JDBC System Resource Reference
Type: array
Title: JDBC System Resource Reference
Contains the JDBC system resource reference.

To support HTTP Session failover across data centers, a datasource is required to dump session state on disk.

Constraints

  • restart required
Show Source
Nested Schema : Migratable Target References
Type: array
Title: Migratable Target References
Read Only: true
Contains the array of migratable target references.

Returns all the MigratableTargets for this cluster

Show Source
Nested Schema : Server References
Type: array
Title: Server References
Read Only: true
Contains the array of server references.

The servers which have declared membership in this cluster.

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

Return all tags on this Configuration MBean

Show Source
Nested Schema : Machine Reference
Type: object
Title: Machine Reference
Contains the machine reference.
Show Source
Nested Schema : Identity
Type: array
Title: Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
Show Source
Nested Schema : Migratable Target Reference
Type: object
Title: Migratable Target Reference
Contains the migratable target reference.
Show Source
Nested Schema : Identity
Type: array
Title: Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
Show Source
Nested Schema : Server Reference
Type: object
Title: Server Reference
Contains the server reference.
Show Source
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