Jump to

• Request
• Response

GET A Create Form For This Coherence Cluster System Resource Collection

get

/management/weblogic/{version}/edit/coherenceClusterSystemResourceCreateForm

This resource returns a pre-populated coherence cluster system resource model that can be customized then posted (using the POST method) to the coherenceClusterSystemResources collection resource to create a new coherence cluster system resource.

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 this coherence cluster system resource.

This method can return the following links:

• rel=create uri=/management/weblogic/{version}/edit/coherenceClusterSystemResources

  The collection resource for this create form resource.

Body ()

Root Schema : Coherence Cluster System Resource

Type: object

Show Source

• clusterHosts(optional): array Items
  Title: Items

  Read Only: true

  The list of hostnames of the managed servers belonging to this Coherence cluster.

• compatibilityName(optional): string

  This is only set for beans created as a result of conversion from an 8.1 application configured using ApplicationMBean and ComponentMBean.

  Standalone modules in 8.1 have both an ApplicationMBean name and ComponentMBean name. This attribute stores the name of the latter, to be used when the server creates the transient ComponentMBean for backward compatibility.

• customClusterConfigurationFileName(optional): string
  Read Only: true

  The external custom Coherence cluster configuration file.

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

  The time when the custom configuration file used by the cluster was last updated

• deploymentOrder(optional): integer(int32)
  Default Value: 100

  An integer value that indicates when this unit is deployed, relative to other deployable units on a server, during startup.

  Units with lower values are deployed before those with higher values.

• deploymentPrincipalName(optional): string

  A string value that indicates the principal that should be used when deploying the file or archive during startup and shutdown. This principal will be used to set the current subject when calling out into application code for interfaces such as ApplicationLifecycleListener. If no principal name is specified, then the anonymous principal will be used.

• descriptorFileName(optional): string
  Read Only: true

  The name of the file that contains the module configuration. By default the file resides in the DOMAIN_DIR/config/coherence/bean_name directory.

  The module file derives its name from the bean name using the following pattern:

  .xml

  Note that this is a read-only property that can only be set when the bean is created.

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

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

• federationRemoteClusterListenPort(optional): integer(int32)
  Read Only: true

  The Coherence Cluster Listen Port of the remote participant.

• federationRemoteClusterName(optional): string
  Read Only: true

  The Coherence Cluster Name of the remote participant cluster.

• federationRemoteParticipantHosts(optional): array Items
  Title: Items

  Read Only: true

  The list of remote participant hosts, who will be added as participants in the federation topology.

• federationTopology(optional): string
  Read Only: true

  The federation topology.

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

  Return the unique id of this MBean instance

• moduleType(optional): string

  The values match those defined by jsr88. This attribute may move to another MBean.

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

• persistenceActiveDirectory(optional): string
  Read Only: true

  The active directory for the default persistence environment. If no value is specified, the directory which will be used is the coherence/active sub-directory under Domain Home directory.

• persistenceDefaultMode(optional): string
  Read Only: true

  The default persistence mode.

• persistenceSnapshotDirectory(optional): string
  Read Only: true

  The snapshot directory for the default persistence environment. If no value is specified, the directory which will be used is coherence/snapshots sub-directory under Domain Home directory.

• persistenceTrashDirectory(optional): string
  Read Only: true

  The trash directory for the default persistence environment. If no value is specified, the directory which will be used is coherence/trash sub-directory under Domain Home directory.

• reportGroupFile(optional): string
  Default Value: em/metadata/reports/coherence/report-group.xml

  Get the report group file representing the superset of runtime metrics to be collected for this cluster.

• resource(optional): array Descriptor Reference
  Title: Descriptor Reference

  Read Only: true

  Contains the descriptor reference.

  Return the Descriptor for the system resource. This should be overridden by the derived system resources.

• sourcePath(optional): string
• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• targets(optional): array 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.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• usingCustomClusterConfigurationFile(optional): boolean

  Specifies whether you are using a custom external Coherence cluster configuration file.

{
    "type":"object",
    "properties":{
        "clusterHosts":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The list of hostnames of the managed servers belonging to this Coherence cluster.</p>"
        },
        "compatibilityName":{
            "type":"string",
            "description":"<p> This is only set for beans created as a result of conversion from an 8.1 application configured using ApplicationMBean and ComponentMBean. </p><p> Standalone modules in 8.1 have both an ApplicationMBean name and ComponentMBean name. This attribute stores the name of the latter, to be used when the server creates the transient ComponentMBean for backward compatibility.</p>"
        },
        "customClusterConfigurationFileName":{
            "readOnly":true,
            "type":"string",
            "description":"<p> The external custom Coherence cluster configuration file. </p>"
        },
        "customConfigFileLastUpdatedTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The time when the custom configuration file used by the cluster was last updated</p>"
        },
        "deploymentOrder":{
            "default":100,
            "type":"integer",
            "format":"int32",
            "description":"<p>An integer value that indicates when this unit is deployed, relative to other deployable units on a server, during startup.</p><p>Units with lower values are deployed before those with higher values.</p>"
        },
        "deploymentPrincipalName":{
            "type":"string",
            "description":"<p>A string value that indicates the principal that should be used when deploying the file or archive during startup and shutdown. This principal will be used to set the current subject when calling out into application code for interfaces such as ApplicationLifecycleListener. If no principal name is specified, then the anonymous principal will be used.</p>"
        },
        "descriptorFileName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the file that contains the module configuration. By default the file resides in the <code>DOMAIN_DIR/config/coherence/<i>bean_name</i></code> directory.</p><p>The module file derives its name from the bean name using the following pattern:</p><p><beanName>.xml</p><p>Note that this is a read-only property that can only be set when the bean is created.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "federationRemoteClusterListenPort":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The Coherence Cluster Listen Port of the remote participant. </p>"
        },
        "federationRemoteClusterName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The Coherence Cluster Name of the remote participant cluster. </p>"
        },
        "federationRemoteParticipantHosts":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The list of remote participant hosts, who will be added as participants in the federation topology. </p>"
        },
        "federationTopology":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The federation topology. </p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "moduleType":{
            "type":"string",
            "description":"<p>The values match those defined by jsr88. This attribute may move to another MBean.</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>"
        },
        "persistenceActiveDirectory":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The active directory for the default persistence environment. If no value is specified, the directory which will be used is the coherence/active sub-directory under Domain Home directory. </p>"
        },
        "persistenceDefaultMode":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The default persistence mode. </p>"
        },
        "persistenceSnapshotDirectory":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The snapshot directory for the default persistence environment. If no value is specified, the directory which will be used is coherence/snapshots sub-directory under Domain Home directory. </p>"
        },
        "persistenceTrashDirectory":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The trash directory for the default persistence environment. If no value is specified, the directory which will be used is coherence/trash sub-directory under Domain Home directory. </p>"
        },
        "reportGroupFile":{
            "default":"em/metadata/reports/coherence/report-group.xml",
            "type":"string",
            "description":"<p>Get the report group file representing the superset of runtime metrics to be collected for this cluster.</p>"
        },
        "resource":{
            "readOnly":true,
            "title":"Descriptor Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the descriptor reference. <p>Return the Descriptor for the system resource. This should be overridden by the derived system resources.</p>"
        },
        "sourcePath":{
            "type":"string",
            "description":""
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "targets":{
            "title":"Target References",
            "type":"array",
            "items":{
                "title":"Target Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the target reference."
            },
            "description":"Contains the array of target references. <p>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.</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>"
        },
        "usingCustomClusterConfigurationFile":{
            "type":"boolean",
            "description":"<p> Specifies whether you are using a custom external Coherence cluster configuration file.</p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Read Only: true

The list of hostnames of the managed servers belonging to this Coherence cluster.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The list of hostnames of the managed servers belonging to this Coherence cluster.</p>"
}

Nested Schema : Items

Type: array

Title: Items

Read Only: true

The list of remote participant hosts, who will be added as participants in the federation topology.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The list of remote participant hosts, who will be added as participants in the federation topology. </p>"
}

Nested Schema : Descriptor Reference

Type: array

Title: Descriptor Reference

Read Only: true

Contains the descriptor reference.

Return the Descriptor for the system resource. This should be overridden by the derived system resources.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Descriptor Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the descriptor reference. <p>Return the Descriptor for the system resource. This should be overridden by the derived system resources.</p>"
}

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>"
}

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

• Array of: object Target Reference
  Title: Target Reference

  Contains the target reference.

{
    "title":"Target References",
    "type":"array",
    "items":{
        "title":"Target Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the target reference."
    },
    "description":"Contains the array of target references. <p>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.</p>"
}

Nested Schema : Target Reference

Type: object

Title: Target Reference

Contains the target reference.

Show Source

• identity(optional): array Identity
  Title: Identity

  DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

{
    "title":"Target Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the target reference."
}

Nested Schema : Identity

Type: array

Title: Identity

DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

Show Source

• Array of: string

{
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}

Back to Top