Jump to

• Request
• Response

Suspend ( Timeout, Ignore Sessions, Targets )

post

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

Begins the graceful transition of the partition from the RUNNING state to the ADMIN state on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Applications are in admin mode. Inflight work is completed.

Please use PartitionLifeCycleRuntimeMBean.suspend(int timeout, boolean ignoreSessions, String[] targetNames)

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

• targets(optional): array Target References
  Title: Target References

  Contains the array of target references.

  the specific targets on which to suspend this partition

• timeout(optional): integer(int32)

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

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "ignoreSessions":{
            "type":"boolean",
            "description":"<p>drop inflight HTTP sessions during graceful suspend</p>"
        },
        "targets":{
            "title":"Target References",
            "type":"array",
            "items":{
                "title":"Target Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the target reference."
            },
            "description":"Contains the array of target references. <p>the specific targets on which to suspend this partition</p>"
        },
        "timeout":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Seconds to wait for the partition to transition gracefully. The partition automatically calls forceSuspend() after timeout.</p>"
        }
    },
    "description":""
}

Nested Schema : Target References

Type: array

Title: Target References

Contains the array of target references.

the specific targets on which to suspend this partition

Show Source

• Array of: object Target Reference
  Title: Target Reference

  Contains the target reference.

{
    "title":"Target References",
    "type":"array",
    "items":{
        "title":"Target Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the target reference."
    },
    "description":"Contains the array of target references. <p>the specific targets on which to suspend this partition</p>"
}

Nested Schema : Target Reference

Type: object

Title: Target Reference

Contains the target reference.

Show Source

• identity(optional): array Identity
  Title: Identity

  DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

{
    "title":"Target Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the target reference."
}

Nested Schema : Identity

Type: array

Title: Identity

DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

Show Source

• Array of: string

{
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}

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 Partition Life Cycle Task Runtime Reference
  Title: Partition Life Cycle Task Runtime Reference

  Contains the partition life cycle task runtime reference.

  Returns the action's result.

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

Nested Schema : Partition Life Cycle Task Runtime Reference

Type: array

Title: Partition Life Cycle Task Runtime Reference

Contains the partition life cycle task runtime reference.

Returns the action's result.

Show Source

• Array of: string

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

Back to Top