Jump to

• Request
• Response

View This Coherence Server Collection

get

/management/weblogic/{version}/edit/coherenceServers

View this coherence server collection.

Request

Path Parameters

• 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 a list of coherence server entities.

This method can return the following links:

• rel=create-form uri=/management/weblogic/{version}/edit/coherenceServerCreateForm

  The create form resource for this collection resource.

Body ()

Root Schema : Items

Type: array

Title: Items

Show Source

• Array of: object Coherence Server

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Coherence Server"
    },
    "description":""
}

Nested Schema : Coherence Server

Type: object

Show Source

• autoRestart(optional): boolean
  Default Value: true

  Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly.

• coherenceClusterSystemResource(optional): array Coherence Cluster System Resource Reference
  Title: Coherence Cluster System Resource Reference

  Contains the coherence cluster system resource reference.

  The system-level Coherence cluster resource associated with this server.

  Constraints

  • restart required
• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

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

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

  Return the unique id of this MBean instance

• machine(optional): array Machine Reference
  Title: Machine Reference

  Contains the machine reference.

  The WebLogic Server host computer (machine) on which this server is meant to run.

  If you want to use a Node Manager to start this server, you must assign the server to a machine and you must configure the machine for the Node Manager.

  You cannot change this value if a server instance is already running.

  Constraints

  • restart required
• name(optional): string
  Read Only: true

  An alphanumeric name for this server instance. (Spaces are not valid.)

  The name must be unique for all configuration objects in the domain. Within a domain, each server, machine, cluster, JDBC connection pool, virtual host, and any other resource type must be named uniquely and must not use the same name as the domain.

  The server name is not used as part of the URL for applications that are deployed on the server. It is for your identification purposes only. The server name displays in the Administration Console, and if you use WebLogic Server command-line utilities or APIs, you use this name to identify the server.

  After you have created a server, you cannot change its name. Instead, clone the server and provide a new name for the clone.

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

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

  Maximum Value: 2147483647

  Default Value: 0

  The number of seconds the Node Manager should wait before restarting this server.

  After killing a server process, the system might need several seconds to release the TCP port(s) the server was using. If Node Manager attempts to restart the Managed Server while its ports are still active, the startup attempt fails.

  If AutoMigration is enabled and RestartDelaySeconds is 0, the RestartDelaySeconds is automatically set to the lease time. This prevents the server from failing to restart after migration when the previous lease is still valid.

• restartIntervalSeconds(optional): integer(int32)
  Minimum Value: 300

  Maximum Value: 2147483647

  Default Value: 3600

  The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.

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

  Maximum Value: 2147483647

  Default Value: 2

  The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.

• 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
• unicastListenAddress(optional): string

  The IP address for the cluster unicast listener.

  This attribute may be used to override the value of the referenced Coherence cluster.

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

  Maximum Value: 65535

  The port for the cluster unicast listener.

• unicastPortAutoAdjustAttempts(optional): integer(int32)
  Default Value: 65535

  Gets the upper bound of the unicast port. A positive value indicates the unicast port is automatically incremented if the specified port cannot be bound because it is already in use.

{
    "type":"object",
    "properties":{
        "autoRestart":{
            "default":true,
            "type":"boolean",
            "description":"<p> Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly. </p>"
        },
        "coherenceClusterSystemResource":{
            "x-weblogic-restartRequired":true,
            "title":"Coherence Cluster System Resource Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the coherence cluster system resource reference. <p>The system-level Coherence cluster resource associated with this server.</p><p><h5>Constraints</h5></p><ul><li>restart required</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>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "machine":{
            "x-weblogic-restartRequired":true,
            "title":"Machine Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the machine reference. <p> The WebLogic Server host computer (machine) on which this server is meant to run. </p><p> If you want to use a Node Manager to start this server, you must assign the server to a machine and you must configure the machine for the Node Manager. </p><p> You cannot change this value if a server instance is already running. </p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>An alphanumeric name for this server instance. (Spaces are not valid.)</p><p>The name must be unique for all configuration objects in the domain. Within a domain, each server, machine, cluster, JDBC connection pool, virtual host, and any other resource type must be named uniquely and must not use the same name as the domain.</p><p>The server name is not used as part of the URL for applications that are deployed on the server. It is for your identification purposes only. The server name displays in the Administration Console, and if you use WebLogic Server command-line utilities or APIs, you use this name to identify the server.</p><p>After you have created a server, you cannot change its name. Instead, clone the server and provide a new name for the clone.</p>"
        },
        "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>"
        },
        "restartDelaySeconds":{
            "default":0,
            "minimum":0,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p> The number of seconds the Node Manager should wait before restarting this server. </p><p> After killing a server process, the system might need several seconds to release the TCP port(s) the server was using. If Node Manager attempts to restart the Managed Server while its ports are still active, the startup attempt fails. </p><p> If AutoMigration is enabled and RestartDelaySeconds is 0, the RestartDelaySeconds is automatically set to the lease time. This prevents the server from failing to restart after migration when the previous lease is still valid. </p>"
        },
        "restartIntervalSeconds":{
            "default":3600,
            "minimum":300,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p> The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax. </p>"
        },
        "restartMax":{
            "default":2,
            "minimum":0,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p> The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds. </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>"
        },
        "unicastListenAddress":{
            "type":"string",
            "description":"<p>The IP address for the cluster unicast listener.</p><p>This attribute may be used to override the value of the referenced Coherence cluster.</p>"
        },
        "unicastListenPort":{
            "minimum":1,
            "maximum":65535,
            "type":"integer",
            "format":"int32",
            "description":"<p>The port for the cluster unicast listener.</p>"
        },
        "unicastPortAutoAdjustAttempts":{
            "default":65535,
            "type":"integer",
            "format":"int32",
            "description":"<p> Gets the upper bound of the unicast port. A positive value indicates the unicast port is automatically incremented if the specified port cannot be bound because it is already in use. </p>"
        }
    },
    "description":""
}

Nested Schema : Coherence Cluster System Resource Reference

Type: array

Title: Coherence Cluster System Resource Reference

Contains the coherence cluster system resource reference.

The system-level Coherence cluster resource associated with this server.

Constraints

• restart required

Show Source

• Array of: string

{
    "x-weblogic-restartRequired":true,
    "title":"Coherence Cluster System Resource Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the coherence cluster system resource reference. <p>The system-level Coherence cluster resource associated with this server.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Nested Schema : Machine Reference

Type: array

Title: Machine Reference

Contains the machine reference.

The WebLogic Server host computer (machine) on which this server is meant to run.

If you want to use a Node Manager to start this server, you must assign the server to a machine and you must configure the machine for the Node Manager.

You cannot change this value if a server instance is already running.

Constraints

• restart required

Show Source

• Array of: string

{
    "x-weblogic-restartRequired":true,
    "title":"Machine Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the machine reference. <p> The WebLogic Server host computer (machine) on which this server is meant to run. </p><p> If you want to use a Node Manager to start this server, you must assign the server to a machine and you must configure the machine for the Node Manager. </p><p> You cannot change this value if a server instance is already running. </p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

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