Oracle WebLogic Server MTのRESTfuドメイン実行時管理インタフェース(非推奨) -アンデプロイ(ターゲット、デプロイメント・オプション)

アンデプロイ(ターゲット、デプロイメント・オプション)

post

/management/weblogic/{version}/domainRuntime/domainPartitionRuntimes/{name}/deploymentManager/appDeploymentRuntimes/{name}/undeploy

指定のオプションで指定したターゲットに対し、アプリケーションをバックグラウンドでアンデプロイします。これは非同期操作で、即座に戻ります。戻されたDeploymentProgressObjectMBeanを使用して、操作が完了した時点を判別できます。

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

リクエスト

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

application/json

パス・パラメータ

name: string

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

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

ヘッダー・パラメータ

Prefer(optional): string

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

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

次のフィールドが含まれている必要があります:

ルート・スキーマ: Arguments

型: object

タイトル: Arguments

ソースの表示

deploymentOptions(optional): object プロパティ

タイトル: Properties

使用可能なその他のプロパティ: additionalProperties

デプロイメント・オプションをオーバーライドできます。nullの場合、デフォルト・オプションが使用されます。値はすべて型を持ちます。オプションのキー、単位およびデフォルト値は、clusterDeploymentTimeout ミリ秒 3600000、gracefulIgnoreSessions boolean false、gracefulProductionToAdmin boolean false、retireGracefully boolean true、retireTimeout 秒 -1(タイムアウトなし)、adminMode boolean false、timeout ミリ秒 0(タイムアウトなし)です
targets(optional): array 項目

タイトル: Items

アプリケーションをアンデプロイするターゲット。これは、weblogic.Deployerと同様の形式のサーバー名、クラスタ名またはモジュール名です(module1@server1など)。nullの場合、アプリケーションは構成されているすべてのターゲットでアンデプロイされます。

{
    "type":"object",
    "title":"Arguments",
    "properties":{
        "deploymentOptions":{
            "type":"object",
            "description":"<p>Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)</p>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        },
        "targets":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The targets on which to undeploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be undeployed on all configured targets.</p>"
        }
    },
    "description":""
}

ネストされたスキーマ: Properties

型: object

タイトル: Properties

使用可能なその他のプロパティ

ソースの表示

string

{
    "type":"object",
    "description":"<p>Allows for overriding the deployment options. If null, default options will be used. The values should all be of type The keys,units and default values for options are clusterDeploymentTimeout milliseconds 3600000, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)</p>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}

デプロイメント・オプションをオーバーライドできます。nullの場合、デフォルト・オプションが使用されます。値はすべて型を持ちます。オプションのキー、単位およびデフォルト値は、clusterDeploymentTimeout ミリ秒 3600000、gracefulIgnoreSessions boolean false、gracefulProductionToAdmin boolean false、retireGracefully boolean true、retireTimeout 秒 -1(タイムアウトなし)、adminMode boolean false、timeout ミリ秒 0(タイムアウトなし)です

ネストされたスキーマ: Items

型: array

タイトル: Items

アプリケーションをアンデプロイするターゲット。これは、weblogic.Deployerと同様の形式のサーバー名、クラスタ名またはモジュール名です(module1@server1など)。nullの場合、アプリケーションは構成されているすべてのターゲットでアンデプロイされます。

ソースの表示

配列: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The targets on which to undeploy the application. This would be server names, cluster names, or module names in a similar format to weblogic.Deployer (i.e. module1@server1). If null, the application will be undeployed on all configured targets.</p>"
}

セキュリティ

Admin: basic

タイプ: Basic

説明: A user in the Admin security role.
Deployer: basic

タイプ: Basic

説明: A user in the Deployer security role.
Operator: basic

タイプ: Basic

説明: A user in the Operator security role.

先頭に戻る

レスポンス

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

application/json

200レスポンス

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

ルート・スキーマ: Return

型: object

タイトル: Return

ソースの表示

return(optional): array デプロイメント進行状況オブジェクト・リファレンス

タイトル: Deployment Progress Object Reference

デプロイメント進行状況オブジェクトのリファレンスが含まれます。
アクションの結果を返します。

{
    "type":"object",
    "title":"Return",
    "properties":{
        "return":{
            "title":"Deployment Progress Object Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the deployment progress object reference. <p>Returns the action's result.</p>"
        }
    },
    "description":""
}

ネストされたスキーマ: Deployment Progress Object Reference

型: array

タイトル: Deployment Progress Object Reference

デプロイメント進行状況オブジェクトのリファレンスが含まれます。

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

ソースの表示

配列: string

{
    "title":"Deployment Progress Object Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the deployment progress object reference. <p>Returns the action's result.</p>"
}

先頭に戻る