RESTful Domain Runtime Management Interface for Oracle WebLogic Server

View This Domain Runtime

get

/management/weblogic/{version}/domainRuntime

View this domain runtime.

Note: This tree of resources is used to monitor the entire WebLogic Server domain.

Request

Path Parameters

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 domain runtime.

This method can return the following links:

rel=SNMPAgentRuntime uri=/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime
This resource's SNMPAgentRuntime singleton resource.
rel=action title=restartSystemResource uri=/management/weblogic/{version}/domainRuntime/restartSystemResource
This resource's restartSystemResource action resource.
rel=appRuntimeStateRuntime uri=/management/weblogic/{version}/domainRuntime/appRuntimeStateRuntime
This resource's appRuntimeStateRuntime singleton resource.
rel=batchJobRepositoryRuntime uri=/management/weblogic/{version}/domainRuntime/batchJobRepositoryRuntime
This resource's batchJobRepositoryRuntime singleton resource.
rel=deploymentManager uri=/management/weblogic/{version}/domainRuntime/deploymentManager
This resource's deploymentManager singleton resource.
rel=domainSecurityRuntime uri=/management/weblogic/{version}/domainRuntime/domainSecurityRuntime
This resource's domainSecurityRuntime singleton resource.
rel=editSessionConfigurationManager uri=/management/weblogic/{version}/domainRuntime/editSessionConfigurationManager
This resource's editSessionConfigurationManager singleton resource.
rel=elasticServiceManagerRuntime uri=/management/weblogic/{version}/domainRuntime/elasticServiceManagerRuntime
This resource's elasticServiceManagerRuntime singleton resource.
rel=logRuntime uri=/management/weblogic/{version}/domainRuntime/logRuntime
This resource's logRuntime singleton resource.
rel=messageDrivenControlEJBRuntime uri=/management/weblogic/{version}/domainRuntime/messageDrivenControlEJBRuntime
This resource's messageDrivenControlEJBRuntime singleton resource.
rel=migratableServiceCoordinatorRuntime uri=/management/weblogic/{version}/domainRuntime/migratableServiceCoordinatorRuntime
This resource's migratableServiceCoordinatorRuntime singleton resource.
rel=migrationDataRuntimes uri=/management/weblogic/{version}/domainRuntime/migrationDataRuntimes
This resource's migrationDataRuntimes collection resource.
rel=nodeManagerRuntimes uri=/management/weblogic/{version}/domainRuntime/nodeManagerRuntimes
This resource's nodeManagerRuntimes collection resource.
rel=policySubjectManagerRuntime uri=/management/weblogic/{version}/domainRuntime/policySubjectManagerRuntime
This resource's policySubjectManagerRuntime singleton resource.
rel=rolloutService uri=/management/weblogic/{version}/domainRuntime/rolloutService
This resource's rolloutService singleton resource.
rel=search uri=/management/weblogic/{version}/domainRuntime/search
This resource's search resource.
rel=serverLifeCycleRuntimes uri=/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes
This resource's serverLifeCycleRuntimes collection resource.
rel=serverRuntimes uri=/management/weblogic/{version}/domainRuntime/serverRuntimes
This resource's serverRuntimes resource.
rel=serviceMigrationDataRuntimes uri=/management/weblogic/{version}/domainRuntime/serviceMigrationDataRuntimes
This resource's serviceMigrationDataRuntimes collection resource.
rel=systemComponentLifeCycleRuntimes uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes
This resource's systemComponentLifeCycleRuntimes collection resource.

Root Schema : Domain Runtime

Type: object

Show Source

activationTime: string(date-time)

Read Only: true

The time when the domain became active.
This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX
name: 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
type: string
Read Only: true
Returns the type of the MBean.
Constraints
- unharvestable

{
    "type":"object",
    "properties":{
        "activationTime":{
            "readOnly":true,
            "type":"string",
            "format":"date-time",
            "description":"<p>The time when the domain became active.</p> This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
        },
        "name":{
            "readOnly":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>"
        },
        "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":""
}

Examples

View this domain runtime.

This example uses the GET method to view this domain runtime.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest/domainRuntime?fields=activationTime&links=self

Example Response

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "self",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime"
    }],
    "activationTime": "2024-09-17T16:28:58.041-04:00"
}