GET A Create Form For This Singleton Service Collection
/management/weblogic/{version}/edit/singletonServiceCreateForm
This resource returns a pre-populated singleton service model that can be customized then posted (using the POST method) to the singletonServices collection resource to create a new singleton service.
Request
-
version: string
The version of the WebLogic REST interface.
-
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.
-
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.
Response
- application/json
200 Response
Returns this singleton service.
This method can return the following links:
- rel=create uri=/management/weblogic/{version}/edit/singletonServices
The collection resource for this create form resource.
object
-
additionalMigrationAttempts(optional):
integer(int32)
Default Value:
2
A migratable service could fail to come up on every possible configured server. This attribute controls how many further attempts, after the service has failed on every server at least once, should be tried. Note that each attempt specified here indicates another full circuit of migrations amongst all the configured servers. So for a 3-server cluster, and a value of 2, a total of 4 additional migrations will be attempted. (the original server is never a valid destination)
-
allCandidateServers(optional):
array Server References
Title:
Server References
Contains the array of server references.Return a list of servers that are candidates to host the services deployed to this migratable target. If the ConstrainedCandidateServer list is empty, all servers in the cluster are returned. If the ConstrainedCandidateServer is not empty those servers only will be returned. The user preferred server will be the first element in the list returned.
-
className(optional):
string
The fully qualified name of a class to load and run. The class must be on the server's classpath.
For example,
mycompany.mypackage.myclass
Constraints
- legal null
-
cluster(optional):
array Cluster Reference
Title:
Cluster Reference
Contains the cluster reference.Returns the cluster this singleton service is associated with.
Constraints
- restart required
-
constrainedCandidateServers(optional):
array Server References
Title:
Server References
Contains the array of server references.Returns the (user restricted) list of servers that may host the migratable target. The target will not be allowed to migrate to a server that is not in the returned list of servers. This feature is used to e.g. configure the two server that have access to a dual ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.
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
-
hostingServer(optional):
array Server Reference
Title:
Server Reference
Read Only:true
Contains the server reference.Returns the name of the server that currently hosts the singleton service.
-
id(optional):
integer(int64)
Read Only:
true
Return the unique id of this MBean instance
-
millisToSleepBetweenAttempts(optional):
integer(int32)
Default Value:
300000
Controls how long of a pause there should be between the migration attempts described in getAdditionalMigrationAttempts(). Note that this delay only happens when the service has failed to come up on every server. It does not cause any sort of delay between attempts to migrate otherwise.
-
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.
-
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
-
userPreferredServer(optional):
array Server Reference
Title:
Server Reference
Contains the server reference.Returns the server that the user prefers the singleton service to be active on.
array
Server References
Return a list of servers that are candidates to host the services deployed to this migratable target. If the ConstrainedCandidateServer list is empty, all servers in the cluster are returned. If the ConstrainedCandidateServer is not empty those servers only will be returned. The user preferred server will be the first element in the list returned.
-
Array of:
object Server Reference
Title:
Server Reference
Contains the server reference.
array
Cluster Reference
Returns the cluster this singleton service is associated with.
Constraints
- restart required
array
Server References
Returns the (user restricted) list of servers that may host the migratable target. The target will not be allowed to migrate to a server that is not in the returned list of servers. This feature is used to e.g. configure the two server that have access to a dual ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.
Constraints
- restart required
-
Array of:
object Server Reference
Title:
Server Reference
Contains the server reference.
array
Server Reference
true
Returns the name of the server that currently hosts the singleton service.
array
Server Reference
Returns the server that the user prefers the singleton service to be active on.
object
Server Reference
-
identity(optional):
array Identity
Title:
Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
array
Identity
object
Server Reference
-
identity(optional):
array Identity
Title:
Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
array
Identity