RESTful Server Configuration Management Interface for Oracle WebLogic Server

View This Dynamic Servers

get

/management/weblogic/{version}/serverConfig/clusters/{name}/dynamicServers

View this dynamic servers.

Request

Path Parameters

name(required): string

The name property of the instance in the collection.
version(required): string

The version of the WebLogic REST interface.

Query Parameters

excludeFields: 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: 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: 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: 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.

Response

Supported Media Types

application/json

200 Response

Returns this dynamic servers.

This method can return the following links:

rel=serverTemplate
This resource's serverTemplate reference to a server template resource.

Root Schema : Dynamic Servers

Type: object

Show Source

calculatedListenPorts: boolean

Default Value: true

Specifies whether listen ports are calculated.
calculatedMachineNames: boolean

Default Value: false

The CalculatedMachineNames attribute controls how server instances in a dynamic cluster are assigned to a machine. If the attribute is not set, then the dynamic servers will not be assigned to a machine. If the attribute is set, then the MachineNameMatchExpression attribute is used to select the set of machines to use for the dynamic servers.
dynamicallyCreated: boolean

Read Only: true

Default Value: false

Return whether the MBean was created dynamically or is persisted to config.xml
dynamicClusterCooloffPeriodSeconds: integer(int32)

Minimum Value: 0

Default Value: 900

Get the cool-off period (in seconds) used by the Elasticity Framework while performing scale up or scale down operations. If a scale up or scale down operation was performed, subsequent requests for scale up or down operations will be ignored by the Elasticity Framework during this period.
dynamicClusterShutdownTimeoutSeconds: integer(int32)

Minimum Value: 0

Default Value: 0

Get the timeout period (in seconds) used by the Elasticity Framework while gracefully shutting down a server. If the server does not shut down before the specified timeout period, the server will be forcibly shut down. With a negative time value, no timeout will be applied.
dynamicClusterSize: integer(int32)

Minimum Value: 0

Maximum Value: 800

Get the current size of the dynamic cluster (the number of dynamic server instances allowed to be created). The specified number of server instances are dynamically created as ServerMBeans at runtime and associated ServerLifeCycleRuntimeMBeans are created.
dynamicServerNames: array Items

Title: Items

Read Only: true

Return an array of all the dynamic server names
id: integer(int64)

Read Only: true

Return the unique id of this MBean instance
ignoreSessionsDuringShutdown: boolean

Default Value: false

Indicates if the Elasticity Framework should ignore inflight HTTP sessions while shutting down servers.
machineMatchExpression: string

Get the machine tag expression to use when selecting machine names. If the MachineMatchType is "name", each value will either match a machine name exactly or, if specified with a trailing '*' suffix, will match multiple machine names. If the MachineMatchType is "tag", the values will match all of the machines that have all of the tag values.
machineMatchType: string

Default Value: name

Allowed Values: [ "name", "tag" ]

Get the machine tag expression to use when selecting machine names. If the MachineMatchType is "name", each value will either match a machine name exactly or, if specified with a trailing '*' suffix, will match multiple machine names. If the MachineMatchType is "tag", the values will match all of the machines that have all of the tag values.
machineNameMatchExpression: string

The expression is used when determining machines to use for server assignments. If null, then all machines in the domain are used. If a expression is provided, then only the machines in the domain that match the expression will be used when assigning machine names to dynamic servers. The expression is a comma separated set of values that specify the machines to match. Each value will either match a machine name exactly or if specified with a trailing '*' suffix, the value will match multiple machine names.
maxDynamicClusterSize: integer(int32)

Minimum Value: 0

Maximum Value: 800

Default Value: 8

Get the upper bound on the DynamicClusterSize that the Elasticity Framework is allowed to assign to DynamicClusterSize.
minDynamicClusterSize: integer(int32)

Minimum Value: 0

Maximum Value: 800

Default Value: 1

Get the minimum number of running server instances that the Elasticity Framework will attempt to keep in the dynamic cluster.
name: 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: 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.


            
            
            serverNamePrefix: 
            string
            
                
                
























The server name prefix is used to specify the naming convention when creating server names. When the server name prefix is defined, server names are calculated with the specified prefix followed by the index starting with the value specified by getServerNameStartingIndex().




                
            
            
            
            
            serverNameStartingIndex: 
            integer(int32)
            
                
                




Minimum Value: 0





Maximum Value: 2147480000











Default Value: 1







Get the starting index to use in server names.  Server names are calculated with the prefix specified in getServerNamePrefix() followed by an index starting with the value specified in this attribute.




                
            
            
            
            
            serverTemplate: 
            array  Server Template Reference
            
            
                
                
Title: Server Template Reference





















Contains the server template reference. The server template used to create dynamic servers.
Constraints
restart required


                
            
            
            
            
            tags: 
            array  Items
            
            
                
                
Title: Items





















Return all tags on this Configuration MBean


                
            
            
            
            
            type: 
            string
            
                
                


Read Only: true























Returns the type of the MBean.
Constraints
unharvestable




                
            
            
            
            
            waitForAllSessionsDuringShutdown: 
            boolean
            
                
                


















Default Value: false







Indicates if the Elasticity Framework should wait for all (persisted and non-persisted) HTTP sessions during inflight work handling while shutting down servers.


        {
    "type":"object",
    "properties":{
        "calculatedListenPorts":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether listen ports are calculated.</p>"
        },
        "calculatedMachineNames":{
            "default":false,
            "type":"boolean",
            "description":"<p>The CalculatedMachineNames attribute controls how server instances in a dynamic cluster are assigned to a machine. If the attribute is not set, then the dynamic servers will not be assigned to a machine. If the attribute is set, then the MachineNameMatchExpression attribute is used to select the set of machines to use for the dynamic servers.</p>"
        },
        "dynamicClusterCooloffPeriodSeconds":{
            "default":"900",
            "minimum":"0",
            "type":"integer",
            "format":"int32",
            "description":"<p>Get the cool-off period (in seconds) used by the Elasticity Framework while performing scale up or scale down operations. If a scale up or scale down operation was performed, subsequent requests for scale up or down operations will be ignored by the Elasticity Framework during this period.</p>"
        },
        "dynamicClusterShutdownTimeoutSeconds":{
            "default":"0",
            "minimum":"0",
            "type":"integer",
            "format":"int32",
            "description":"<p>Get the timeout period (in seconds) used by the Elasticity Framework while gracefully shutting down a server. If the server does not shut down before the specified timeout period, the server will be forcibly shut down. With a negative time value, no timeout will be applied.</p>"
        },
        "dynamicClusterSize":{
            "minimum":"0",
            "maximum":"800",
            "type":"integer",
            "format":"int32",
            "description":"<p>Get the current size of the dynamic cluster (the number of dynamic server instances allowed to be created). The specified number of server instances are dynamically created as ServerMBeans at runtime and associated ServerLifeCycleRuntimeMBeans are created.</p>"
        },
        "dynamicServerNames":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return an array of all the dynamic server names</p>"
        },
        "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>"
        },
        "ignoreSessionsDuringShutdown":{
            "default":false,
            "type":"boolean",
            "description":"<p>Indicates if the Elasticity Framework should ignore inflight HTTP sessions while shutting down servers.</p>"
        },
        "machineMatchExpression":{
            "type":"string",
            "description":"<p>Get the machine tag expression to use when selecting machine names.  If the MachineMatchType is \"name\", each value will either match a machine name exactly or, if specified with a trailing '*' suffix, will match multiple machine names. If the MachineMatchType is \"tag\", the values will match all of the machines that have all of the tag values.</p>"
        },
        "machineMatchType":{
            "default":"name",
            "enum":[
                "name",
                "tag"
            ],
            "type":"string",
            "description":"<p>Get the machine tag expression to use when selecting machine names.  If the MachineMatchType is \"name\", each value will either match a machine name exactly or, if specified with a trailing '*' suffix, will match multiple machine names. If the MachineMatchType is \"tag\", the values will match all of the machines that have all of the tag values.</p>"
        },
        "machineNameMatchExpression":{
            "type":"string",
            "description":"<p>The expression is used when determining machines to use for server assignments. If null, then all machines in the domain are used. If a expression is provided, then only the machines in the domain that match the expression will be used when assigning machine names to dynamic servers.  The expression is a comma separated set of values that specify the machines to match. Each value will either match a machine name exactly or if specified with a trailing '*' suffix, the value will match multiple machine names.</p>"
        },
        "maxDynamicClusterSize":{
            "default":"8",
            "minimum":"0",
            "maximum":"800",
            "type":"integer",
            "format":"int32",
            "description":"<p>Get the upper bound on the DynamicClusterSize that the Elasticity Framework is allowed to assign to DynamicClusterSize.</p>"
        },
        "minDynamicClusterSize":{
            "default":"1",
            "minimum":"0",
            "maximum":"800",
            "type":"integer",
            "format":"int32",
            "description":"<p>Get the minimum number of running server instances that the Elasticity Framework will attempt to keep in the dynamic cluster.</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>"
        },
        "serverNamePrefix":{
            "type":"string",
            "description":"<p>The server name prefix is used to specify the naming convention when creating server names. When the server name prefix is defined, server names are calculated with the specified prefix followed by the index starting with the value specified by getServerNameStartingIndex().</p>"
        },
        "serverNameStartingIndex":{
            "default":"1",
            "minimum":"0",
            "maximum":"2147480000",
            "type":"integer",
            "format":"int32",
            "description":"<p>Get the starting index to use in server names.  Server names are calculated with the prefix specified in getServerNamePrefix() followed by an index starting with the value specified in this attribute.</p>"
        },
        "serverTemplate":{
            "x-weblogic-restartRequired":true,
            "title":"Server Template Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the server template reference. <p>The server template used to create dynamic servers.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "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>"
        },
        "waitForAllSessionsDuringShutdown":{
            "default":false,
            "type":"boolean",
            "description":"<p>Indicates if the Elasticity Framework should wait for all (persisted and non-persisted) HTTP sessions during inflight work handling while shutting down servers.</p>"
        }
    },
    "description":""
}



                    
                    
    Nested Schema : Items
    
      
      Type: array
    

    

    
    Title: Items
    

    

    

    
    Read Only: true
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    Return an array of all the dynamic server names
    

    

    

    

    
        Show Source
        
            
            
            Array of: 
                string
            
            
                
                





























                
            
            
            
        
        {
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return an array of all the dynamic server names</p>"
}
    

    

    

    

    

    




                    
                    
    Nested Schema : Server Template Reference
    
      
      Type: array
    

    

    
    Title: Server Template Reference
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    Contains the server template reference. The server template used to create dynamic servers.
Constraints
restart required
    

    

    

    

    
        Show Source
        
            
            
            Array of: 
                string
            
            
                
                





























                
            
            
            
        
        {
    "x-weblogic-restartRequired":true,
    "title":"Server Template Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the server template reference. <p>The server template used to create dynamic servers.</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