プライマリ・コンテンツに移動
Oracle Fusion Middleware Oracle WebLogic Server 12.1.3 RESTful管理インタフェース・リファレンス
12c (12.1.3)
E57542-02
  目次へ移動
目次
前
前 		 次
次		  

/management/wls/{version}/deployments/application

このリソースは、このWLSドメインにデプロイされているアプリケーションを管理します。

リソースでは、次のメソッドがサポートされます。

GETメソッド

このリソースのGETメソッドは、このWLSドメイン内のすべてのアプリケーションのリストを返します。

ロール

管理者、デプロイヤ、オペレータ、モニター

リクエスト問合せパラメータ

このメソッドでは、レスポンスに含められるフィールドの制限に使用できるオプションの問合せパラメータがサポートされます。必要とする情報のみにフィールドを制限すると、大規模なデータ・セットとやりとりする際にレスポンス時間を短縮できます。

?_excludeFields=field1[,field2, ...]

(オプション)これらの値が必須ではなく、レスポンスで省略可能であることを指定します。

?_includeFields=field1[,field2, ...]

(オプション)これらの値が必須であり、レスポンスに含める必要があることを指定します。

包含と除外は相互に排他的であり、いずれも指定しない場合すべての使用可能な情報が含まれます。

レスポンス本文

返されるレスポンス本文には、Applicationエンティティの集合が含まれます。また、対応するリソースへのリンクも含まれます。

このメソッドは次のリンクを返すことができます。

  • uri=/management/wls/{version}/deployments rel=parent

  • uri=/management/wls/{version}/deployments/application/id/{application-name} rel=items.name title=name

レスポンス・コード

このメソッドは、標準のHTTPステータス・コードのいずれかを返します。

例

例1   アプリケーションの表示

この例は、GETメソッドを使用して、このWLSドメイン内のアプリケーションをすべてリストします。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/deployments/application

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
    "links": [
        {
            "rel": "parent",
            "uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments"
        },
        {
            "rel": "items.name",
            "uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/application\/id\/fairShare",
            "title": "fairShare"
        }
    ],
    "items": [{
        "name": "fairShare",
        "state": "active",
        "type": "application",
        "targets": [
            "myserver",
            "Cluster-0"
        ],
        "servlets": [
            {
                "servletName": "SimpleSlowServlet",
                "contextPath": "\/fairShare",
                "aggregateMetrics": {
                    "executionTimeTotal": 0,
                    "invocationTotalCount": 0,
                    "reloadTotalCount": 0,
                    "executionTimeHigh": 0,
                    "executionTimeLow": 0
                },
                "servletMetrics": [
                    {
                        "serverName": "myserver",
                        "executionTimeTotal": 0,
                        "invocationTotalCount": 0,
                        "reloadTotalCount": 0,
                        "executionTimeHigh": 0,
                        "executionTimeLow": 0
                    }
                ]
            },
            {
                "servletName": "SimpleFastServlet",
                "contextPath": "\/fairShare",
                "aggregateMetrics": {
                    "executionTimeTotal": 0,
                    "invocationTotalCount": 0,
                    "reloadTotalCount": 0,
                    "executionTimeHigh": 0,
                    "executionTimeLow": 0
                },
                "servletMetrics": [
                    {
                        "serverName": "myserver",
                        "executionTimeTotal": 0,
                        "invocationTotalCount": 0,
                        "reloadTotalCount": 0,
                        "executionTimeHigh": 0,
                        "executionTimeLow": 0
                    }
                ]
            },
            {
                "servletName": "JspServlet",
                "contextPath": "\/fairShare",
                "aggregateMetrics": {
                    "executionTimeTotal": 0,
                    "invocationTotalCount": 0,
                    "reloadTotalCount": 0,
                    "executionTimeHigh": 0,
                    "executionTimeLow": 0
                },
                "servletMetrics": [
                    {
                        "serverName": "myserver",
                        "executionTimeTotal": 0,
                        "invocationTotalCount": 0,
                        "reloadTotalCount": 0,
                        "executionTimeHigh": 0,
                        "executionTimeLow": 0
                    }
                ]
            },
            {
                "servletName": "FileServlet",
                "contextPath": "\/fairShare",
                "aggregateMetrics": {
                    "executionTimeTotal": 0,
                    "invocationTotalCount": 0,
                    "reloadTotalCount": 0,
                    "executionTimeHigh": 0,
                    "executionTimeLow": 0
                },
                "servletMetrics": [
                    {
                        "serverName": "myserver",
                        "executionTimeTotal": 0,
                        "invocationTotalCount": 0,
                        "reloadTotalCount": 0,
                        "executionTimeHigh": 0,
                        "executionTimeLow": 0
                    }
                ]
            }
        ],
        "displayName": "fairShare",
        "urls": [
            "http:\/\/localhost:7001\/fairShare"
        ],
        "planPath": null,
        "applicationType": "war",
        "openSessionsCurrentCount": 0,
        "sessionsOpenedTotalCount": 0,
        "health": {"state": "ok"},
        "deploymentPath": "\/deployments\/fairShare.war",
        "ejbs": []
    }]
}

OPTIONSメソッド

このリソースのOPTIONSメソッドは、デフォルト値が事前移入されているテンプレート・エンティティを返します。

アプリケーションをデプロイする場合、このメソッドを呼び出してテンプレートを取得し、アプリケーションへのパスなどの値を入力して、POSTメソッドでこれを使用してアプリケーションをデプロイします。

ロール

管理者

レスポンス本文

返されるレスポンス本文には、カスタマイズして、アプリケーションのデプロイに使用できるApplicationテンプレート・エンティティが含まれます。

レスポンス・コード

このメソッドは、標準のHTTPステータス・コードのいずれかを返します。

POSTメソッド

リソースでは、次のメソッドがサポートされます。

application/json"を受け入れるPOST

このPOSTメソッドは、デプロイするファイルが管理サーバーのファイル・システムにすでにある場合、新規アプリケーションをデプロイします。

ロール

管理者

リクエスト問合せパラメータ

このリソースは、アプリケーションをデプロイするジョブを起動します。

_detached

(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。

__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。

リクエスト本文

リクエスト本文には、完全に移入された、新規アプリケーションを記述するApplicationエンティティが含まれている必要があります。読取り専用パラメータ値は無視されます。

レスポンス本文

メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。

このメソッドは次のリンクを返すことができます。

  • uri=/wls/jobs/deployment/{job-id} rel=job title=id

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは201 Createdステータス・コードおよび新規アプリケーション・リソースへのリンクを含むLocationヘッダーを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードおよび想定される新規アプリケーション・リソースへのリンクを含むLocationヘッダーを返します。

メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コード、ジョブ・リソースへのリンクおよび想定される新規アプリケーション・リソースへのリンクを含むLocationヘッダーを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。

例

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

この例は、POSTメソッドを使用して、新規アプリケーションをデプロイします。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
    name: 'BasicApp',
    deploymentPath: '/deployments/BasicApp/app/BasicApp.ear',
    targets: [ 'myserver' ]
}" \
-X POST http://localhost:7001/management/wls/latest/deployments/application

レスポンスの例

HTTP/1.1 201 Created

Location: http://localhost:7001/management/wls/latest/deployments/application/id/BasicApp

Response Body:
{
    "messages": [{
        "message": "Deployed the application 'BasicApp'.",
        "severity": "SUCCESS"
    }],
    "links": [{
        "rel": "job",
        "uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/0"
    }],
    "item": {
        "operation": "deploy",
        "status": "completed",
        "beginTime": 1390587114114,
        "endTime": 1390587115796,
        "name": "ADTR-0",
        "id": "0",
        "type": "deployment",
        "targets": [{
            "errors": [],
            "status": "completed",
            "name": "myserver",
            "type": "server"
        }],
        "deploymentName": "BasicApp",
        "description": "[Deployer:149026]deploy application BasicApp on myserver."
    }
}
例2   アプリケーションの非同期デプロイ

この例は、POSTメソッドを使用して、新規アプリケーションを非同期でデプロイします。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
    name: 'fairShare',
    deploymentPath: '/deployments/fairShare.war'
}" \
-X POST http://localhost:7001/management/wls/latest/deployments/application?__detached=true

レスポンスの例

 HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/wls/latest/deployments/application/id/fairShare

Response Body:
{
    "messages": [{
        "message": "Deploying the application 'fairShare'.",
        "severity": "SUCCESS"
    }],
    "links": [{
        "rel": "job",
        "uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/31"
    }]
}

"multipart/form-data"を受け入れるPOST

このPOSTメソッドは、デプロイするファイルが管理サーバーのファイル・システムに存在しない場合、新規アプリケーションをデプロイします。デプロイするファイルをクライアントのファイル・システムから管理サーバーのファイル・システムにアップロードし、次にこれらをデプロイします。

注意: マルチパート・フォームを使用して作成する場合、次を実行する必要があります。

  1. deploymentフォーム要素を使用してデプロイするファイルを指定します。

  2. planフォーム要素を使用してデプロイするプランを指定します。

  3. modelフォーム要素を使用して、テンプレートの他の部分で送信します。

ロール

管理者

リクエスト問合せパラメータ

このリソースは、アプリケーションをアップロードしデプロイするジョブを起動します。

_detached

(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。

__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。

リクエスト本文

リクエスト本文には、multipart/form-dataのContent-Typeヘッダーを含むフォーム・データおよび次のフォーム・フィールドが含まれます。

model

(必須)デプロイメント・アーカイブとその対応するデプロイメント・プラン以外の、デプロイするアプリケーションに関するすべての必要な情報を指定します。Content-Dispositionヘッダーの名前パラメータはmodelに設定する必要があります。Content-Typeヘッダーはapplication/jsonである必要があり、コンテンツは、Applicationエンティティを含みdeploymentとplanフィールドを除くJSONオブジェクトである必要があります。

deployment

(必須)アップロードするデプロイメント・アーカイブを指定します。Content-Dispositionヘッダーの名前パラメータはdeploymentに設定する必要があり、ファイル名パラメータを、アップロードされるデプロイメント・アーカイブのサーバー上でのファイル名に設定する必要があります。Content-Typeヘッダーはapplication/octet-streamである必要があり、コンテンツはデプロイメント・アーカイブ・データである必要があります。

plan

(オプション)アップロードするデプロイメント・プランを指定します。Content-Dispositionヘッダーの名前パラメータはplanに設定する必要があり、ファイル名パラメータを、アップロードされるデプロイメント・プランのサーバー上でのファイル名に設定する必要があります。Content-Typeヘッダーはapplication/octet-streamである必要があり、コンテンツはデプロイメント・プラン・データである必要があります。

レスポンス本文

メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。

このメソッドは次のリンクを返すことができます。

  • uri=/wls/jobs/deployment/{job-id} rel=job title=id

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは201 Createdステータス・コードおよび新規ライブラリ・リソースへのリンクを含むLocationヘッダーを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードおよび想定される新規ライブラリ・リソースへのリンクを含むLocationヘッダーを返します。

メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コード、ジョブ・リソースへのリンクおよび想定される新規ライブラリ・リソースへのリンクを含むLocationヘッダーを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。

例

例1   アプリケーションのアップロードおよびデプロイ

この例は、POSTメソッドを使用して、デプロイメント・アーカイブをアップロードし、新規アプリケーションとしてデプロイします。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:multipart/form-data \
-F "model={
    name: 'myapp',
    targets: [ 'myserver', 'Cluster-0' ]
}" \
-F "deployment=@/deployments/MyApp/app/MyApp.ear" \
-X POST http://localhost:7001/management/wls/latest/deployments/application

レスポンスの例

HTTP/1.1 100 Continue
 HTTP/1.1 201 Created

Location: http://localhost:7001/management/wls/latest/deployments/application/id/myapp

Response Body:
{
    "messages": [{
        "message": "Deployed the application 'myapp'.",
        "severity": "SUCCESS"
    }],
    "links": [{
        "rel": "job",
        "uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/27"
    }],
    "item": {
        "operation": "deploy",
        "status": "completed",
        "beginTime": 1390587191114,
        "endTime": 1390587192047,
        "name": "ADTR-27",
        "id": "27",
        "type": "deployment",
        "targets": [
            {
                "errors": [],
                "status": "completed",
                "name": "Cluster-0",
                "type": "cluster"
            },
            {
                "errors": [],
                "status": "completed",
                "name": "myserver",
                "type": "server"
            }
        ],
        "deploymentName": "myapp",
        "description": "[Deployer:149026]deploy application myapp on Cluster-0,myserver."
    }
}
  前
前 		 次
次
  目次へ移動
目次