RESTful Domain Configuration Management Interface for Oracle WebLogic Server MT (Deprecated)

View This Virtual Target

get

/management/weblogic/{version}/domainConfig/virtualTargets/{name}

View this virtual target.

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.

Response

Supported Media Types

application/json

200 Response

Returns this virtual target.

Root Schema : Virtual Target

Type: object

Show Source

explicitPort(optional): integer(int32)

Minimum Value: 0

Maximum Value: 65535

Default Value: 0

Get the explicit port for this virtual target.
hostNames(optional): array Items

Title: Items

Host names, separated by line breaks, for which this virtual target will serve requests.
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.


            
            
            partitionChannel(optional): 
            string
            
                
                


















Default Value: PartitionChannel







The channel name to be used as a reference for creating a partition specific channel.




                
            
            
            
            
            portOffset(optional): 
            integer(int32)
            
                
                




Minimum Value: 0





Maximum Value: 65535











Default Value: 0







The port offset for this virtual target. If set to the minimum value, the port offset is not set.




                
            
            
            
            
            targets(optional): 
            array  Target References
            
            
                
                
Title: Target References





















Contains the array of target references. You must select a target from this list of the targets in the current domain. Targets must be either servers or clusters. The deployment will only occur once if the targets overlap. For example, if a deployment is deployed both on a cluster C and on a server S that is a member of that cluster, the deployment will be deployed on server S only once.
Constraints
restart required


                
            
            
            
            
            type(optional): 
            string
            
                
                


Read Only: true























Returns the type of the MBean.
Constraints
unharvestable




                
            
            
            
            
            uriPrefix(optional): 
            string
            
                
                


















Default Value: /







The URI prefix for this virtual target.


        {
    "type":"object",
    "properties":{
        "explicitPort":{
            "default":0,
            "minimum":0,
            "maximum":65535,
            "type":"integer",
            "format":"int32",
            "description":"<p>Get the explicit port for this virtual target.</p>"
        },
        "hostNames":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Host names, separated by line breaks, for which this virtual target will serve requests.</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>"
        },
        "partitionChannel":{
            "default":"PartitionChannel",
            "type":"string",
            "description":"<p>The channel name to be used as a reference for creating a partition specific channel.</p>"
        },
        "portOffset":{
            "default":0,
            "minimum":0,
            "maximum":65535,
            "type":"integer",
            "format":"int32",
            "description":"<p>The port offset for this virtual target. If set to the minimum value, the port offset is not set.</p>"
        },
        "targets":{
            "x-weblogic-restartRequired":true,
            "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 from this list of the targets in the current domain. Targets must be either servers or clusters. The deployment will only occur once if the targets overlap. For example, if a deployment is deployed both on a cluster C and on a server S that is a member of that cluster, the deployment will be deployed on server S only once.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "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>"
        },
        "uriPrefix":{
            "default":"/",
            "type":"string",
            "description":"<p>The URI prefix for this virtual target.</p>"
        }
    },
    "description":""
}



                    
                    
    Nested Schema : Items
    
      
      Type: array
    

    

    
    Title: Items
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    Host names, separated by line breaks, for which this virtual target will serve requests.
    

    

    

    

    
        Show Source
        
            
            
            Array of: 
                string
            
            
                
                





























                
            
            
            
        
        {
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Host names, separated by line breaks, for which this virtual target will serve requests.</p>"
}
    

    

    

    

    

    




                    
                    
    Nested Schema : Target References
    
      
      Type: array
    

    

    
    Title: Target References
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    Contains the array of target references. You must select a target from this list of the targets in the current domain. Targets must be either servers or clusters. The deployment will only occur once if the targets overlap. For example, if a deployment is deployed both on a cluster C and on a server S that is a member of that cluster, the deployment will be deployed on server S only once.
Constraints
restart required
    

    

    

    

    
        Show Source
        
            
            
            Array of: 
                object  Target Reference
            
            
                
                
Title: Target Reference





















Contains the target reference.


                
            
            
            
        
        {
    "x-weblogic-restartRequired":true,
    "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 from this list of the targets in the current domain. Targets must be either servers or clusters. The deployment will only occur once if the targets overlap. For example, if a deployment is deployed both on a cluster C and on a server S that is a member of that cluster, the deployment will be deployed on server S only once.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}
    

    

    

    

    

    




                    
                    
    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