Jump to

• Request
• Response

Suspend ( Timeout, Ignore Sessions, Target Names )

post

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/partitionLifeCycleRuntime/resourceGroupLifeCycleRuntimes/{name}/suspend

Begins to transition this resource group from RUNNING to ADMIN state gracefully on the specified targets.

Applications are in admin mode. Inflight work is completed.

Use the returned ResourceGroupLifeCycleTaskRuntimeMBean value to check for completion

This method supports both asynchronous and best effort synchronous invocations. The behavior is controlled by the 'Prefer' header.

Request

Supported Media Types

• application/json

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Header Parameters

• Prefer(optional): string
  The 'Prefer' header parameter can be used to specify the preference on how this method runs. A value of 'respond-async' specifies a preference to submit the request and return immediately without waiting for completion. Alternatively a value of 'wait=#seconds' specifies a preference to wait for #seconds for method completion before returning. If the Prefer header is not specified or invalid, then a 300 second wait will be used.
• X-Requested-By: string
  The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Body ()

Must contain the following fields:

Root Schema : Arguments

Type: object

Title: Arguments

Show Source

• ignoreSessions(optional): boolean

  drop inflight HTTP sessions during graceful suspend

• targetNames(optional): array Items
  Title: Items

  the specific servers on which to suspend this resource group

• timeout(optional): integer(int32)

  Seconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "ignoreSessions":{
            "type":"boolean",
            "description":"<p>drop inflight HTTP sessions during graceful suspend</p>"
        },
        "targetNames":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>the specific servers on which to suspend this resource group</p>"
        },
        "timeout":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Seconds to wait for the resource group to transition gracefully. The resource group automatically calls forceSuspend() after timeout.</p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

the specific servers on which to suspend this resource group

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>the specific servers on which to suspend this resource group</p>"
}

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin 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 the following fields:

Body ()

Root Schema : Return

Type: object

Title: Return

Show Source

• return(optional): array Resource Group Life Cycle Task Runtime Reference
  Title: Resource Group Life Cycle Task Runtime Reference

  Contains the resource group life cycle task runtime reference.

  Returns the action's result.

{
    "type":"object",
    "title":"Return",
    "properties":{
        "return":{
            "title":"Resource Group Life Cycle Task Runtime Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the resource group life cycle task runtime reference. <p>Returns the action's result.</p>"
        }
    },
    "description":""
}

Nested Schema : Resource Group Life Cycle Task Runtime Reference

Type: array

Title: Resource Group Life Cycle Task Runtime Reference

Contains the resource group life cycle task runtime reference.

Returns the action's result.

Show Source

• Array of: string

{
    "title":"Resource Group Life Cycle Task Runtime Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the resource group life cycle task runtime reference. <p>Returns the action's result.</p>"
}

Back to Top