Oracle WebLogic Server RESTful編集管理インタフェース

アプリケーションのデプロイ

post

/management/weblogic/{version}/edit/appDeployments

このリソースは、すでに管理サーバー上にあるアプリケーションをデプロイするために使用されます。アプリケーションは、サポートされているパッケージ・タイプ(たとえば、EARまたはWARモジュール)である必要があります。

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

リクエスト

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

application/json

パス・パラメータ

version(required): string

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

ヘッダー・パラメータ

Prefer: string

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

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

アプリケーションをデプロイするには、アプリケーションの名前、管理サーバー上のデプロイ可能ユニットのソースへのパス、およびアプリケーションのデプロイ先となるターゲットを指定する必要があります。

ソース・パスが相対パスの場合、InstallDirがnullでなければ、InstallDir/appを基準とした相対パスとして解決されます。それ以外の場合、ドメイン・ルートを基準とした相対パスとして解決されます。

ルート・スキーマ: Model

タイプ: object

タイトル: Model

ソースを表示

name(required): string

このデプロイメントのユーザー定義の名前。
この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています
Name=user-specified-name
planPath: string

管理サーバー上のデプロイメント・プラン・ドキュメントへのパス。
プラン・パスが相対パスの場合、PlanDirがnullでなければ、PlanDirを基準とした相対パスとして解決されます。それ以外の場合、ドメイン・ルートを基準とした相対パスとして解決されます。
planVersion: string

デプロイメント・プランのバージョン(オプション)。
sourcePath(required): string

管理サーバー上のデプロイ可能なユニットのソースへのパス。
ソース・パスが相対パスの場合、InstallDirがnullでなければ、InstallDir/appを基準とした相対パスとして解決されます。それ以外の場合、ドメイン・ルートを基準とした相対パスとして解決されます。
targets: array Target References

タイトル: Target References

ターゲット参照の配列を含みます。
このアプリケーションがデプロイされるクラスタまたはサーバー(あるいはその両方)。ターゲットが重複している場合、デプロイメントは1回のみ行われます。

{
    "type":"object",
    "title":"Model",
    "properties":{
        "name":{
            "type":"string",
            "description":"<p>The user-specified name of this deployment.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p>"
        },
        "planPath":{
            "type":"string",
            "description":"<p>The path to the deployment plan document on the Administration Server.</p><p>If the plan path is a relative path, it is resolved relative to PlanDir if PlanDir is not null;otherwise, it is resolved relative to the domain root.</p>"
        },
        "planVersion":{
            "type":"string",
            "description":"<p>The deployment plan's version (optional).</p>"
        },
        "sourcePath":{
            "type":"string",
            "description":"<p>The path to the source of the deployable unit on the Administration Server.</p><p>If the source path is relative, it is resolved relative to <code><i>InstallDir/app</i></code> ifInstallDir is not null; otherwise, it is resolved relative to the domain root.</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 clusters and/or servers on which this application will be deployed.The deployment will only occur once if the targets overlap.</p>"
        }
    },
    "required":[
        "name",
        "sourcePath"
    ],
    "description":""
}

ネストされたスキーマ: Target References

タイプ: array

タイトル: Target References

ターゲット参照の配列を含みます。

このアプリケーションがデプロイされるクラスタまたはサーバー(あるいはその両方)。ターゲットが重複している場合、デプロイメントは1回のみ行われます。

ソースを表示

配列: object Target Reference

タイトル: 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 clusters and/or servers on which this application will be deployed.The deployment will only occur once if the targets overlap.</p>"
}

ネストされたスキーマ: Target Reference

タイプ: object

タイトル: Target Reference

ターゲット参照を含みます。

ソースを表示

identity: array Identity

タイトル: Identity

DOC TEAM TBD - アイデンティティの説明 - 別のWLS RESTリソースへの参照です。

{
    "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."
}

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

タイプ: array

タイトル: Identity

DOC TEAM TBD - アイデンティティの説明 - 別のWLS RESTリソースへの参照です。

ソースを表示

配列: 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."
}

セキュリティ

管理者: 基本

タイプ: basic

説明: A user in the Admin security role.
デプロイヤ: 基本

タイプ: basic

説明: A user in the Deployer security role.

トップに戻る

レスポンス

201レスポンス

トップに戻る

例

新しいアプリケーション・デプロイメントを同期的に作成します。

この例では、POSTメソッドを使用してこのコレクションの新しいアプリケーション・デプロイメントを同期的に作成します。

リクエストの例

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
  name: 'fairShare',
  sourcePath: '/deployments/fairShare.war',
  targets: [
    { identity: [ 'servers',  'AdminServer' ] },
    { identity: [ 'clusters', 'Cluster-0'   ] }
  ]
}" \
-X POST http://localhost:7001/management/weblogic/latest/edit/appDeployments?links=job,abort&fields=completed,progress,error,state,operationType,applicationName

レスポンスの例

HTTP/1.1 201 Created

Location: http://localhost:7001/management/weblogic/latest/edit/appDeployments/fairShare

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/deploymentManager/deploymentProgressObjects/fairShare"
    }],
    "operationType": 3,
    "state": "STATE_COMPLETED",
    "applicationName": "fairShare",
    "progress": "success",
    "completed": true
}

新しいアプリケーション・デプロイメントを非同期的に作成します。

この例では、POSTメソッドを使用してこのコレクションの新しいアプリケーション・デプロイメントを非同期的に作成します。

リクエストの例

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
  name: 'fairShare',
  sourcePath: '/deployments/fairShare.war',
  targets: [
    { identity: [ 'servers',  'AdminServer' ] },
    { identity: [ 'clusters', 'Cluster-0'   ] }
  ]
}" \
-H "Prefer:respond-async" \
-X POST http://localhost:7001/management/weblogic/latest/edit/appDeployments?links=job,abort&fields=completed,progress,error,state,operationType,applicationName

レスポンスの例

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/weblogic/latest/domainRuntime/deploymentManager/deploymentProgressObjects/fairShare

Response Body:
{
    "links": [{
        "rel": "job",
        "href": "http:\//localhost:7001/management/weblogic/latest/domainRuntime/deploymentManager/deploymentProgressObjects/fairShare"
    }],
    "operationType": 3,
    "state": "STATE_RUNNING",
    "applicationName": "fairShare",
    "progress": "processing",
    "completed": false
}

トップに戻る