RESTful Server Runtime Management Interface for Oracle WebLogic Server

Capture Image ( Destination, Lockout Minutes )

post

/management/weblogic/{version}/serverRuntime/WLDFRuntime/WLDFImageRuntime/captureImage

Creates a diagnostic image in the specified destination directory, which can be specified either as a relative or absolute pathname. If relative, the path is relative to the server's logs directory.

If the directory does not exist, it is created. If the directory exists, it must be writable in order for image creation to proceed.

No additional image capture requests will be accepted until the specified lockout period has expired.

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

version(required): string

The version of the WebLogic REST interface.

Header Parameters

Prefer: 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(required): 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'.

Must contain the following fields:

Root Schema : Arguments

Type: object

Title: Arguments

Show Source

destination: string

absolute or relative path
lockoutMinutes: integer(int32)

number of minutes before next image capture request will be accepted

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "destination":{
            "type":"string",
            "description":"<p>absolute or relative path</p>"
        },
        "lockoutMinutes":{
            "type":"integer",
            "format":"int32",
            "description":"<p>number of minutes before next image capture request will be accepted</p>"
        }
    },
    "description":""
}

Security

Admin: basic

Type: basic

Description: A user in the Admin security role.

Response

Supported Media Types

application/json

200 Response

Returns the following fields:

Root Schema : Return

Type: object

Title: Return

Show Source

return: array WLDF Image Creation Task Runtime Reference

Title: WLDF Image Creation Task Runtime Reference

Contains the WLDF image creation task runtime reference.
Returns the action's result.

{
    "type":"object",
    "title":"Return",
    "properties":{
        "return":{
            "title":"WLDF Image Creation Task Runtime Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the WLDF image creation task runtime reference. <p>Returns the action's result.</p>"
        }
    },
    "description":""
}

Nested Schema : WLDF Image Creation Task Runtime Reference

Type: array

Title: WLDF Image Creation Task Runtime Reference

Contains the WLDF image creation task runtime reference.

Returns the action's result.

Show Source

Array of: string

{
    "title":"WLDF Image Creation Task Runtime Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the WLDF image creation task runtime reference. <p>Returns the action's result.</p>"
}