Jump to

• Request
• Response

View This Partition Runtime

get

/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}

View this partition runtime.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this partition runtime.

This method can return the following links:

• rel=JDBCPartitionRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JDBCPartitionRuntime

  This resource's JDBCPartitionRuntime singleton resource.

• rel=JMSRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JMSRuntime

  This resource's JMSRuntime singleton resource.

• rel=JTAPartitionRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/JTAPartitionRuntime

  This resource's JTAPartitionRuntime singleton resource.

• rel=SAFRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/SAFRuntime

  This resource's SAFRuntime singleton resource.

• rel=WLDFPartitionRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/WLDFPartitionRuntime

  This resource's WLDFPartitionRuntime singleton resource.

• rel=action title=forceShutdown uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/forceShutdown

  This resource's forceShutdown action resource.

• rel=action title=forceShutdownResourceGroup uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/forceShutdownResourceGroup

  This resource's forceShutdownResourceGroup action resource.

• rel=action title=forceSuspend uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/forceSuspend

  This resource's forceSuspend action resource.

• rel=action title=forceSuspendResourceGroup uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/forceSuspendResourceGroup

  This resource's forceSuspendResourceGroup action resource.

• rel=action title=getRgState uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/getRgState

  This resource's getRgState action resource.

• rel=action title=halt uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/halt

  This resource's halt action resource.

• rel=action title=resume uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/resume

  This resource's resume action resource.

• rel=action title=resumeResourceGroup uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/resumeResourceGroup

  This resource's resumeResourceGroup action resource.

• rel=action title=shutdown uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/shutdown

  This resource's shutdown action resource.

• rel=action title=shutdownResourceGroup uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/shutdownResourceGroup

  This resource's shutdownResourceGroup action resource.

• rel=action title=startResourceGroup uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/startResourceGroup

  This resource's startResourceGroup action resource.

• rel=action title=startResourceGroupInAdmin uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/startResourceGroupInAdmin

  This resource's startResourceGroupInAdmin action resource.

• rel=action title=suspend uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/suspend

  This resource's suspend action resource.

• rel=action title=suspendResourceGroup uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/suspendResourceGroup

  This resource's suspendResourceGroup action resource.

• rel=applicationRuntimes uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/applicationRuntimes

  This resource's applicationRuntimes collection resource.

• rel=batchJobRepositoryRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/batchJobRepositoryRuntime

  This resource's batchJobRepositoryRuntime singleton resource.

• rel=concurrentManagedObjectsRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/concurrentManagedObjectsRuntime

  This resource's concurrentManagedObjectsRuntime singleton resource.

• rel=connectorServiceRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime

  This resource's connectorServiceRuntime singleton resource.

• rel=libraryRuntimes uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/libraryRuntimes

  This resource's libraryRuntimes collection resource.

• rel=mailSessionRuntimes uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/mailSessionRuntimes

  This resource's mailSessionRuntimes collection resource.

• rel=maxThreadsConstraintRuntimes uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/maxThreadsConstraintRuntimes

  This resource's maxThreadsConstraintRuntimes collection resource.

• rel=messagingBridgeRuntimes uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/messagingBridgeRuntimes

  This resource's messagingBridgeRuntimes collection resource.

• rel=minThreadsConstraintRuntimes uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/minThreadsConstraintRuntimes

  This resource's minThreadsConstraintRuntimes collection resource.

• rel=partitionResourceMetricsRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/partitionResourceMetricsRuntime

  This resource's partitionResourceMetricsRuntime singleton resource.

• rel=partitionWorkManagerRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/partitionWorkManagerRuntime

  This resource's partitionWorkManagerRuntime singleton resource.

• rel=pathServiceRuntimes uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/pathServiceRuntimes

  This resource's pathServiceRuntimes collection resource.

• rel=persistentStoreRuntimes uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/persistentStoreRuntimes

  This resource's persistentStoreRuntimes collection resource.

• rel=requestClassRuntimes uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/requestClassRuntimes

  This resource's requestClassRuntimes collection resource.

• rel=resourceManagerRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/resourceManagerRuntime

  This resource's resourceManagerRuntime singleton resource.

• rel=workManagerRuntimes uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/workManagerRuntimes

  This resource's workManagerRuntimes collection resource.

• rel=wseeClusterFrontEndRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/wseeClusterFrontEndRuntime

  This resource's wseeClusterFrontEndRuntime singleton resource.

Body ()

Root Schema : Partition Runtime

Type: object

Show Source

• name(optional): string
  Read Only: true

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

  Constraints

  • unharvestable
• overallHealthState(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.

• partitionID(optional): string
  Read Only: true

  Partition ID for this partition.

• restartRequired(optional): boolean
  Read Only: true

  Indicates whether the partition must be restarted in order to activate configuration changes.

• serverName(optional): string
  Read Only: true

  The server associated with this configuration.

  Constraints

  • unharvestable
• state(optional): string
  Read Only: true

  The current state of the partition runtime MBean

• subState(optional): string
  Read Only: true

  The current substate of the partition runtime MBean

• subsystemHealthStates(optional): array Items
  Title: Items

  Read Only: true

  An array of health states for major subsystems in the partition.

• systemFileSystemRoot(optional): string
  Read Only: true

  System file system root directory for this partition.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• userFileSystemRoot(optional): string
  Read Only: true

  User file system root directory for this partition.

{
    "type":"object",
    "properties":{
        "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>"
        },
        "overallHealthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "partitionID":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Partition ID for this partition.</p>"
        },
        "restartRequired":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the partition must be restarted in order to activate configuration changes.</p>"
        },
        "serverName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The server associated with this configuration. </p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "state":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The current state of the partition runtime MBean</p>"
        },
        "subState":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The current substate of the partition runtime MBean</p>"
        },
        "subsystemHealthStates":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Health State"
            },
            "description":"<p>An array of health states for major subsystems in the partition.</p>"
        },
        "systemFileSystemRoot":{
            "readOnly":true,
            "type":"string",
            "description":"<p>System file system root directory for this partition.</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>"
        },
        "userFileSystemRoot":{
            "readOnly":true,
            "type":"string",
            "description":"<p>User file system root directory for this partition.</p>"
        }
    },
    "description":""
}

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

An array of health states for major subsystems in the partition.

Show Source

• Array of: 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.

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Health State"
    },
    "description":"<p>An array of health states for major subsystems in the partition.</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