Jump to

• Request
• Response

View This Cluster Runtime

get

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

View this cluster 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this cluster runtime.

This method can return the following links:

• rel=action title=initiateResourceGroupMigration uri=/management/weblogic/{version}/serverRuntime/clusterRuntime/initiateResourceGroupMigration

  This resource's initiateResourceGroupMigration action resource.

• rel=jobSchedulerRuntime uri=/management/weblogic/{version}/serverRuntime/clusterRuntime/jobSchedulerRuntime

  This resource's jobSchedulerRuntime singleton resource.

• rel=serverMigrationRuntime uri=/management/weblogic/{version}/serverRuntime/clusterRuntime/serverMigrationRuntime

  This resource's serverMigrationRuntime singleton resource.

• rel=unicastMessaging uri=/management/weblogic/{version}/serverRuntime/clusterRuntime/unicastMessaging

  This resource's unicastMessaging singleton resource.

Body ()

Root Schema : Cluster Runtime

Type: object

Show Source

• activeSingletonServices(optional): array Items
  Title: Items

  Read Only: true

  Returns an array of the names of the singleton services that are active on this server.

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

  Provides the current total number of alive servers in this cluster.

  Returns the current total number of alive servers in this cluster.

• detailedSecondariesDistribution(optional): array Items
  Title: Items

  Read Only: true

  Provides the names of the remote servers (such as myserver) for which the local server is hosting secondary objects. The name is appended with a number to indicate the number of secondaries hosted on behalf of that server.

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

  Provides the number of fragments that originated in foreign domains or clusters which use the same multicast address.

  Answer the number of fragments that originated in foreign domains/cluster that use the same multicast address.

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

  Provides the total number of messages received on this server from the cluster. This is applicable to both multicast and unicast message types.

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

  Returns the total number of message fragments sent from this server into the cluster. This is applicable to both multicast and unicast message types.

• healthState(optional): object Health State

  Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.

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

  Provides the total number of in-coming multicast messages that were lost according to this server.

• name(optional): string
  Read Only: true

  The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

  Constraints

  • unharvestable
• primaryCount(optional): integer(int64)
  Read Only: true

  Provides the number of object that the local server hosts as primaries.

  Answer the number of object that the local server hosts as primaries.

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

  Provides the number of state-delta messages that had to be resent because a receiving server in the cluster missed a message.

  Returns the number of state-delta messages that had to be resent because a receiving server in the cluster missed a message.

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

  Answer the number of object that the local server hosts as secondaries.

• secondaryServerDetails(optional): string
  Read Only: true
• serverNames(optional): array Items
  Title: Items

  Read Only: true

  Provides the names of the servers in the cluster.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "activeSingletonServices":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Returns an array of the names of the singleton services that are active on this server.</p>"
        },
        "aliveServerCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Provides the current total number of alive servers in this cluster.</p><p>Returns the current total number of alive servers in this cluster.</p>"
        },
        "detailedSecondariesDistribution":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Provides the names of the remote servers (such as myserver) for which the local server is hosting secondary objects. The name is appended with a number to indicate the number of secondaries hosted on behalf of that server.</p>"
        },
        "foreignFragmentsDroppedCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Provides the number of fragments that originated in foreign domains or clusters which use the same multicast address.</p><p>Answer the number of fragments that originated in foreign domains/cluster that use the same multicast address.</p>"
        },
        "fragmentsReceivedCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Provides the total number of messages received on this server from the cluster. This is applicable to both multicast and unicast message types.</p>"
        },
        "fragmentsSentCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the total number of message fragments sent from this server into the cluster. This is applicable to both multicast and unicast message types.</p>"
        },
        "healthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "multicastMessagesLostCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Provides the total number of in-coming multicast messages that were lost according to this server.</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>"
        },
        "primaryCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Provides the number of object that the local server hosts as primaries.</p><p>Answer the number of object that the local server hosts as primaries.</p>"
        },
        "resendRequestsCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Provides the number of state-delta messages that had to be resent because a receiving server in the cluster missed a message.</p><p>Returns the number of state-delta messages that had to be resent because a receiving server in the cluster missed a message.</p>"
        },
        "secondaryCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Answer the number of object that the local server hosts as secondaries.</p>"
        },
        "secondaryServerDetails":{
            "readOnly":true,
            "type":"string",
            "description":""
        },
        "serverNames":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Provides the names of the servers in the cluster.</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

Returns an array of the names of the singleton services that are active on this server.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Returns an array of the names of the singleton services that are active on this server.</p>"
}

Nested Schema : Items

Type: array

Title: Items

Read Only: true

Provides the names of the remote servers (such as myserver) for which the local server is hosting secondary objects. The name is appended with a number to indicate the number of secondaries hosted on behalf of that server.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Provides the names of the remote servers (such as myserver) for which the local server is hosting secondary objects. The name is appended with a number to indicate the number of secondaries hosted on behalf of that server.</p>"
}

Nested Schema : Health State

Type: object

Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.

Show Source

• partitionName(optional): string

  This property indicates the partition name for which the health state is reported.

• state(optional): string

  This property indicates the reported state as:

  • OK - Service is healthy.

  • WARN - Service could have problems in the future

  • CRITICAL - Something must be done now to prevent service failure

  • FAILED - Service has failed and must be restarted

  • OVERLOADED - Service is functioning normally but there is too much work in it

  • UNKNOWN - Service state cannot be determined

• subsystemName(optional): string

  This property indicates the service for which the health state is reported.

• symptoms(optional): array Items
  Title: Items

  This property indicates the cause of the reported state.

{
    "type":"object",
    "properties":{
        "partitionName":{
            "type":"string",
            "description":"<p>This property indicates the partition name for which the health state is reported.</p>"
        },
        "state":{
            "type":"string",
            "description":"<p>This property indicates the reported state as:</p><ul><li><p>OK - Service is healthy.</p></li><li><p>WARN -  Service could have problems in the future</p></li><li><p>CRITICAL - Something must be done now to prevent service failure</p></li><li><p>FAILED - Service has failed and must be restarted</p></li><li><p>OVERLOADED -  Service is functioning normally but there is too much work in it</p></li><li><p>UNKNOWN - Service state cannot be determined</p></li></ul>"
        },
        "subsystemName":{
            "type":"string",
            "description":"<p>This property indicates the service for which the health state is reported.</p>"
        },
        "symptoms":{
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Symptom"
            },
            "description":"<p>This property indicates the cause of the reported state.</p>"
        }
    },
    "description":"<p>Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.</p>"
}

Nested Schema : Items

Type: array

Title: Items

Read Only: true

Provides the names of the servers in the cluster.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Provides the names of the servers in the cluster.</p>"
}

Nested Schema : Items

Type: array

Title: Items

This property indicates the cause of the reported state.

Show Source

• Array of: object Symptom

  Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Symptom"
    },
    "description":"<p>This property indicates the cause of the reported state.</p>"
}

Nested Schema : Symptom

Type: object

Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.

Show Source

• info(optional): string

  This property provides additional information about the symptom if available.

• instanceId(optional): string

  This property represents an identifier for the symptom.

• severity(optional): string

  This property indicates a low, medium, or high severity level.

• type(optional): string

  This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).

{
    "type":"object",
    "properties":{
        "info":{
            "type":"string",
            "description":"<p>This property provides additional information about the symptom if available.</p>"
        },
        "instanceId":{
            "type":"string",
            "description":"<p>This property represents an identifier for the symptom.</p>"
        },
        "severity":{
            "type":"string",
            "description":"<p>This property indicates a low, medium, or high severity level.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).</p>"
        }
    },
    "description":"<p>Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.</p>"
}

Back to Top