RESTful Server Runtime Management Interface for Oracle WebLogic Server

Capture A Diagnostic Image

post

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

Creates a diagnostic image in the configured destination directory and adds it to this collection.

No additional image capture requests will be accepted until the specified lockout period has expired. If lockoutMinutes is not specified, then the configured default lockout value for the server is used.

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'.

Specifies how a new WLDFCapturedImage is captured.

Root Schema : Lockout

Type: object

Title: Lockout

Show Source

lockoutMinutes: string

Number of minutes before the next image capture request will be accepted.
This field is optional, and if not specified, the configured default lockout value for the server is used.

{
    "type":"object",
    "title":"Lockout",
    "properties":{
        "lockoutMinutes":{
            "type":"string",
            "description":"<p>Number of minutes before the next image capture request will be accepted.</p><p>This field is optional, and if not specified, the configured default lockout value for the server is used.</p>"
        }
    },
    "description":""
}

Security

Admin: basic

Type: basic

Description: A user in the Admin security role.

Response

200 Response

Examples

Synchronously capture a diagnostics image.

This example uses the POST method to synchronously capture a diagnostics image without a lockout period so that new images can be captured immediately.

Example Request

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{lockoutMinutes:0}" \
-X POST http://localhost:7001/management/weblogic/latest/serverRuntime/WLDFRuntime/WLDFImageRuntime/capturedImages

Example Response

HTTP/1.1 201 Created

Location: http://localhost:7001/management/weblogic/latest/serverRuntime/WLDFRuntime/WLDFImageRuntime/capturedImages/diagnostic_image_AdminServer_2024_09_17_16_31_10.zip

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/serverRuntime/WLDFRuntime/WLDFImageRuntime/imageCaptureTasks/DiagnosticImageCaptureTaskRuntime_1"
    }],
    "identity": [
        "WLDFRuntime",
        "WLDFImageRuntime",
        "imageCaptureTasks",
        "DiagnosticImageCaptureTaskRuntime_1"
    ],
    "running": false,
    "systemTask": false,
    "endTimeAsLong": 1726605076385,
    "imageFileName": "diagnostic_image_AdminServer_2024_09_17_16_31_10.zip",
    "name": "DiagnosticImageCaptureTaskRuntime_1",
    "progress": "success",
    "description": "\/domains/mydomain/servers/AdminServer/logs/diagnostic_images/diagnostic_image_AdminServer_2024_09_17_16_31_10.zip",
    "taskError": null,
    "startTimeAsLong": 1726605070317,
    "type": "WLDFImageCreationTaskRuntime",
    "taskStatus": "Completed",
    "parentTask": null,
    "completed": true,
    "intervalToPoll": 1000,
    "startTime": "2024-09-17T16:31:10.317-04:00",
    "endTime": "2024-09-17T16:31:16.385-04:00"
}