Oracle WebLogic ServerのRESTfulドメイン実行時管理インタフェース

shutdown ( timeout, ignoreSessions )

post

/management/weblogic/{version}/domainRuntime/serverLifeCycleRuntimes/{name}/shutdown

サーバーを正常にSHUTDOWN状態に遷移させます。停止する前に、サーバーはすべての現在の作業を完了します。

このメソッドは次の呼出しと同じになります。

shutdown(timeout, ignoreSessions, false);

このメソッドは、非同期呼出しとベスト・エフォート同期呼出しの両方をサポートします。動作は'Prefer'ヘッダーによって制御されます。

リクエスト

サポートされているメディア・タイプ

application/json

パス・パラメータ

name: string

コレクション内のインスタンスのnameプロパティ。
version: string

WebLogic RESTインタフェースのバージョン。

ヘッダー・パラメータ

Prefer (オプション): string

'Prefer'ヘッダー・パラメータを使用すると、このメソッドの実行方法に関するプリファレンスを指定できます。値を'respond-async'にすると、リクエストを発行し、完了を待機せずにすぐに返すというプリファレンスになります。また、値を'wait =#seconds'にすると、メソッドが完了するまで#seconds間待機してから返すというプリファレンスになります。Preferヘッダーが指定されていないか無効な場合、待機時間は300秒になります。
X-Requested-By: string

'X - Requested - By'ヘッダーは、クロスサイト・リクエスト・フォージェリ(CSRF)攻撃からの保護に使用されます。値は、'MyClient'など任意の名前です。

次のフィールドが必要です。

ルート・スキーマ: Arguments

型: object

タイトル: Arguments

ソースを表示

ignoreSessions (オプション): boolean

処理中の作業を扱う際に保留中のHTTPセッションを無視する場合はtrueに設定します。
timeout (オプション): integer(int32)

処理中の作業を中止してサーバーを強制停止するまでの待機秒数。

{
    "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>"
        },
        "timeout":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Number of seconds to wait before aborting inflight work and force shutting down the server.</p>"
        }
    },
    "description":""
}

セキュリティ

Admin: basic

タイプ: Basic

説明: A user in the Admin security role.
オペレータ: basic

タイプ: Basic

説明: A user in the Operator security role.

トップに戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

次のフィールドを返します。

ルート・スキーマ: Return

型: object

タイトル: Return

ソースを表示

return (オプション): array Server Life Cycle Task Runtime Reference

タイトル: Server Life Cycle Task Runtime Reference

サーバー・ライフサイクル・タスク・ランタイム参照が含まれます。
アクションの結果を返します。

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

ネストされたスキーマ: Server Life Cycle Task Runtime Reference

型: array

タイトル: Server Life Cycle Task Runtime Reference

サーバー・ライフサイクル・タスク・ランタイム参照が含まれます。

アクションの結果を返します。

ソースを表示

配列: 文字列

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

トップに戻る

例

shutdownアクションを同期的に呼び出します。

この例では、POSTメソッドを使用してshutdownアクションの同期呼出しを行います。

リクエストの例

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 20, ignoreSessions: true }" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_11_shutdown"
    }],
    "progress": "success",
    "serverName": "Cluster-0-Server-1",
    "operation": "shutdown",
    "taskStatus": "TASK COMPLETED",
    "completed": true
}

shutdownアクションを非同期的に呼び出します。

この例では、POSTメソッドを使用してshutdownアクションの非同期呼出しを行います。

リクエストの例

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{ timeout: 20, ignoreSessions: true }" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/shutdown?links=job,abort&fields=completed,progress,serverName,operation,taskStatus

レスポンスの例

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_25_shutdown

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/serverLifeCycleRuntimes/Cluster-0-Server-1/tasks/_25_shutdown"
    }],
    "progress": "processing",
    "serverName": "Cluster-0-Server-1",
    "operation": "shutdown",
    "taskStatus": "TASK IN PROGRESS",
    "completed": false
}

トップに戻る