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

/management/wls/{version}/deployments/library

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

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

GETメソッド

このリソースのGETメソッドは、このWLSドメイン内のすべてのライブラリのリストを返します。

ロール

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

レスポンス本文

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

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

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

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

レスポンス・コード

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

例

例1   ライブラリの表示

この例は、GETメソッドを使用して、すべてのライブラリのサマリーを返します。

リクエストの例

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

レスポンスの例

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\/library\/id\/airline",
            "title": "airline"
        }
    ],
    "items": [{
        "name": "airline",
        "state": "active",
        "type": "library",
        "targets": ["myserver"],
        "displayName": "airline",
        "deploymentPath": "\/deployments\/airline.war"
    }]
}

OPTIONSメソッド

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

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

ロール

管理者

レスポンス本文

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

レスポンス・コード

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

例

例1   テンプレートLibraryエンティティの取得

この例は、OPTIONSメソッドを使用して、ライブラリ・デプロイメントのテンプレートを取得します。

リクエストの例

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

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{"item": {
    "name": null,
    "state": null,
    "type": "library",
    "targets": null,
    "displayName": null,
    "specVersion": null,
    "implVersion": null,
    "deploymentPath": null,
    "referencingApplications": null,
    "referencingLibraries": null
}}

POSTメソッド

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

application/json"を受け入れるPOST

このPOSTメソッドは新規ライブラリをデプロイします。

ロール

管理者

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

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

_detached

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

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

リクエスト本文

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

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは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: 'airline',
    deploymentPath: '/deployments/airline.war',
    targets: [ 'myserver', 'Cluster-0' ]
}" \
-X POST http://localhost:7001/management/wls/latest/deployments/library

レスポンスの例

HTTP/1.1 201 Created

Location: http://localhost:7001/management/wls/latest/deployments/library/id/airline

Response Body:
{
    "messages": [{
        "message": "Deployed the library 'airline'.",
        "severity": "SUCCESS"
    }],
    "links": [{
        "rel": "job",
        "uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/1"
    }],
    "item": {
        "operation": "deploy",
        "status": "completed",
        "beginTime": 1390587116296,
        "endTime": 1390587116676,
        "name": "ADTR-1",
        "id": "1",
        "type": "deployment",
        "targets": [
            {
                "errors": [],
                "status": "completed",
                "name": "Cluster-0",
                "type": "cluster"
            },
            {
                "errors": [],
                "status": "completed",
                "name": "myserver",
                "type": "server"
            }
        ],
        "deploymentName": "airline",
        "description": "[Deployer:149117]deploy library airline on Cluster-0,myserver."
    }
}
例2   ライブラリの非同期デプロイ

この例は、POSTメソッドを使用して、新規ライブラリを非同期でデプロイします。

リクエストの例

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

レスポンスの例

HTTP/1.1 201 Created

Location: http://localhost:7001/management/wls/latest/deployments/library/id/airline

Response Body:
{
    "messages": [{
        "message": "Deployed the library 'airline'.",
        "severity": "SUCCESS"
    }],
    "links": [{
        "rel": "job",
        "uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/1"
    }],
    "item": {
        "operation": "deploy",
        "status": "completed",
        "beginTime": 1390587116296,
        "endTime": 1390587116676,
        "name": "ADTR-1",
        "id": "1",
        "type": "deployment",
        "targets": [
            {
                "errors": [],
                "status": "completed",
                "name": "Cluster-0",
                "type": "cluster"
            },
            {
                "errors": [],
                "status": "completed",
                "name": "myserver",
                "type": "server"
            }
        ],
        "deploymentName": "airline",
        "description": "[Deployer:149117]deploy library airline on Cluster-0,myserver."
    }
}

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

このPOSTメソッドは新規ライブラリをアップロードおよびデプロイします。

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

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

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

ロール

管理者

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

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

_detached

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

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

リクエスト本文

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

model

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

deployment

(必須)デプロイするライブラリを指定します。Content-Dispositionヘッダーの名前パラメータはdeploymentに設定する必要があり、ファイル名パラメータは、ライブラリのサーバー上でのファイル名に設定する必要があります。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: 'airline',
    targets: [ 'myserver' ]
}" \
-F "deployment=@/deployments/airline.war" \
-X POST http://localhost:7001/management/wls/latest/deployments/library

レスポンスの例

 HTTP/1.1 201 Created

Location: http://localhost:7001/management/wls/latest/deployments/library/id/airline

Response Body:
{
    "messages": [{
        "message": "Deployed the library 'airline'.",
        "severity": "SUCCESS"
    }],
    "links": [{
        "rel": "job",
        "uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/7"
    }],
    "item": {
        "operation": "deploy",
        "status": "completed",
        "beginTime": 1390587130807,
        "endTime": 1390587131056,
        "name": "ADTR-7",
        "id": "7",
        "type": "deployment",
        "targets": [{
            "errors": [],
            "status": "completed",
            "name": "myserver",
            "type": "server"
        }],
        "deploymentName": "airline",
        "description": "[Deployer:149117]deploy library airline on myserver."
    }
}
例2   ライブラリの非同期アップロードおよびデプロイ

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

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:multipart/form-data \
-F "model={
    name: 'airline',
    targets: [ 'myserver' ]
}" \
-F "deployment=@/deployments/airline.war" \
-X POST http://localhost:7001/management/wls/latest/deployments/library?__detached=true

レスポンスの例

HTTP/1.1 202 Accepted

Location: http://localhost:7001/management/wls/latest/deployments/library/id/airline

Response Body:
{
    "messages": [{
        "message": "Deploying the library 'airline'.",
        "severity": "SUCCESS"
    }],
    "links": [{
        "rel": "job",
        "uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/11"
    }]
}
  前
前 		 次
次
  目次へ移動
目次