Jump to

• Request
• Response

View This Resource Group Life Cycle Runtime

get

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

View this resource group life cycle 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 resource group life cycle runtime.

This method can return the following links:

• rel=action title=forceShutdown uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceShutdown

  This resource's forceShutdown action resource.

• rel=action title=forceSuspend uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/forceSuspend

  This resource's forceSuspend action resource.

• rel=action title=getState uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/getState

  This resource's getState action resource.

• rel=action title=purgeTasks uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/purgeTasks

  This resource's purgeTasks action resource.

• rel=action title=resume uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/resume

  This resource's resume action resource.

• rel=action title=shutdown uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/shutdown

  This resource's shutdown action resource.

• rel=action title=start uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/start

  This resource's start action resource.

• rel=action title=startInAdmin uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/startInAdmin

  This resource's startInAdmin action resource.

• rel=action title=suspend uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend

  This resource's suspend action resource.

• rel=tasks uri=/management/weblogic/{version}/domainRuntime/resourceGroupLifeCycleRuntimes/{name}/tasks

  This resource's tasks collection resource.

Body ()

Root Schema : Resource Group Life Cycle 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
• state(optional): string
  Read Only: true

  The current overall state of the resource group.

  The value returned is the highest state for the resource group on all servers where it is targeted. As a result, the overall resource group state can change (for example, to RUNNING) as soon as the operation (such as start) has finished on one server, even while the operation is still in progress elsewhere.

  If the resource group is not currently targeted to any running server then its reported state is the desired state indicated by the most recent resource group life cycle operation on the resource group.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "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>"
        },
        "state":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The current overall state of the resource group.</p><p>The value returned is the highest state for the resource group on all servers where it is targeted. As a result, the overall resource group state can change (for example, to <code>RUNNING</code>) as soon as the operation (such as start) has finished on one server, even while the operation is still in progress elsewhere.</p><p>If the resource group is not currently targeted to any running server then its reported state is the desired state indicated by the most recent resource group life cycle operation on the resource group.</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":""
}

Back to Top