Jump to

• Request
• Response

Shutdown ( Timeout, Ignore Sessions, Wait For All Sessions, Targets )

post

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

Begins to shut down this partition gracefully on the specified targets.

Use the returned PartitionLifeCycleTaskRuntimeMBean value to check for completion

Please use PartitionLifeCycleRuntimeMBean.shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions, 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

  Set to true to ignore pending HTTP sessions during inflight work handling.

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

  Contains the array of target references.

  the specific targets on which to shut down this partition

• timeout(optional): integer(int32)

  Number of seconds to wait before aborting inflight work and force shutting down the server.

• waitForAllSessions(optional): boolean

  Set to true to wait for all HTTP sessions duirng inflight work handling; false to wait for non-persisted HTTP sessions only.

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "ignoreSessions":{
            "type":"boolean",
            "description":"<p>Set to <code>true</code> to ignore pending HTTP sessions during inflight work handling.</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 shut down this partition</p>"
        },
        "timeout":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Number of seconds to wait before aborting inflight work and force shutting down the server.</p>"
        },
        "waitForAllSessions":{
            "type":"boolean",
            "description":"<p>Set to <code>true</code> to wait for all HTTP sessions duirng inflight work handling; <code>false</code> to wait for non-persisted HTTP sessions only.</p>"
        }
    },
    "description":""
}

Nested Schema : Target References

Type: array

Title: Target References

Contains the array of target references.

the specific targets on which to shut down 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 shut down 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