RESTful Server Runtime Management Interface for Oracle WebLogic Server

View This Unicast Messaging Runtime

get

/management/weblogic/{version}/serverRuntime/clusterRuntime/unicastMessaging

View this unicast messaging runtime.

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.

Response

Supported Media Types

application/json

200 Response

Returns this unicast messaging runtime.

Root Schema : Unicast Messaging Runtime

Type: object

Show Source

discoveredGroupLeaders(optional): array Items

Title: Items

Read Only: true

Running group leader names
groups(optional): string

Read Only: true

Formatted group list
localGroupLeaderName(optional): string

Read Only: true

Name of the local group leader
name(optional): string
Read Only: true
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Constraints
- unharvestable
remoteGroupsDiscoveredCount(optional): integer(int32)

Read Only: true

Returns the total groups discovered by this server
totalGroupsCount(optional): integer(int32)

Read Only: true

Total configured groups - running and not running
type(optional): string
Read Only: true
Returns the type of the MBean.
Constraints
- unharvestable

{
    "type":"object",
    "properties":{
        "discoveredGroupLeaders":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Running group leader names</p>"
        },
        "groups":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Formatted group list</p>"
        },
        "localGroupLeaderName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Name of the local group leader</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "remoteGroupsDiscoveredCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Returns the total groups discovered by this server</p>"
        },
        "totalGroupsCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Total configured groups - running and not running</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>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Read Only: true

Running group leader names

Show Source

Array of: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Running group leader names</p>"
}