RESTful Domain Runtime Management Interface for Oracle WebLogic Server

View This Server Life Cycle Runtime

get

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}

View this server life cycle runtime.

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 server life cycle runtime.

This method can return the following links:

rel=action title=forceShutdown uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceShutdown
This resource's forceShutdown action resource.
rel=action title=forceSuspend uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/forceSuspend
This resource's forceSuspend action resource.
rel=action title=getIPv4URL uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv4URL
This resource's getIPv4URL action resource.
rel=action title=getIPv6URL uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/getIPv6URL
This resource's getIPv6URL action resource.
rel=action title=resume uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/resume
This resource's resume action resource.
rel=action title=shutdown uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown
This resource's shutdown action resource.
rel=action title=start uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/start
This resource's start action resource.
rel=action title=startInAdmin uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInAdmin
This resource's startInAdmin action resource.
rel=action title=startInStandby uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/startInStandby
This resource's startInStandby action resource.
rel=action title=suspend uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/suspend
This resource's suspend action resource.
rel=tasks uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/tasks
This resource's tasks collection resource.

Root Schema : Server Life Cycle Runtime

Type: object

Show Source

middlewareHome: string

Read Only: true

The Oracle Middleware installation directory.
name: string
Read Only: true
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Constraints
- unharvestable
nodeManagerRestartCount: integer(int32)

Read Only: true

Number of times the server has been restarted using the NodeManager since creation. The first start does not count. The count is valid only if the NodeManager is used to start and restart the server everytime.
state: string

Read Only: true

The current state of the server.
type: string
Read Only: true
Returns the type of the MBean.
Constraints
- unharvestable
weblogicHome: string

Read Only: true

The directory where the WebLogic Server instance (server) is installed, without the trailing "/server".

{
    "type":"object",
    "properties":{
        "middlewareHome":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The Oracle Middleware installation directory. </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>"
        },
        "nodeManagerRestartCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Number of times the server has been restarted using the NodeManager since creation. The first start does not count. The count is valid only if the NodeManager is used to start and restart the server everytime.</p>"
        },
        "state":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The current state of the server.</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>"
        },
        "weblogicHome":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The directory where the WebLogic Server instance (server) is installed, without the trailing \"/server\".</p>"
        }
    },
    "description":""
}