Jump to

• Request
• Response

View This Overload Protection

get

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

View this overload protection.

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 overload protection.

This method can return the following links:

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

  This resource's serverFailureTrigger singleton resource.

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

  The create form resource for this resource's serverFailureTrigger optional singleton resource.

Body ()

Root Schema : Overload Protection

Type: object

Show Source

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

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

• failureAction(optional): string
  Default Value: no-action

  Allowed Values: [ "no-action", "force-shutdown", "admin-state" ]

  Enable automatic forceshutdown of the server on failed state. The server self-health monitoring detects fatal failures and mark the server as failed. The server can be restarted using NodeManager or a HA agent.

• freeMemoryPercentHighThreshold(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 99

  Default Value: 0

  Percentage free memory after which the server overload condition is cleared. WorkManagers stop performing overloadActions and start regular execution once the overload condition is cleared.

• freeMemoryPercentLowThreshold(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 99

  Default Value: 0

  Percentage free memory below which the server is considered overloaded. WorkManagers perform overloadAction once the server is marked as overloaded.

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

  Return the unique id of this MBean instance

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

• panicAction(optional): string
  Default Value: system-exit

  Allowed Values: [ "no-action", "system-exit" ]

  Exit the server process when the kernel encounters a panic condition like an unhandled OOME. An unhandled OOME could lead to inconsistent state and a server restart is advisable if backed by node manager or a HA agent.

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

  Maximum Value: 1073741824

  Default Value: 65536

  Total number of requests that can be present in the server. This includes requests that are enqueued and those under execution.

  The server performs a differentiated denial of service on reaching the shared capacity. A request with higher priority will be accepted in place of a lower priority request already in the queue. The lower priority request is kept waiting in the queue till all high priority requests are executed. Further enqueues of the low priority requests are rejected right away.

• 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":{
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "failureAction":{
            "default":"no-action",
            "enum":[
                "no-action",
                "force-shutdown",
                "admin-state"
            ],
            "type":"string",
            "description":"<p>Enable automatic forceshutdown of the server on failed state. The server self-health monitoring detects fatal failures and mark the server as failed. The server can be restarted using NodeManager or a HA agent.</p>"
        },
        "freeMemoryPercentHighThreshold":{
            "default":0,
            "minimum":0,
            "maximum":99,
            "type":"integer",
            "format":"int32",
            "description":"<p>Percentage free memory after which the server overload condition is cleared. WorkManagers stop performing overloadActions and start regular execution once the overload condition is cleared.</p>"
        },
        "freeMemoryPercentLowThreshold":{
            "default":0,
            "minimum":0,
            "maximum":99,
            "type":"integer",
            "format":"int32",
            "description":"<p>Percentage free memory below which the server is considered overloaded. WorkManagers perform overloadAction once the server is marked as overloaded.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "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>"
        },
        "panicAction":{
            "default":"system-exit",
            "enum":[
                "no-action",
                "system-exit"
            ],
            "type":"string",
            "description":"<p>Exit the server process when the kernel encounters a panic condition like an unhandled OOME. An unhandled OOME could lead to inconsistent state and a server restart is advisable if backed by node manager or a HA agent.</p>"
        },
        "sharedCapacityForWorkManagers":{
            "default":65536,
            "minimum":1,
            "maximum":1073741824,
            "type":"integer",
            "format":"int32",
            "description":"<p>Total number of requests that can be present in the server. This includes requests that are enqueued and those under execution. </p><p> The server performs a differentiated denial of service on reaching the shared capacity. A request with higher priority will be accepted in place of a lower priority request already in the queue. The lower priority request is kept waiting in the queue till all high priority requests are executed. Further enqueues of the low priority requests are rejected right away. </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