| Oracle® Fusion Middleware Oracle WebLogic Server RESTful管理インタフェース・リファレンス(レガシー) 12c (12.2.1.1.0) E77246-01 |
|
 前 |
 次 |
| Oracle® Fusion Middleware Oracle WebLogic Server RESTful管理インタフェース・リファレンス(レガシー) 12c (12.2.1.1.0) E77246-01 |
|
前 |
次 |
この項では、Oracle WebLogic Serverバージョン12.1.3に実装され、バージョン12.2.1で使用できるOracle WebLogic Server RESTful管理リソースについて説明します。
12.1.3 RESTful管理リソースは、サポートされているすべての環境内のOracle WebLogic Serverプラットフォームを構成、モニタリングおよび管理するための包括的なパブリック・インタフェースを提供します。
12.1.3管理リソースは、デフォルトでドメインで有効で、管理サーバーでのみ使用可能です。管理リソースは、ドメイン・スコープ指定のデフォルト編集セッションのみを使用し、非パーティション化URLでのみ使用可能です。
WebLogic ServerドメインでRESTful管理サービスを使用するには、WebLogic管理者はWebLogic Server管理コンソールを使用してこれらを有効化する必要があります。詳細は、管理コンソール・オンライン・ヘルプのRESTful管理サービスの有効化に関する項を参照してください。または、WebLogic Scripting Tool (WLST)を使用して、DomainMBeanでRestfulManagementService Enabledプロパティを設定します。
WebLogic ServerリソースURLのフォーマットは次のとおりです。
http(s)://host:port/management/wls/{version}/path
説明:
host - WebLogic Serverが実行中のホスト
port - HTTPまたはHTTPSポート
{version} - RESTリソースのバージョン。「リソースURL内の{version}指定子」を参照してください。
path—リソースを識別する相対パス。たとえば、サーバー・インスタンスへのパスはservers/id/myserverとなります。
リソースURLの{version}指定子は、RESTリソースのバージョンを暗黙的(/latest)または明示的(/12.1.3.0)に示します。将来のWLSリリースでは、現在のRESTリソース・バージョンを使用するには/latestを、前のバージョンを指定するにはバージョン番号を指定できます。
ベスト・プラクティスとして、ナビゲーションにブラウザまたはリソース内のリンクに従う再帰クライアントを使用しており、進化するリソースに対応できる場合、/latestを使用します。リソースが進化すると破損するコードを記述している場合、バージョンを明示的に指定します。
WebLogic Server RESTインタフェースは、構成およびモニタリング・オブジェクト・ツリー内のオブジェクトにアクセスするためのメソッドをサポートします。
表1-1は、モニタリングおよび構成データを管理するためのRESTメソッド、および各メソッドで実行できるタスクを示しています。
表1-1 構成データを管理するためのRESTリソース・メソッド
| タスク | RESTメソッド |
|---|---|
|
ツリー内のオブジェクトがサポートするメソッドおよびメソッド・パラメータを特定します。 |
|
|
ツリー内のオブジェクトのデータを取得します。 |
|
|
オブジェクトをツリーに追加します。 |
|
|
ツリー内のオブジェクトを更新します。 |
|
|
ツリーからオブジェクトを削除します。 |
|
WebLogic Server RESTリソースでは次の手順を使用します。
新規エンティティを作成するには、次のようにします。
OPTIONSを呼び出し、新規エンティティのデフォルト値を含むテンプレート・オブジェクトを取得します。
返されたオブジェクトでカスタマイズするプロパティの値を変更します。
変更したオブジェクトをPOSTし、新規エンティティを作成します。
エンティティの一部のプロパティを変更するには、次のようにします。
エンティティのURLでGETを呼び出し、エンティティの現在の値を含むオブジェクトを取得します。
返されたオブジェクトで変更するプロパティの値を変更します。
変更したオブジェクトをPOSTし、エンティティのURLに戻します。
実行時間が長い操作の場合、__detached=true問合せパラメータを指定します(非同期呼出し)。メソッドは、デタッチ(バックグラウンド)・モードで実行され、ジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
_includeFieldsおよび_excludeFields問合せパラメータを指定し、レスポンスに含められるフィールドを制限します。必要とする情報のみに収集結果をフィルタリングすると、大規模なデータ・セットとやりとりする際にレスポンス時間を短縮できます。包含と除外は相互に排他的であり、いずれも指定しない場合すべての使用可能な情報が含まれます。
マルチパート・フォーム・データを使用して、バイトのストリームをクライアントからWLSリソースに渡します。たとえば、デプロイ(または再デプロイ)するファイルが管理サーバーのファイル・システムに存在しない場合などです。"multipart/form-data"を受け入れるPOSTを使用して、ファイルをクライアントのファイル・システムから管理サーバーにアップロードし、デプロイ(再デプロイ)します。
"multipart/form-data"を受け入れるPOSTを使用して、デプロイメントをクライアントからサーバーにアップロードします。サポートされている場合、リソースは異なる2つのPOSTの形式、"application/jason"を受け入れるPOSTおよび"multipart/form-data"を受け入れるPOSTで記述されます。
WebLogic Server RESTインタフェースは、リソース・ツリーの動的なナビゲートをサポートします。このサポートを提供するために、各RESTリソースのGETメソッドは、リソース・ツリー内の前後のリソースへのURIリストを含むlinks要素を返します。これにより、この手法を使用してリソース・ツリーをナビゲートできます。
リテラルでハードコードされた値をURIとして指定して、既知のRESTリソースでHTTP GETリクエストを行います。
リソース内のlinksリストを解析し、適切な親または子リソースを識別します。詳細は、「リンク・リストの解析」を参照してください。
ナビゲートを終了しており、ステップ 2で識別されたRESTリソースが操作を実行する対象である場合、適切なHTTPリクエストで、linksリストから取得したURI値を使用して操作を実行します。
リソース・ツリーのナビゲートを続行する必要がある場合、linksリストから取得されたURI値を使用して、ステップ 2で識別されたRESTリソースでHTTP GETリクエストを行います。その後、ステップ 2に戻ります。
リソース・ツリーの動的ナビゲーションの使用には、様々な利点があります。
各HTTPリクエストにはリテラルなハードコードされたURI値は含まれないため、ソース・コードがよりメンテナンスしやすくなります。
コード・デプロイメント中には名前が不明なサーバーやアプリケーションなどのオブジェクトの集合全体にわたってアクションを実行できます。
HTTP GETリクエストへのレスポンスの一部として返されるlinks要素は、従属要素であり、それぞれ現在のリソースに直接関連する単一リソースを記述します。各従属要素には、次のプロパティが含まれます。
リンクされたリソースが現在のリソースにどのように関連するかを示す文字列値。文字列値は次のとおりです。
リンクされたリソースは、現在のリソースの親です。
リンクされたリソースは、現在のリソースによって表されるオブジェクトでアクションを実行します。titleプロパティの値は、リンクされたリソースが実行するアクションのタイプを示します。
ドット(.)を含まない文字列。リンクされたリソースには、現在のリソース固有の現在のリソースとの関係があります。たとえば、/management/wls/{version}リソースのGETメソッドでは、ドメイン内のオブジェクトのタイプに対応するsimple-name値を含むlinkリスト要素が返されます。
changemanger
datasources
deployments
jobs
servers
targets
1つのドット(.)を含む文字列。リンクされたリソースは、現在のリソースに従属するリソースの集合のメンバーであり、GETレスポンス内の別の要素はリンクされたリソースに関する詳細情報を提供します。このような集合の例として、/management/wls/{version}/serversリソースの下の個別のサーバーがあります。
dotted-name値の最初の部分は、詳細情報を含むGETレスポンス内のリスト要素の名前で、2番目の部分は各下位要素を識別するリスト要素の下位要素内のプロパティ名です。
list-element-name.subelement-property-name
リンクされたリソースに関する詳細情報を検出するには、そのdotted-name値をそのtitle値と組み合せて使用します。
dotted-name値を、その2つの部分であるlist-element-nameとsubelement-property-nameで解析します。
GETレスポンスで、list-element-nameという名前のリスト要素を探します。このリストで、subelement-property-nameプロパティ値が、リンクされたリソースのtitleプロパティ値に一致する下位要素を探します。
たとえば、dotted-name値がitems.nameで、title値がmyserverの場合、nameプロパティ値が文字列myserverと一致するitemsリストの下位要素をGETレスポンスで探します。
リンクされたリソースにアクセスするためにHTTPリクエスト内で使用するURIを含む文字列値。
(オプション)relプロパティ値がactionまたはdotted-nameの場合、追加情報を提供する文字列値。
relプロパティ値がactionの場合、titleプロパティ値は、リンクされたリソースが実行するアクションの種類を記述します。
relプロパティ値がdotted-nameの場合、titleプロパティ値は、dotted-name値によって指定されるリスト要素の下位要素プロパティ内で一致する値です。
この項で説明されているリソースの操作に使用されるHTTPメソッドはすべて、次のHTTPステータス・コードのいずれかを返します。
リクエストは正常に完了しました。200は、成功したGETまたはOPTIONSメソッド、またはリソースを(作成に対して)変更するためのPOSTメソッドに対して返されます。
要求が満たされ、新規リソースが作成されます。新たに作成されたリソースの正規のURIを含むLocationヘッダーが返されます。
201は、同期リソース作成、またはレスポンスが返される前に完了した非同期リソース作成から返されます。
要求の処理は受け入れられましたが、処理は完了していません。要求は、実際に処理が行われる際に拒否される可能性があるため、最終的には処理されない場合もあります。
非同期(__detached=true)リソース作成(アプリケーションのデプロイ時など)または更新(アプリケーションの再デプロイ時など)を指定する際、操作がまだ進行中である場合202が返されます。__detached=falseの場合、基底の操作が適切な時間で終了していないと202が返されることがあります。
レスポンスには、ジョブが終了した時期を検出するためにクライアントが調査する必要があるジョブ・リソースのLocationヘッダーが含まれます。また、ジョブの現在の状態を含むエンティティを返します。
情報が欠落しているか不適切であるため(入力フィールドでの検証エラー、必須値の欠落など)、リクエストを処理できませんでした。
リクエストが認可されていません。このリクエストに認証資格証明がないか、または無効です。
ユーザーを認証できません。ユーザーは、このリクエストを実行する権限を所有していません。
リクエストで、存在しないリソースのURIが指定されました。
リクエストで指定されたHTTP動詞(DELETE、GET、HEAD、POST、PUT)は、このリクエストURIではサポートされていません。
このリクエストによって識別されたリソースは、リクエストのAcceptヘッダーのいずれかのメディア・タイプに対応する表現を生成できません。たとえば、クライアントのAcceptヘッダーは、XMLを要求しますが、リソースはJSONのみを返すことができます。
クライアントのContentTypeヘッダーに誤りがあります(たとえば、クライアントがXMLで送信しようとしたがリソースはJSONのみを受入れ可能な場合など)。
サーバーに予期しない状況が発生し、リクエストを遂行できなくなりました。
現在、サーバーは、一時的なオーバーロードまたはメンテナンスのため、要求を処理できません。WLS REST Webアプリケーションは現在実行中ではありません。
wlsリソースは、WLSドメインによってサポートされるRESTインタフェースのバージョンに関する情報を含みます。
RESTインタフェースによってサポートされるバージョンの詳細は、「リソースURL内の{version}指定子」を参照してください。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、サポートされているこのRESTインタフェースの各バージョンに関する情報を返します。
RESTインタフェースによってサポートされるバージョンの詳細は、「リソースURL内の{version}指定子」を参照してください。
レスポンス本文
返されるレスポンス本文には、サポートされているこのRESTインタフェースのバージョンのリストVersionエンティティが含まれます。
このメソッドは次のリンクを返すことができます。
uri=/management/wls/12.1.3.0 rel=current
uri=/management/wls/12.1.3.0 rel=items.version title=12.1.3.0
uri=/management/wls/latest rel=items.version title=latest
uri=/management/wls/{versions} rel=versions
例
この例は、サポートされているRESTリソースの各バージョンの情報を取得する方法を示しています。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "items.version",
"uri": "http:\/\/localhost:7001\/management\/wls\/12.1.3.0",
"title": "12.1.3.0"
},
{
"rel": "items.version",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest",
"title": "latest"
},
{
"rel": "current",
"uri": "http:\/\/localhost:7001\/management\/wls\/12.1.3.0"
}
],
"items": [
{
"version": "12.1.3.0",
"lifecycle": "active",
"isLatest": true
},
{
"version": "latest",
"lifecycle": "active",
"isLatest": true
}
]
}
このリソースは、WLSドメインの全体的な情報を含みます。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、このドメインの全体的な情報、たとえば、集計されたサーバー実行時統計などを返します。
レスポンス本文
返されるレスポンス本文には、Wlsエンティティが含まれます。
このメソッドは次のリンクを返すことができます。
uri=/management/wls/{version}/changeManager rel=changeManager
uri=/management/wls/{version}/datasources rel=datasources
uri=/management/wls/{version}/deployments rel=deployments
uri=/management/wls/{version}/jobs rel=jobs
uri=/management/wls/{version}/servers rel=servers
uri=/management/wls/{version}/targets rel=targets
例
この例は、ドメインのルートWLSリソース・リンクおよびサマリー情報を取得します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest
レスポンスの例
HTTP/1.1 200 OK
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls"
},
{
"rel": "jobs",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs"
},
{
"rel": "servers",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers"
},
{
"rel": "deployments",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments"
},
{
"rel": "datasources",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources"
},
{
"rel": "changeManager",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/changeManager"
},
{
"rel": "targets",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/targets"
}
],
"item": {
"name": "mydomain",
"productionMode": false,
"activeHttpSessionCount": 0,
"activeThreadCount": 5,
"configuredServerCount": 3,
"activeServerCount": 1,
"overallServiceHealth": {"state": "ok"}
}
}
changeManagerリソースは、編集セッションに関する情報を返します。このリソースを使用して、編集セッションを明示的に管理します。
changeManagerを使用して、編集セッションを開始します。
他のリソースを使用して、様々な構成変更(データ・ソースの構成、アプリケーションのデプロイなど)を行います。
changeManagerを使用して、編集セッション内のすべての変更の取消しまたはそれらのアクティブ化を行います。
この方式は、すべての変更をまとめてバッチ処理しますが、これは、多くの構成変更をクライアントへの公開準備完了とする前にまとめて行う必要がある場合、一般的に本番環境で最も役に立つ方式です。
暗黙的な編集セッションでは、changeManagerを使用するかわりに、他のリソースを使用して構成を変更します(データ・ソースの作成など)。構成を変更する各REST呼出しは、それ自体の編集セッションを開始し、変更を行い、次にその変更をアクティブ化します。これは、一般的に開発環境で実行されるため、構成に対する小さい変更を行う場合に便利です。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、編集セッションの現在のステータスに関する情報を返します。
例
この例は、GETメソッドを使用して、変更マネージャ情報を返します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/changeManager
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/changeManager\/startEdit",
"title": "startEdit"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/changeManager\/cancelEdit",
"title": "cancelEdit"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/changeManager\/activate",
"title": "activate"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/changeManager\/safeResolve",
"title": "safeResolve"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/changeManager\/forceResolve",
"title": "forceResolve"
}
],
"item": {
"mergeNeeded": false,
"locked": false
}
}
このリソースは、変更をアクティブ化します。
リソースでは、次のメソッドがサポートされます。
このリソースのPOSTメソッドは、現在の編集セッション中に保存されまだデプロイされていない変更をアクティブ化します。
例
この例は、POSTメソッドを使用して、現在のセッションの未処理の変更をアクティブ化します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/changeManager/activate
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "The changes are activated successfully.",
"severity": "SUCCESS"
}]}
このリソースは、現在の編集セッションを取り消します。
リソースでは、次のメソッドがサポートされます。
このリソースのPOSTメソッドは、現在の編集セッションを取り消し、編集ロックを解放し、保存済または未保存の変更を破棄します。
例
この例は、POSTメソッドを使用して、現在の編集セッションを取り消します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/changeManager/cancelEdit
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Edit session has been cancelled successfully.",
"severity": "SUCCESS"
}]}
このリソースは、デフォルト編集セッションとグローバル構成の間のすべての変更を強制的に解決します。
リソースでは、次のメソッドがサポートされます。
このリソースのPOSTメソッドは、デフォルト編集セッションとグローバル構成の間のすべての変更を強制的に解決します。
例
この例では、POSTメソッドを使用して、現在の編集セッションと現在アクティブな構成の間のすべての変更を強制的に解決します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/changeManager/forceResolve
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Successfully resolved the changes in default edit session with the global configuration.",
"severity": "SUCCESS"
}]}
このリソースは、デフォルト編集セッションとグローバル構成の間の競合していない変更を解決します。
リソースでは、次のメソッドがサポートされます。
このリソースのPOSTメソッドは、デフォルト編集セッションとグローバル構成の間の競合していない変更を解決します。変更が競合する場合、失敗します。
例
この例では、POSTメソッドを使用して、現在の編集セッションと現在アクティブな構成の間の競合していない変更を安全に解決します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/changeManager/safeResolve
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Successfully resolved the changes in default edit session with the global configuration.",
"severity": "SUCCESS"
}]}
このリソースは、構成の編集セッションを開始します。
リソースでは、次のメソッドがサポートされます。
このリソースのPOSTメソッドは、編集セッションを開始します。
例
この例は、POSTメソッドを使用して、新規編集セッションを開始します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/changeManager/startEdit
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Started edit session, please be sure to save and activate your changes once you are done.",
"severity": "SUCCESS"
}]}
このリソースは、このWLSドメインで実行されるデータ・ソースを管理します。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、このWLSドメイン内のすべてのデータ・ソースのリストを返します。
リクエスト問合せパラメータ
このメソッドでは、レスポンスに含められるフィールドの制限に使用できるオプションの問合せパラメータがサポートされます。必要とする情報のみにフィールドを制限すると、大規模なデータ・セットとやりとりする際にレスポンス時間を短縮できます。
(オプション)これらの値が必須ではなく、レスポンスで省略可能であることを指定します。
(オプション)これらの値が必須であり、レスポンスに含める必要があることを指定します。
包含と除外は相互に排他的であり、いずれも指定しない場合すべての使用可能な情報が含まれます。
レスポンス本文
返されるレスポンス本文には、DataSourceエンティティの集合が含まれます。また、対応するリソースへのリンクも含まれます。
このメソッドは次のリンクを返すことができます。
uri=/management/wls/{version}/datasources/drivers rel=drivers
uri=/management/wls/{version}/datasources/test rel=test
例
この例は、GETメソッドを使用して、すべての構成済データ・ソースに関する情報を表示します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/datasources
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest"
},
{
"rel": "vendors",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors"
},
{
"rel": "test",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/test"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/id\/TestDataSource",
"title": "TestDataSource"
}
],
"items": [{
"name": "TestDataSource",
"targets": [
"myserver",
"Cluster-0"
],
"jdbcDataSourceParams": {
"scope": "global",
"dataSourceList": null,
"globalTransactionsProtocol": "one phase commit",
"rowPrefetchSize": 48,
"streamChunkSize": 256,
"algorithmType": "failover",
"connectionPoolFailoverCallbackHandler": null,
"failoverRequestIfBusy": false,
"rowPrefetch": false,
"jndiNames": [
"jndiName1",
"jndiName2"
],
"keepConnAfterLocalTx": true,
"keepConnAfterGlobalTx": false
},
"jdbcConnectionPoolParams": {
"driverInterceptor": "",
"connectionHarvestMaxCount": 1,
"connectionHarvestTriggerCount": -1,
"minCapacity": 1,
"profileType": 0,
"connectionLabelingCallback": "",
"maxCapacity": 15,
"highestNumWaiters": 2147483647,
"loginDelaySeconds": 0,
"secondsToTrustAnIdlePoolConnection": 10,
"initialCapacity": 1,
"shrinkFrequencySeconds": 900,
"testFrequencySeconds": 120,
"testTableName": "SQL SELECT 1 FROM SYS.SYSTABLES",
"testConnectionsOnReserve": false,
"connectionReserveTimeoutSeconds": 10,
"connectionCreationRetryFrequencySeconds": 0,
"inactiveConnectionTimeoutSeconds": 0,
"statementCacheSize": 10,
"statementCacheType": "least recently used",
"statementTimeout": -1,
"countOfTestFailuresTillFlush": 2,
"countOfRefreshFailuresTillDisable": 2,
"profileHarvestFrequencySeconds": 300,
"initSql": "",
"fatalErrorCodes": "",
"removeInfectedConnections": true,
"jdbcXaDebugLevel": 10,
"ignoreInUseConnectionsEnabled": true,
"credentialMappingEnabled": false,
"pinnedToThread": false,
"identityBasedConnectionPoolingEnabled": false,
"wrapTypes": true,
"wrapJdbc": true
},
"jdbcDriverParams": {
"properties": [
{
"name": "portNumber",
"value": "1527"
},
{
"name": "databaseName",
"value": "demo;create=true"
},
{
"name": "serverName",
"value": "localhost"
}
],
"driverName": "org.apache.derby.jdbc.ClientXADataSource",
"systemProperties": [],
"url": "jdbc:derby:\/\/localhost:1527\/demo",
"useXaDataSourceInterface": true,
"usePasswordIndirection": false
},
"aggregateMetrics": {
"reserveRequestCount": 0,
"failedReserveRequestCount": 0,
"waitingForConnectionTotal": 0,
"waitingForConnectionSuccessTotal": 0,
"waitingForConnectionFailureTotal": 0,
"currCapacityHighCount": 3,
"state": "Running",
"prepStmtCacheAccessCount": 0,
"prepStmtCacheAddCount": 0,
"prepStmtCacheDeleteCount": 0,
"prepStmtCacheCurrentSize": 0,
"prepStmtCacheHitCount": 0,
"prepStmtCacheMissCount": 0,
"currCapacity": 3,
"numAvailable": 3,
"highestNumAvailable": 3,
"numUnavailable": 0,
"highestNumUnavailable": 0,
"leakedConnectionCount": 0,
"failuresToReconnectCount": 0,
"connectionDelayTime": 238,
"activeConnectionsCurrentCount": 0,
"waitingForConnectionCurrentCount": 0,
"activeConnectionsHighCount": 0,
"waitingForConnectionHighCount": 0,
"waitSecondsHighCount": 0,
"connectionsTotalCount": 3,
"activeConnectionsAverageCount": 0
},
"dataSourceMetrics": [
{
"reserveRequestCount": 0,
"failedReserveRequestCount": 0,
"waitingForConnectionTotal": 0,
"waitingForConnectionSuccessTotal": 0,
"waitingForConnectionFailureTotal": 0,
"currCapacityHighCount": 1,
"state": "Running",
"prepStmtCacheAccessCount": 0,
"prepStmtCacheAddCount": 0,
"prepStmtCacheDeleteCount": 0,
"prepStmtCacheCurrentSize": 0,
"prepStmtCacheHitCount": 0,
"prepStmtCacheMissCount": 0,
"currCapacity": 1,
"numAvailable": 1,
"highestNumAvailable": 1,
"numUnavailable": 0,
"highestNumUnavailable": 0,
"leakedConnectionCount": 0,
"failuresToReconnectCount": 0,
"connectionDelayTime": 238,
"activeConnectionsCurrentCount": 0,
"waitingForConnectionCurrentCount": 0,
"activeConnectionsHighCount": 0,
"waitingForConnectionHighCount": 0,
"waitSecondsHighCount": 0,
"connectionsTotalCount": 1,
"activeConnectionsAverageCount": 0,
"serverName": "Cluster-0-Server-2"
},
{
"reserveRequestCount": 0,
"failedReserveRequestCount": 0,
"waitingForConnectionTotal": 0,
"waitingForConnectionSuccessTotal": 0,
"waitingForConnectionFailureTotal": 0,
"currCapacityHighCount": 1,
"state": "Running",
"prepStmtCacheAccessCount": 0,
"prepStmtCacheAddCount": 0,
"prepStmtCacheDeleteCount": 0,
"prepStmtCacheCurrentSize": 0,
"prepStmtCacheHitCount": 0,
"prepStmtCacheMissCount": 0,
"currCapacity": 1,
"numAvailable": 1,
"highestNumAvailable": 1,
"numUnavailable": 0,
"highestNumUnavailable": 0,
"leakedConnectionCount": 0,
"failuresToReconnectCount": 0,
"connectionDelayTime": 238,
"activeConnectionsCurrentCount": 0,
"waitingForConnectionCurrentCount": 0,
"activeConnectionsHighCount": 0,
"waitingForConnectionHighCount": 0,
"waitSecondsHighCount": 0,
"connectionsTotalCount": 1,
"activeConnectionsAverageCount": 0,
"serverName": "Cluster-0-Server-1"
},
{
"reserveRequestCount": 0,
"failedReserveRequestCount": 0,
"waitingForConnectionTotal": 0,
"waitingForConnectionSuccessTotal": 0,
"waitingForConnectionFailureTotal": 0,
"currCapacityHighCount": 1,
"state": "Running",
"prepStmtCacheAccessCount": 0,
"prepStmtCacheAddCount": 0,
"prepStmtCacheDeleteCount": 0,
"prepStmtCacheCurrentSize": 0,
"prepStmtCacheHitCount": 0,
"prepStmtCacheMissCount": 0,
"currCapacity": 1,
"numAvailable": 1,
"highestNumAvailable": 1,
"numUnavailable": 0,
"highestNumUnavailable": 0,
"leakedConnectionCount": 0,
"failuresToReconnectCount": 0,
"connectionDelayTime": 4,
"activeConnectionsCurrentCount": 0,
"waitingForConnectionCurrentCount": 0,
"activeConnectionsHighCount": 0,
"waitingForConnectionHighCount": 0,
"waitSecondsHighCount": 0,
"connectionsTotalCount": 1,
"activeConnectionsAverageCount": 0,
"serverName": "myserver"
}
]
}]
}
このリソースのOPTIONSメソッドは、デフォルト値が事前移入されているテンプレート・エンティティを返します。
データ・ソースを作成する場合、このメソッドを呼び出してテンプレートを取得し、ドライバ・クラス名やデータベースURLなどの値を入力して、POSTメソッドでこれを使用してデータ・ソースを作成します。
例
この例は、OPTIONSメソッドを使用して、データ・ソースのテンプレートを取得します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X OPTIONS http://localhost:7001/management/wls/latest/datasources
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"item": {
"name": "DataSource-0",
"targets": [],
"jdbcDataSourceParams": {
"scope": "global",
"dataSourceList": null,
"globalTransactionsProtocol": "one phase commit",
"rowPrefetchSize": 48,
"streamChunkSize": 256,
"algorithmType": "failover",
"connectionPoolFailoverCallbackHandler": null,
"failoverRequestIfBusy": false,
"rowPrefetch": false,
"jndiNames": [],
"keepConnAfterLocalTx": true,
"keepConnAfterGlobalTx": false
},
"jdbcConnectionPoolParams": {
"driverInterceptor": "",
"connectionHarvestMaxCount": 1,
"connectionHarvestTriggerCount": -1,
"minCapacity": 1,
"profileType": 0,
"connectionLabelingCallback": "",
"maxCapacity": 15,
"highestNumWaiters": 2147483647,
"loginDelaySeconds": 0,
"secondsToTrustAnIdlePoolConnection": 10,
"initialCapacity": 1,
"shrinkFrequencySeconds": 900,
"testFrequencySeconds": 120,
"testTableName": null,
"testConnectionsOnReserve": false,
"connectionReserveTimeoutSeconds": 10,
"connectionCreationRetryFrequencySeconds": 0,
"inactiveConnectionTimeoutSeconds": 0,
"statementCacheSize": 10,
"statementCacheType": "least recently used",
"statementTimeout": -1,
"countOfTestFailuresTillFlush": 2,
"countOfRefreshFailuresTillDisable": 2,
"profileHarvestFrequencySeconds": 300,
"initSql": "",
"fatalErrorCodes": "",
"removeInfectedConnections": true,
"jdbcXaDebugLevel": 10,
"ignoreInUseConnectionsEnabled": true,
"credentialMappingEnabled": false,
"pinnedToThread": false,
"identityBasedConnectionPoolingEnabled": false,
"wrapTypes": true,
"wrapJdbc": true
},
"jdbcDriverParams": {
"properties": [],
"password": null,
"driverName": null,
"systemProperties": [],
"url": null,
"useXaDataSourceInterface": true,
"usePasswordIndirection": false
},
"aggregateMetrics": {
"reserveRequestCount": 0,
"failedReserveRequestCount": 0,
"waitingForConnectionTotal": 0,
"waitingForConnectionSuccessTotal": 0,
"waitingForConnectionFailureTotal": 0,
"currCapacityHighCount": 0,
"state": null,
"prepStmtCacheAccessCount": 0,
"prepStmtCacheAddCount": 0,
"prepStmtCacheDeleteCount": 0,
"prepStmtCacheCurrentSize": 0,
"prepStmtCacheHitCount": 0,
"prepStmtCacheMissCount": 0,
"currCapacity": 0,
"numAvailable": 0,
"highestNumAvailable": 0,
"numUnavailable": 0,
"highestNumUnavailable": 0,
"leakedConnectionCount": 0,
"failuresToReconnectCount": 0,
"connectionDelayTime": 0,
"activeConnectionsCurrentCount": 0,
"waitingForConnectionCurrentCount": 0,
"activeConnectionsHighCount": 0,
"waitingForConnectionHighCount": 0,
"waitSecondsHighCount": 0,
"connectionsTotalCount": 0,
"activeConnectionsAverageCount": 0,
"serverName": null
},
"dataSourceMetrics": []
}}
このリソースのPOSTメソッドは、新規データ・ソースを作成します。
例
この例は、POSTメソッドを使用して、新規データ・ソースを作成します。
リクエストの例
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
'name': 'TestDataSource',
'targets': [ 'myserver', 'Cluster-0' ],
'jdbcDriverParams': {
'properties': [
{ name: 'portNumber', value: '1527' },
{ name: 'databaseName', value: 'demo;create=true' },
{ name: 'serverName', value: 'localhost' }
],
'password': 'password1',
'driverName': 'org.apache.derby.jdbc.ClientXADataSource',
'url': 'jdbc:derby://localhost:1527/demo',
'systemProperties': [],
'usePasswordIndirection': false,
'useXaDataSourceInterface': true
},
'jdbcDataSourceParams': {
'scope': 'global',
'algorithmType': 'failover',
'connectionPoolFailoverCallbackHandler': null,
'failoverRequestIfBusy': false,
'dataSourceList': null,
'globalTransactionsProtocol': 'one phase commit',
'rowPrefetchSize': 48,
'streamChunkSize': 256,
'rowPrefetch': false,
'keepConnAfterLocalTx': true,
'keepConnAfterGlobalTx': false,
'jndiNames': [ 'jndiName1', 'jndiName2' ]
},
'jdbcConnectionPoolParams': {
'profileHarvestFrequencySeconds': 300,
'driverInterceptor': '',
'connectionHarvestMaxCount': 1,
'connectionHarvestTriggerCount': -1,
'minCapacity': 1,
'profileType': 0,
'connectionLabelingCallback': '',
'maxCapacity': 15,
'highestNumWaiters': 2147483647,
'loginDelaySeconds': 0,
'secondsToTrustAnIdlePoolConnection': 10,
'initialCapacity': 1,
'shrinkFrequencySeconds': 900,
'testFrequencySeconds': 120,
'testTableName': 'SQL SELECT 1 FROM SYS.SYSTABLES',
'testConnectionsOnReserve': false,
'connectionReserveTimeoutSeconds': 10,
'connectionCreationRetryFrequencySeconds': 0,
'inactiveConnectionTimeoutSeconds': 0,
'statementCacheSize': 10,
'statementCacheType': 'least recently used',
'statementTimeout': -1,
'countOfTestFailuresTillFlush': 2,
'countOfRefreshFailuresTillDisable': 2,
'fatalErrorCodes': '',
'initSql': '',
'ignoreInUseConnectionsEnabled': true,
'removeInfectedConnections': true,
'credentialMappingEnabled': false,
'pinnedToThread': false,
'identityBasedConnectionPoolingEnabled': false,
'wrapTypes': true,
'wrapJdbc': true,
'jdbcXaDebugLevel': 10
}
}" \
-X POST http://localhost:7001/management/wls/latest/datasources
レスポンスの例
HTTP/1.1 201 Created
Location: http://localhost:7001/management/wls/latest/datasources/id/TestDataSource
Response Body:
{"messages": [{
"message": "Successfully created 'TestDataSource'.",
"severity": "SUCCESS"
}]}
このリソースは、リソースURLで識別されるデータ・ソースを管理します。
リソースでは、次のメソッドがサポートされます。
DELETEメソッドは、リソースURLで識別されるデータ・ソースを削除します。
例
この例は、DELETEメソッドを使用して、データ・ソース構成を削除します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/wls/latest/datasources/id/TestDataSource
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Successfully deleted 'TestDataSource'.",
"severity": "SUCCESS"
}]}
-----
このリソースのGETメソッドは、リソースURLによって識別されるデータ・ソースに関する情報を返します。
例
この例は、GETメソッドを使用して、特定のデータ・ソースに関する情報を検索します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/datasources/id/TestDataSource
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/id\/TestDataSource\/start",
"title": "start"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/id\/TestDataSource\/shutdown",
"title": "shutdown"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/id\/TestDataSource\/test",
"title": "test"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/id\/TestDataSource\/clearStatementCache",
"title": "clearStatementCache"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/id\/TestDataSource\/reset",
"title": "reset"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/id\/TestDataSource\/shrink",
"title": "shrink"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/id\/TestDataSource\/suspend",
"title": "suspend"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/id\/TestDataSource\/resume",
"title": "resume"
}
],
"item": {
"name": "TestDataSource",
"targets": [
"myserver",
"Cluster-0"
],
"jdbcDataSourceParams": {
"scope": "global",
"dataSourceList": null,
"globalTransactionsProtocol": "one phase commit",
"rowPrefetchSize": 96,
"streamChunkSize": 256,
"algorithmType": "failover",
"connectionPoolFailoverCallbackHandler": null,
"failoverRequestIfBusy": false,
"rowPrefetch": true,
"jndiNames": [
"jndiName1",
"jndiName2",
"jndiName3"
],
"keepConnAfterLocalTx": true,
"keepConnAfterGlobalTx": false
},
"jdbcConnectionPoolParams": {
"driverInterceptor": "",
"connectionHarvestMaxCount": 1,
"connectionHarvestTriggerCount": -1,
"minCapacity": 1,
"profileType": 0,
"connectionLabelingCallback": "",
"maxCapacity": 30,
"highestNumWaiters": 2147483647,
"loginDelaySeconds": 0,
"secondsToTrustAnIdlePoolConnection": 10,
"initialCapacity": 2,
"shrinkFrequencySeconds": 900,
"testFrequencySeconds": 120,
"testTableName": "SQL SELECT 1 FROM SYS.SYSTABLES",
"testConnectionsOnReserve": false,
"connectionReserveTimeoutSeconds": 10,
"connectionCreationRetryFrequencySeconds": 0,
"inactiveConnectionTimeoutSeconds": 0,
"statementCacheSize": 10,
"statementCacheType": "least recently used",
"statementTimeout": -1,
"countOfTestFailuresTillFlush": 2,
"countOfRefreshFailuresTillDisable": 2,
"profileHarvestFrequencySeconds": 300,
"initSql": "",
"fatalErrorCodes": "",
"removeInfectedConnections": true,
"jdbcXaDebugLevel": 10,
"ignoreInUseConnectionsEnabled": true,
"credentialMappingEnabled": false,
"pinnedToThread": false,
"identityBasedConnectionPoolingEnabled": false,
"wrapTypes": true,
"wrapJdbc": true
},
"jdbcDriverParams": {
"properties": [
{
"name": "portNumber",
"value": "1527"
},
{
"name": "databaseName",
"value": "demo;create=true"
},
{
"name": "serverName",
"value": "localhost"
}
],
"driverName": "org.apache.derby.jdbc.ClientXADataSource",
"systemProperties": [],
"url": "jdbc:derby:\/\/localhost:1527\/demo",
"useXaDataSourceInterface": true,
"usePasswordIndirection": false
},
"aggregateMetrics": {
"reserveRequestCount": 3,
"failedReserveRequestCount": 0,
"waitingForConnectionTotal": 0,
"waitingForConnectionSuccessTotal": 0,
"waitingForConnectionFailureTotal": 0,
"currCapacityHighCount": 3,
"state": "Shutdown",
"prepStmtCacheAccessCount": 0,
"prepStmtCacheAddCount": 0,
"prepStmtCacheDeleteCount": 0,
"prepStmtCacheCurrentSize": 0,
"prepStmtCacheHitCount": 0,
"prepStmtCacheMissCount": 0,
"currCapacity": 0,
"numAvailable": 0,
"highestNumAvailable": 3,
"numUnavailable": 0,
"highestNumUnavailable": 3,
"leakedConnectionCount": 0,
"failuresToReconnectCount": 0,
"connectionDelayTime": 238,
"activeConnectionsCurrentCount": 0,
"waitingForConnectionCurrentCount": 0,
"activeConnectionsHighCount": 3,
"waitingForConnectionHighCount": 0,
"waitSecondsHighCount": 0,
"connectionsTotalCount": 3,
"activeConnectionsAverageCount": 0
},
"dataSourceMetrics": [
{
"reserveRequestCount": 1,
"failedReserveRequestCount": 0,
"waitingForConnectionTotal": 0,
"waitingForConnectionSuccessTotal": 0,
"waitingForConnectionFailureTotal": 0,
"currCapacityHighCount": 1,
"state": "Shutdown",
"prepStmtCacheAccessCount": 0,
"prepStmtCacheAddCount": 0,
"prepStmtCacheDeleteCount": 0,
"prepStmtCacheCurrentSize": 0,
"prepStmtCacheHitCount": 0,
"prepStmtCacheMissCount": 0,
"currCapacity": 0,
"numAvailable": 0,
"highestNumAvailable": 1,
"numUnavailable": 0,
"highestNumUnavailable": 1,
"leakedConnectionCount": 0,
"failuresToReconnectCount": 0,
"connectionDelayTime": 4,
"activeConnectionsCurrentCount": 0,
"waitingForConnectionCurrentCount": 0,
"activeConnectionsHighCount": 1,
"waitingForConnectionHighCount": 0,
"waitSecondsHighCount": 0,
"connectionsTotalCount": 1,
"activeConnectionsAverageCount": 0,
"serverName": "myserver"
}
]
}
}
-----
このリソースのPOSTメソッドは、リソースURLによって識別されるデータ・ソースを再構成します。
例
この例は、POSTメソッドを使用して、データ・ソース構成を更新します。
リクエストの例
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
'name': 'TestDataSource',
'targets': [ 'myserver', 'Cluster-0' ],
'jdbcDriverParams': {
'properties': [
{ name: 'portNumber', value: '1527' },
{ name: 'databaseName', value: 'demo;create=true' },
{ name: 'serverName', value: 'localhost' }
],
'password': 'password1',
'driverName': 'org.apache.derby.jdbc.ClientXADataSource',
'url': 'jdbc:derby://localhost:1527/demo',
'systemProperties': [],
'usePasswordIndirection': false,
'useXaDataSourceInterface': true
},
'jdbcDataSourceParams': {
'scope': 'global',
'algorithmType': 'failover',
'connectionPoolFailoverCallbackHandler': null,
'failoverRequestIfBusy': false,
'dataSourceList': null,
'globalTransactionsProtocol': 'one phase commit',
'rowPrefetchSize': 96,
'streamChunkSize': 256,
'rowPrefetch': true,
'keepConnAfterLocalTx': true,
'keepConnAfterGlobalTx': false,
'jndiNames': [ 'jndiName1', 'jndiName2', 'jndiName3' ]
},
'jdbcConnectionPoolParams': {
'profileHarvestFrequencySeconds': 300,
'driverInterceptor': '',
'connectionHarvestMaxCount': 1,
'connectionHarvestTriggerCount': -1,
'minCapacity': 1,
'profileType': 0,
'connectionLabelingCallback': '',
'maxCapacity': 30,
'highestNumWaiters': 2147483647,
'loginDelaySeconds': 0,
'secondsToTrustAnIdlePoolConnection': 10,
'initialCapacity': 2,
'shrinkFrequencySeconds': 900,
'testFrequencySeconds': 120,
'testTableName': 'SQL SELECT 1 FROM SYS.SYSTABLES',
'testConnectionsOnReserve': false,
'connectionReserveTimeoutSeconds': 10,
'connectionCreationRetryFrequencySeconds': 0,
'inactiveConnectionTimeoutSeconds': 0,
'statementCacheSize': 10,
'statementCacheType': 'least recently used',
'statementTimeout': -1,
'countOfTestFailuresTillFlush': 2,
'countOfRefreshFailuresTillDisable': 2,
'fatalErrorCodes': '',
'initSql': '',
'ignoreInUseConnectionsEnabled': true,
'removeInfectedConnections': true,
'credentialMappingEnabled': false,
'pinnedToThread': false,
'identityBasedConnectionPoolingEnabled': false,
'wrapTypes': true,
'wrapJdbc': true,
'jdbcXaDebugLevel': 10
}
}" \
-X POST http://localhost:7001/management/wls/latest/datasources/id/TestDataSource
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Successfully updated 'TestDataSource'.",
"severity": "SUCCESS"
}]}
-----
このリソースは、データ・ソース内の各接続の文キャッシュをクリアします。データソースの文キャッシュが有効な場合、WebLogic Serverでは、データソース内の各接続で使用されるプリコンパイル済文およびコール可能文がキャッシュされます。各接続はそれぞれ固有のキャッシュを持ちますが、各接続のキャッシュは、1つのグループとして構成および管理されます。あるデータ・ソースの文キャッシュをクリアすると、そのデータ・ソースのインスタンスに含まれるすべての接続の文キャッシュがクリアされます。
アプリケーションにより現在使用されている文をクリアすると、WebLogic Serverはその文をキャッシュから削除しますが閉じません。現在使用されてない文をクリアすると、WebLogic Serverはキャッシュからその文を削除して閉じます。
リソースでは、次のメソッドがサポートされます。
このリソースのPOSTメソッドは、データ・ソース内の各接続の文キャッシュをクリアします。
例
この例は、POSTメソッドを使用して、特定のデータ・ソースの文キャッシュをクリアします。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/datasources/id/TestDataSource/clearStatementCache
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Data Source 'TestDataSource' was successfully cleared.",
"severity": "SUCCESS"
}]}
このリソースはデータ・ソースをリセットします。JDBCデータ・ソース内のデータベース接続をリセットすると、そのデータ・ソースの接続プールで使用可能なすべてのデータベース接続が閉じられ、再作成されます。
リソースでは、次のメソッドがサポートされます。
このリソースのPOSTメソッドは、データ・ソースのデータベース接続をリセットします。
例
この例は、POSTメソッドを使用して、データ・ソースのデータベース接続をリセットします。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/datasources/id/TestDataSource/reset
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Data Source 'TestDataSource' was successfully reset.",
"severity": "SUCCESS"
}]}
このリソースは中断したデータ・ソースを再開します。データ・ソースを再開すると、WebLogic Serverはデータ・ソースを有効とマークし、アプリケーションはデータ・ソースからの接続を予約できます。データ・ソースを中断した場合(強制中断ではない)、すべての接続が、中断前とまったく同じ状態で保持されます。データ・ソースの中断前に接続を予約していたクライアントは、中断が発生した時点の状態から作業を継続できます。
注意: たとえば、データベース・サーバーが使用不可の場合など、正しく起動しなかったデータ・ソースは再開できません。
リソースでは、次のメソッドがサポートされます。
このリソースのPOSTメソッドは、中断状態の個別のデータ・ソースを再開します。
例
この例は、POSTメソッドを使用して、中断したデータ・ソースを再開します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/datasources/id/TestDataSource/resume
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Data Source 'TestDataSource' was successfully resumed.",
"severity": "SUCCESS"
}]}
このリソースは、データ・ソースの個別のインスタンス内のデータベース接続のプールを縮小します。
リソースでは、次のメソッドがサポートされます。
このリソースのPOSTメソッドは、データ・ソース内の接続プールを縮小します。
例
この例は、POSTメソッドを使用して、特定のデータ・ソースの接続プールを縮小します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/datasources/id/TestDataSource/shrink
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Data Source 'TestDataSource' was successfully shrunken.",
"severity": "SUCCESS"
}]}
このリソースは、実行中のデータ・ソースを停止します。データ・ソースを停止すると(強制停止ではない)、WebLogic Serverはデータ・ソース内のデータベース接続を閉じ、データ・ソースを停止します。データ・ソースのいずれかの接続が使用中の場合、この操作は失敗します。
リソースでは、次のメソッドがサポートされます。
このリソースのPOSTメソッドは、データ・ソースを停止します。
例
この例は、POSTメソッドを使用して、データ・ソースを停止します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/datasources/id/TestDataSource/shutdown
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Data Source 'TestDataSource' was successfully stopped.",
"severity": "SUCCESS"
}]}
このリソースは停止したデータ・ソースを開始します。データ・ソースを開始すると、データ・ソースが再初期化され、接続が作成され、データ・ソースのヘルス状態が「実行中」に遷移します。
リソースでは、次のメソッドがサポートされます。
このリソースのPOSTメソッドは、データ・ソースを開始します。
例
この例は、POSTメソッドを使用して、データ・ソースを開始します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/datasources/id/TestDataSource/start
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Data Source 'TestDataSource' was successfully started.",
"severity": "SUCCESS"
}]}
このリソースはデータ・ソースを中断します。データ・ソースを中断すると(強制中断ではない)、データ・ソースは無効とマークされ、アプリケーションはプール内の接続を予約できません。データ・ソース中断時にそのデータ・ソースからの接続をすでに予約していたアプリケーションは、その接続を予約しようとしたときに例外を受け取ります。データ・ソース内のすべての接続は、データ・ソースが中断される前とまったく同じ状態で保持されます。
リソースでは、次のメソッドがサポートされます。
このリソースのPOSTメソッドは、データ・ソースの個別のインスタンスを中断します。データ・ソースを中断すると、アプリケーションはそのデータ・ソースからデータベース接続を取得できなくなります。
例
この例は、POSTメソッドを使用して、データ・ソースを中断します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/datasources/id/TestDataSource/suspend
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Data Source 'TestDataSource' was successfully suspended.",
"severity": "SUCCESS"
}]}
このリソースはデータ・ソースのデータベース接続をテストします。
リソースでは、次のメソッドがサポートされます。
このリソースのPOSTメソッドは、データ・ソースのデータベース接続をテストします。
例
この例は、POSTメソッドを使用して、データ・ソースのデータベースとの接続性をテストします。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/datasources/id/TestDataSource/test
レスポンスの例
HHTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Data Source 'TestDataSource' is working correctly.",
"severity": "SUCCESS"
}]}
このリソースはデータベース接続をテストします。一般的に、新規データ・ソースの作成に使用されるパラメータの検証に使用されます。
リソースでは、次のメソッドがサポートされます。
このリソースのOPTIONSメソッドは、デフォルト値が事前移入されているテンプレート・エンティティを返します。
データベース接続をテストする場合、このメソッドを呼び出してテンプレートを取得し、ドライバ・クラス名や接続URLなどの値を入力して、POSTメソッドでこれを使用して接続をテストします。
例
この例は、OPTIONSメソッドを使用して、データベース接続のテンプレートを取得します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X OPTIONS http://localhost:7001/management/wls/latest/datasources/test
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"item": {
"properties": null,
"password": null,
"url": null,
"driverName": null
}}
このリソースのPOSTメソッドは、ドライバ固有の属性のセットを、汎用のデータベース接続エンティティに変換し、接続URLおよびプロパティのリストを適切にフォーマットします。
注意: RESTリソースはクリアテキスト・パスワードを返すことができないため、ドライバ属性のいずれかにパスワードが保持されていても、返されるドライバにパスワードは入力されていません。これを補うために、クライアントは、データベース・ドライバ属性エンティティを保持し、そのpasswordAttributeNameプロパティを使用してパスワードを保持する属性を検索し、返されたデータベース接続エンティティのpasswordプロパティをそのパスワードに設定する必要があります。
例
この例は、POSTメソッドを使用して、データベース接続構成をテストします。
リクエストの例
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
url: 'jdbc:derby://localhost:1527/demo',
driverName: 'org.apache.derby.jdbc.ClientXADataSource',
password: null,
properties: [
{ name: 'portNumber', value: '1527' },
{ name: 'databaseName', value: 'demo;create=true' },
{ name: 'serverName', value: 'localhost' }
]
}" \
-X POST http://localhost:7001/management/wls/latest/datasources/test
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"item": {
"cause": [],
"ok": true
}}
このリソースは、このWLSドメイン内の使用可能なデータベース・ドライバのベンダーをリストします。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、このドメインの使用可能なデータベース・ドライバのベンダー・リストを返します。
例
この例は、GETメソッドを使用して、ドメインが認識している使用可能なデータベース・ドライバ・ベンダーをすべて検出します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/datasources/vendors
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Adabas%20for%20z%2FOS",
"title": "Adabas for z\/OS"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/CICS%2FTS%20for%20z%2FOS",
"title": "CICS\/TS for z\/OS"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Cache",
"title": "Cache"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Cloudscape",
"title": "Cloudscape"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/DB2",
"title": "DB2"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/DB2%20for%20i5%2FOS",
"title": "DB2 for i5\/OS"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/DB2%20for%20z%2FOS",
"title": "DB2 for z\/OS"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Derby",
"title": "Derby"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/EnterpriseDB",
"title": "EnterpriseDB"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/FirstSQL",
"title": "FirstSQL"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/IMS%2FDB%20for%20z%2FOS",
"title": "IMS\/DB for z\/OS"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/IMS%2FTM%20for%20z%2FOS",
"title": "IMS\/TM for z\/OS"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Informix",
"title": "Informix"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Ingres",
"title": "Ingres"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/MS%20SQL%20Server",
"title": "MS SQL Server"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/MaxDB",
"title": "MaxDB"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/MySQL",
"title": "MySQL"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Oracle",
"title": "Oracle"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Oracle%20BI%20Server",
"title": "Oracle BI Server"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Oracle%20TimesTen%20Client%20Connection",
"title": "Oracle TimesTen Client Connection"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Oracle%20TimesTen%20Direct%20Connection",
"title": "Oracle TimesTen Direct Connection"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/PointBase",
"title": "PointBase"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/PostgreSQL",
"title": "PostgreSQL"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Progress",
"title": "Progress"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Sybase",
"title": "Sybase"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/VSAM%20for%20z%2FOS",
"title": "VSAM for z\/OS"
}
],
"items": [
{"name": "Adabas for z\/OS"},
{"name": "CICS\/TS for z\/OS"},
{"name": "Cache"},
{"name": "Cloudscape"},
{"name": "DB2"},
{"name": "DB2 for i5\/OS"},
{"name": "DB2 for z\/OS"},
{"name": "Derby"},
{"name": "EnterpriseDB"},
{"name": "FirstSQL"},
{"name": "IMS\/DB for z\/OS"},
{"name": "IMS\/TM for z\/OS"},
{"name": "Informix"},
{"name": "Ingres"},
{"name": "MS SQL Server"},
{"name": "MaxDB"},
{"name": "MySQL"},
{"name": "Oracle"},
{"name": "Oracle BI Server"},
{"name": "Oracle TimesTen Client Connection"},
{"name": "Oracle TimesTen Direct Connection"},
{"name": "PointBase"},
{"name": "PostgreSQL"},
{"name": "Progress"},
{"name": "Sybase"},
{"name": "VSAM for z\/OS"}
]
}
このリソースでは、データベース・ドライバ・ベンダーが記述されます。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、このベンダーのデータベース・ドライバのリストを返します。
例
この例は、GETメソッドを使用して、サポートされているデータベース・ベンダーのドライバをすべて検出します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/datasources/vendors/id/Derby
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors"
},
{
"rel": "item.drivers.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Derby\/drivers\/id\/Derby's%20Driver%20(Type%204%20XA)%20Versions:Any",
"title": "Derby's Driver (Type 4 XA) Versions:Any"
},
{
"rel": "item.drivers.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Derby\/drivers\/id\/Derby's%20Driver%20(Type%204%20embedded)%20Versions:Any",
"title": "Derby's Driver (Type 4 embedded) Versions:Any"
},
{
"rel": "item.drivers.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/datasources\/vendors\/id\/Derby\/drivers\/id\/Derby's%20Driver%20(Type%204)%20Versions:Any",
"title": "Derby's Driver (Type 4) Versions:Any"
}
],
"item": {
"name": "Derby",
"drivers": [
{
"name": "Derby's Driver (Type 4 XA) Versions:Any",
"type": "Type 4",
"description": null,
"driverClassName": "org.apache.derby.jdbc.ClientXADataSource",
"forXa": true,
"testSql": "SELECT 1 FROM SYS.SYSTABLES"
},
{
"name": "Derby's Driver (Type 4 embedded) Versions:Any",
"type": "Type 4 embedded",
"description": null,
"driverClassName": "org.apache.derby.jdbc.EmbeddedDriver",
"forXa": false,
"testSql": "SELECT 1 FROM SYS.SYSTABLES"
},
{
"name": "Derby's Driver (Type 4) Versions:Any",
"type": "Type 4",
"description": null,
"driverClassName": "org.apache.derby.jdbc.ClientDriver",
"forXa": false,
"testSql": "SELECT 1 FROM SYS.SYSTABLES"
}
]
}
}
このリソースは、特定のデータベース・ドライバに適切なデータベース接続の構築を支援します。
リソースでは、次のメソッドがサポートされます。
このリソースのOPTIONSメソッドは、デフォルト値が事前移入されているテンプレート・エンティティを返します。
特定の種類のデータベース・ドライバに適切なデータベース接続を構築する場合、ドライバ・クラス名を検索し、このメソッドを呼び出して、このドライバに入力する必要がある属性がリストされたテンプレートを取得します。値を入力した後、入力済テンプレートをデータベース接続に変換するPOSTメソッドでこれを使用します。
レスポンス本文
返されるレスポンス本文には、DatabaseDriverAttributesエンティティが含まれます。
このメソッドは次のリンクを返すことができます。
uri=/management/wls/{version}/datasources/vendors/id/{vendor}/drivers/id/{driver-class-name}/connection rel=connection
例
この例は、OPTIONSメソッドを使用して、データベース・ドライバ構成のテンプレートを取得します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X OPTIONS http://localhost:7001/management/wls/latest/datasources/vendors/id/Derby/drivers/id/Derby's%20Driver%20(Type%204)%20Versions:Any
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"item": {
"attributes": [
{
"name": "DbmsHost",
"value": null,
"defaultValue": null,
"description": null,
"inUrl": true,
"required": true
},
{
"name": "DbmsPort",
"value": "1527",
"defaultValue": "1527",
"description": null,
"inUrl": true,
"required": true
},
{
"name": "DbmsName",
"value": null,
"defaultValue": null,
"description": null,
"inUrl": true,
"required": true
},
{
"name": "DbmsUsername",
"value": null,
"defaultValue": null,
"description": null,
"inUrl": false,
"required": true
},
{
"name": "DbmsPassword",
"value": null,
"defaultValue": null,
"description": null,
"inUrl": false,
"required": true
}
],
"passwordAttributeName": "DbmsPassword"
}}
このリソースのPOSTメソッドは、ドライバ固有の属性のセットを、汎用のデータベース接続エンティティに変換し、接続URLおよびプロパティのリストを適切にフォーマットします。
注意: RESTリソースはクリアテキスト・パスワードを返すことができないため、ドライバ属性のいずれかにパスワードが保持されていても、返されるドライバにパスワードは入力されていません。これを補うために、クライアントは、データベース・ドライバ属性エンティティを保持し、そのpasswordAttributeNameプロパティを使用してパスワードを保持する属性を検索し、返されたデータベース接続エンティティのpasswordプロパティをそのパスワードに設定する必要があります。
例
この例は、POSTメソッドを使用して、データベース接続構成を構築します。
リクエストの例
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
attributes: [
{ name: 'DbmsHost', value: 'localhost' },
{ name: 'DbmsPort', value: '1527' },
{ name: 'DbmsName', value: 'db1' },
{ name: 'DbmsUsername', value: 'u1' },
{ name: 'DbmsPassword', value: 'p1' }
]
}" \
-X POST http://localhost:7001/management/wls/latest/datasources/vendors/id/Derby/drivers/id/Derby's%20Driver%20(Type%204)%20Versions:Any
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"item": {
"properties": [
{
"name": "user",
"value": "u1"
},
{
"name": "portNumber",
"value": "1527"
},
{
"name": "databaseName",
"value": "db1;create=true"
},
{
"name": "serverName",
"value": "localhost"
}
],
"driverName": "org.apache.derby.jdbc.ClientDriver",
"url": "jdbc:derby:\/\/localhost:1527\/db1;ServerName=localhost;databaseName=db1"
}}
このリソースは、このWLSドメインで実行されるデプロイメントをリストします。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、このWLSドメイン内のすべてのデプロイメントのリストを返します。
レスポンス本文
返されるレスポンス本文には、Deploymentエンティティの集合が含まれます。また、対応するリソースへのリンクも含まれます。
このメソッドは次のリンクを返すことができます。
uri=/management/wls/{version}/deployments/application rel=application
uri=/management/wls/{version}/deployments/inspect rel=inspect
uri=/management/wls/{version}/deployments/library rel=library
例
この例は、GETメソッドを使用して、ドメイン内のデプロイメントをすべて表示します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/deployments
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest"
},
{
"rel": "inspect",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/inspect"
},
{
"rel": "application",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/application"
},
{
"rel": "library",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/library"
},
{
"rel": "application",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/application\/id\/BasicApp",
"title": "BasicApp"
},
{
"rel": "library",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/library\/id\/airline",
"title": "airline"
}
],
"items": [
{
"name": "BasicApp",
"state": "active",
"type": "application",
"targets": ["myserver"],
"displayName": "BasicApp",
"deploymentPath": "\/deployments\/BasicApp\/app\/BasicApp.ear"
},
{
"name": "airline",
"state": "active",
"type": "library",
"targets": [
"myserver",
"Cluster-0"
],
"displayName": "airline",
"deploymentPath": "\/deployments\/airline.war"
}
]
}
このリソースは、このWLSドメインにデプロイされているアプリケーションを管理します。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、このWLSドメイン内のすべてのアプリケーションのリストを返します。
リクエスト問合せパラメータ
このメソッドでは、レスポンスに含められるフィールドの制限に使用できるオプションの問合せパラメータがサポートされます。必要とする情報のみにフィールドを制限すると、大規模なデータ・セットとやりとりする際にレスポンス時間を短縮できます。
(オプション)これらの値が必須ではなく、レスポンスで省略可能であることを指定します。
(オプション)これらの値が必須であり、レスポンスに含める必要があることを指定します。
包含と除外は相互に排他的であり、いずれも指定しない場合すべての使用可能な情報が含まれます。
例
この例は、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メソッドは、デフォルト値が事前移入されているテンプレート・エンティティを返します。
アプリケーションをデプロイする場合、このメソッドを呼び出してテンプレートを取得し、アプリケーションへのパスなどの値を入力して、POSTメソッドでこれを使用してアプリケーションをデプロイします。
リソースでは、次のメソッドがサポートされます。
このPOSTメソッドは、デプロイするファイルが管理サーバーのファイル・システムにすでにある場合、新規アプリケーションをデプロイします。
リクエスト問合せパラメータ
このリソースは、アプリケーションをデプロイするジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは201 Createdステータス・コードおよび新規アプリケーション・リソースへのリンクを含むLocationヘッダーを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードおよび想定される新規アプリケーション・リソースへのリンクを含むLocationヘッダーを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コード、ジョブ・リソースへのリンクおよび想定される新規アプリケーション・リソースへのリンクを含むLocationヘッダーを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。
例
この例は、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."
}
}
この例は、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"
}]
}
このPOSTメソッドは、デプロイするファイルが管理サーバーのファイル・システムに存在しない場合、新規アプリケーションをデプロイします。デプロイするファイルをクライアントのファイル・システムから管理サーバーのファイル・システムにアップロードし、次にこれらをデプロイします。
注意: マルチパート・フォームを使用して作成する場合、次を実行する必要があります。
deploymentフォーム要素を使用してデプロイするファイルを指定します。
planフォーム要素を使用してデプロイするプランを指定します。
modelフォーム要素を使用して、テンプレートの他の部分で送信します。
リクエスト問合せパラメータ
このリソースは、アプリケーションをアップロードしデプロイするジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
リクエスト本文
リクエスト本文には、multipart/form-dataのContent-Typeヘッダーを含むフォーム・データおよび次のフォーム・フィールドが含まれます。
(必須)デプロイメント・アーカイブとその対応するデプロイメント・プラン以外の、デプロイするアプリケーションに関するすべての必要な情報を指定します。
Content-Dispositionヘッダーの名前パラメータはmodelに設定する必要があります。
Content-Typeヘッダーはapplication/jsonである必要があり、コンテンツは、Applicationエンティティを含みdeploymentとplanフィールドを除くJSONオブジェクトである必要があります。
(必須)アップロードするデプロイメント・アーカイブを指定します。
Content-Dispositionヘッダーの名前パラメータはdeploymentに設定する必要があり、ファイル名パラメータを、アップロードされるデプロイメント・アーカイブのサーバー上でのファイル名に設定する必要があります。
Content-Typeヘッダーはapplication/octet-streamである必要があり、コンテンツはデプロイメント・アーカイブ・データである必要があります。
(オプション)アップロードするデプロイメント・プランを指定します。
Content-Dispositionヘッダーの名前パラメータはplanに設定する必要があり、ファイル名パラメータを、アップロードされるデプロイメント・プランのサーバー上でのファイル名に設定する必要があります。
Content-Typeヘッダーはapplication/octet-streamである必要があり、コンテンツはデプロイメント・プラン・データである必要があります。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは201 Createdステータス・コードおよび新規ライブラリ・リソースへのリンクを含むLocationヘッダーを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードおよび想定される新規ライブラリ・リソースへのリンクを含むLocationヘッダーを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コード、ジョブ・リソースへのリンクおよび想定される新規ライブラリ・リソースへのリンクを含むLocationヘッダーを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。
例
この例は、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."
}
}
このリソースは、アプリケーションを管理します。
リソースでは、次のメソッドがサポートされます。
DELETEメソッドは、リソースURLで識別されるアプリケーションをアンデプロイします。
リクエスト問合せパラメータ
このリソースは、アプリケーションをアンデプロイするジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コードおよびジョブ・リソースへのリンクを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。
例
この例は、DELETEメソッドを使用して、アプリケーションをアンデプロイします。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/wls/latest/deployments/application/id/BasicApp
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"messages": [{
"message": "Undeployed the application 'BasicApp'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/2"
}],
"item": {
"operation": "remove",
"status": "completed",
"beginTime": 1390587119309,
"endTime": 1390587119588,
"name": "ADTR-2",
"id": "2",
"type": "deployment",
"targets": [{
"errors": [],
"status": "completed",
"name": "myserver",
"type": "server"
}],
"deploymentName": "BasicApp",
"description": "[Deployer:149026]remove application BasicApp on myserver."
}
}
この例は、DELETEメソッドを使用して、アプリケーションを非同期でアンデプロイします。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/wls/latest/deployments/application/id/fairShare?__detached=true
レスポンスの例
HTTP/1.1 202 Accepted
Response Body:
{
"messages": [{
"message": "Undeploying the application 'fairShare'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/35"
}]
}
このリソースのGETメソッドは、リソースURLによって識別されるアプリケーションに関する情報を返します。
レスポンス本文
返されるレスポンス本文には、指定したアプリケーションに関する情報を含むApplicationエンティティが含まれます。
このメソッドは次のリンクを返すことができます。
uri=/management/wls/{version}/deployments/application/id/{application-name}/bindables rel=bindables
例
この例は、GETメソッドを使用して、特定のアプリケーションに関する情報を表示します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/deployments/application/id/fairShare
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/application"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/application\/id\/fairShare\/redeploy",
"title": "redeploy"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/application\/id\/fairShare\/update",
"title": "update"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/application\/id\/fairShare\/start",
"title": "start"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/application\/id\/fairShare\/stop",
"title": "stop"
},
{
"rel": "bindables",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/application\/id\/fairShare\/bindables"
}
],
"item": {
"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": []
}
}
このリソースは、アプリケーションの外部リソース参照を管理します。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、このアプリケーションの外部リソース参照のリストを返します。
例
この例は、GETリクエストを使用して、アプリケーションのバインド可能値を表示します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/deployments/application/id/MyApp/bindables
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/application\/id\/MyApp"
}],
"item": {
"writeable": true,
"bindables": [
{
"name": "JNDIName",
"jndiName": "gddsBean1",
"path": [
{
"name": "ApplicationDescriptor",
"type": "DescriptorMBean"
},
{
"name": "gddsBean2",
"type": "ResourceDescriptionBean"
}
]
},
{
"name": "JNDIName",
"jndiName": "gddsBean1",
"path": [
{
"name": "ApplicationDescriptor",
"type": "DescriptorMBean"
},
{
"name": "gddsBean3",
"type": "ResourceEnvDescriptionBean"
}
]
},
{
"name": "JNDIName",
"type": "ejb",
"jndiName": "gddsBean1",
"path": [
{
"name": "ApplicationDescriptor",
"type": "DescriptorMBean"
},
{
"name": "gddsBean1",
"type": "EjbReferenceDescriptionBean"
}
]
},
{
"name": "JNDIName",
"jndiName": "gddsBean",
"path": [
{
"name": "mywar.war",
"type": "AppDeploymentConfigurationModuleMBean"
},
{
"name": "WebAppDescriptor",
"type": "DescriptorMBean"
},
{
"name": "gddsBean2",
"type": "ResourceDescriptionBean"
}
]
},
{
"name": "JNDIName",
"jndiName": "gddsBean",
"path": [
{
"name": "mywar.war",
"type": "AppDeploymentConfigurationModuleMBean"
},
{
"name": "WebAppDescriptor",
"type": "DescriptorMBean"
},
{
"name": "gddsBean3",
"type": "ResourceEnvDescriptionBean"
}
]
},
{
"name": "JNDIName",
"type": "ejb",
"jndiName": "gddsBean",
"path": [
{
"name": "mywar.war",
"type": "AppDeploymentConfigurationModuleMBean"
},
{
"name": "WebAppDescriptor",
"type": "DescriptorMBean"
},
{
"name": "gddsBean1",
"type": "EjbReferenceDescriptionBean"
}
]
}
]
}
}
POSTメソッドは、アプリケーションの外部リソース参照を更新します。このメソッドを呼び出すには、アプリケーションにデプロイメント・プランが必要です。
例
この例は、POSTメソッドを使用して、アプリケーションのバインド可能値を更新します。
リクエストの例
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
'bindables': [
{
'jndiName': 'JNDINAME1',
'name': 'JNDIName',
'type': 'Ejb',
'path': [
{
'name': 'ApplicationDescriptor',
'type': 'DescriptorMBean'
},
{
'name': 'gddsBean1',
'type': 'EjbReferenceDescriptionBean'
}
]
},
{
'jndiName': 'JNDINAME2',
'name': 'JNDIName',
'type': 'JmsConnectionFactory',
'path': [
{
'name': 'ApplicationDescriptor',
'type': 'DescriptorMBean'
},
{
'name': 'gddsBean2',
'type': 'ResourceDescriptionBean'
}
]
},
{
'jndiName': 'JNDINAME3',
'name': 'JNDIName',
'type': 'Resource Adapter',
'path': [
{
'name': 'ApplicationDescriptor',
'type': 'DescriptorMBean'
},
{
'name': 'gddsBean3',
'type': 'ResourceEnvDescriptionBean'
}
]
},
{
'jndiName': 'JNDINAME4',
'name': 'JNDIName',
'type': 'JmsConnectionFactory',
'path': [
{
'name': 'mywar.war',
'type': 'AppDeploymentConfigurationModuleMBean'
},
{
'name': 'WebAppDescriptor',
'type': 'DescriptorMBean'
},
{
'type': 'WeblogicWebAppBean'
},
{
'name': 'gddsBean2',
'type': 'ResourceDescriptionBean'
}
]
},
{
'jndiName': 'JNDINAME5',
'name': 'JNDIName',
'type': 'Resource Adapter',
'path': [
{
'name': 'mywar.war',
'type': 'AppDeploymentConfigurationModuleMBean'
},
{
'name': 'WebAppDescriptor',
'type': 'DescriptorMBean'
},
{
'type': 'WeblogicWebAppBean'
},
{
'name': 'gddsBean3',
'type': 'ResourceEnvDescriptionBean'
}
]
},
{
'jndiName': 'JNDINAME6',
'name': 'JNDIName',
'type': 'Ejb',
'path': [
{
'name': 'mywar.war',
'type': 'AppDeploymentConfigurationModuleMBean'
},
{
'name': 'WebAppDescriptor',
'type': 'DescriptorMBean'
},
{
'type': 'WeblogicWebAppBean'
},
{
'name': 'gddsBean1',
'type': 'EjbReferenceDescriptionBean'
}
]
}
]
}" \
-X POST http://localhost:7001/management/wls/latest/deployments/application/id/MyApp/bindables
レスポンスの例
HTTP/1.1 100 Continue
HTTP/1.1 200 OK
Response Body:
{"messages": [{
"message": "Successfully updated 'MyApp'.",
"severity": "SUCCESS"
}]}
このリソースは、アプリケーションを再デプロイします。
リソースでは、次のメソッドがサポートされます。
リソースでは、次のメソッドがサポートされます。
このPOSTメソッドは、リソースURLで識別されるアプリケーションを再デプロイします。再デプロイするファイルが管理サーバーのファイル・システムにすでにある場合、このメソッドを使用します。たとえば、デプロイメントが参照するファイルを物理的に置き換えて、新規ファイルを使用してデプロイメントを開始する場合などです。
このメソッドは、基底のデプロイメント・アーカイブまたは展開済ディレクトリを更新した後に呼び出す必要があります。
リクエスト問合せパラメータ
このリソースは、アプリケーションを再デプロイするジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コードおよびジョブ・リソースへのリンクを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。
例
この例は、POSTメソッドを使用して、指定されたアプリケーションを再デプロイします。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/deployments/application/id/fairShare/redeploy
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"messages": [{
"message": "Redeployed the application 'fairShare'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/25"
}],
"item": {
"operation": "redeploy",
"status": "completed",
"beginTime": 1390587186018,
"endTime": 1390587186120,
"name": "ADTR-25",
"id": "25",
"type": "deployment",
"targets": [
{
"errors": [],
"status": "completed",
"name": "Cluster-0",
"type": "cluster"
},
{
"errors": [],
"status": "completed",
"name": "myserver",
"type": "server"
}
],
"deploymentName": "fairShare",
"description": "[Deployer:149026]redeploy application fairShare on Cluster-0,myserver."
}
}
この例は、POSTメソッドを使用して、指定されたアプリケーションを非同期で再デプロイします。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/deployments/application/id/fairShare/redeploy?__detached=true
レスポンスの例
HTTP/1.1 202 Accepted
Response Body:
{
"messages": [{
"message": "Redeploying the application 'fairShare'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/34"
}]
}
このPOSTメソッドは、アプリケーションをアップロードおよび再デプロイします。再デプロイするファイルがクライアントのファイル・システムに存在する場合、このメソッドを使用します。ファイルを管理サーバーにアップロードし、次にそれを使用して起動するようにデプロイメントに信号を送信します。
リクエスト問合せパラメータ
このリソースは、アプリケーションをアップロードし再デプロイするジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
リクエスト本文
リクエスト本文には、multipart/form-dataのContent-Typeヘッダーを含むフォーム・データおよび次のフォーム・フィールドが含まれます。
(必須)再デプロイするアプリケーションを指定します。
Content-Dispositionヘッダーの名前パラメータはdeploymentに設定する必要があり、ファイル名パラメータを、デプロイメント・アーカイブのサーバー上でのファイル名に設定する必要があります。
Content-Typeヘッダーはapplication/octet-streamである必要があり、コンテンツはデプロイメント・アーカイブ・データである必要があります。
(オプション)アプリケーションの新規デプロイメント・プランを指定します。
Content-Dispositionヘッダーの名前パラメータはplanに設定する必要があり、ファイル名パラメータは、デプロイメント・プランのサーバー上でのファイル名に設定する必要があります。
Content-Typeヘッダーはapplication/octet-streamである必要があり、コンテンツはデプロイメント・プラン・データである必要があります。
(オプション)アーカイブ・バージョンを文字列として指定します。
Content-Dispositionヘッダーの名前パラメータはarchiveVersionに設定する必要があります。
Content-Typeヘッダーはtext/plainである必要があります。
(オプション)プラン・バージョンを文字列として指定します。
Content-Dispositionヘッダーの名前パラメータはplanVersionに設定する必要があります。
Content-Typeヘッダーはtext/plainである必要があります。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コードおよびジョブ・リソースへのリンクを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。
例
この例は、POSTメソッドを使用して、アーカイブをアップロードし、アプリケーションとして再デプロイします。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -H Content-Type:multipart/form-data \ -F "deployment=@/deployments/fairShare.war" \ -X POST http://localhost:7001/management/wls/latest/deployments/application/id/myapp/redeploy
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"messages": [{
"message": "Redeployed the application 'myapp'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/29"
}],
"item": {
"operation": "deploy",
"status": "completed",
"beginTime": 1390587195811,
"endTime": 1390587196066,
"name": "ADTR-29",
"id": "29",
"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."
}
}
この例は、POSTメソッドを使用して、非同期でアーカイブをアップロードし、それをアプリケーションとして再デプロイします。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -H Content-Type:multipart/form-data \ -F "deployment=@/deployments/fairShare.war" \ -X POST http://localhost:7001/management/wls/latest/deployments/library/id/airline/redeploy?__detached=true
レスポンスの例
HTTP/1.1 202 Accepted
Response Body:
{
"messages": [{
"message": "Redeploying the library 'airline'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/13"
}]
}
このリソースは、アプリケーションを開始します。
リソースでは、次のメソッドがサポートされます。
POSTメソッドは、リソースURLで識別されるアプリケーションを開始します。
リクエスト問合せパラメータ
このリソースは、アプリケーションを開始するジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コードおよびジョブ・リソースへのリンクを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。
例
この例は、POSTメソッドを使用して、アプリケーションを開始します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/deployments/application/id/fairShare/start
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"messages": [{
"message": "Started the application 'fairShare'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/24"
}],
"item": {
"operation": "start",
"status": "completed",
"beginTime": 1390587183386,
"endTime": 1390587183443,
"name": "ADTR-24",
"id": "24",
"type": "deployment",
"targets": [
{
"errors": [],
"status": "completed",
"name": "Cluster-0",
"type": "cluster"
},
{
"errors": [],
"status": "completed",
"name": "myserver",
"type": "server"
}
],
"deploymentName": "fairShare",
"description": "[Deployer:149026]start application fairShare on Cluster-0,myserver."
}
}
この例は、POSTメソッドを使用して、アプリケーションを非同期で開始します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/deployments/application/id/fairShare/start?__detached=true
レスポンスの例
HTTP/1.1 202 Accepted
Response Body:
{
"messages": [{
"message": "Starting the application 'fairShare'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/33"
}]
}
このリソースは、アプリケーションを停止します。
リソースでは、次のメソッドがサポートされます。
POSTメソッドは、リソースURLで識別されるアプリケーションを停止します。
リクエスト問合せパラメータ
このリソースは、アプリケーションを停止するジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コードおよびジョブ・リソースへのリンクを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。
例
この例は、POSTメソッドを使用して、アプリケーションを停止します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/deployments/application/id/fairShare/stop
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"messages": [{
"message": "Stopped the application 'fairShare'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/23"
}],
"item": {
"operation": "stop",
"status": "completed",
"beginTime": 1390587180998,
"endTime": 1390587181033,
"name": "ADTR-23",
"id": "23",
"type": "deployment",
"targets": [
{
"errors": [],
"status": "completed",
"name": "Cluster-0",
"type": "cluster"
},
{
"errors": [],
"status": "completed",
"name": "myserver",
"type": "server"
}
],
"deploymentName": "fairShare",
"description": "[Deployer:149026]stop application fairShare on Cluster-0,myserver."
}
}
この例は、POSTメソッドを使用して、アプリケーションを非同期で停止します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/deployments/application/id/fairShare/stop?__detached=true
レスポンスの例
HTTP/1.1 202 Accepted
Response Body:
{
"messages": [{
"message": "Stopping the application 'fairShare'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/32"
}]
}
このリソースは、アプリケーションを更新します。アプリケーションを再デプロイせずに、デプロイメント・プラン内の動的要素を更新する場合、このリソースを使用します。セッションは失われません。再デプロイ・リソースを使用して実際のデプロイメントを更新します。デプロイメント・プラン内のすべての変更も更新しますが、セッションが失われます。
リソースでは、次のメソッドがサポートされます。
POSTメソッドは、リソースURLで識別されるアプリケーションを更新します。このメソッドは、基底のデプロイメント・プランを更新した後に呼び出す必要があります。
リクエスト問合せパラメータ
このリソースは、アプリケーションを更新するジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コードおよびジョブ・リソースへのリンクを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。
例
この例は、POSTメソッドを使用して、デプロイメント・プランの変更でアプリケーションを更新します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/deployments/application/id/BasicApp/update
レスポンスの例
HTTP/1.1 400 Bad Request
Response Body:
{
"messages": [{
"message": "Failed to update the application 'BasicApp'.",
"severity": "FAILURE"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/37"
}],
"item": {
"operation": "update",
"error": "\n The application BasicApp cannot have the resource \/deployments\/BasicApp\/plan\/Plan.xml updated dynamically. Either:\n1.) The resource does not exist. \n or \n2) The resource cannot be changed dynamically. \nPlease ensure the resource uri is correct, and redeploy the entire application for this change to take effect.",
"status": "failed",
"beginTime": 1390587229032,
"endTime": 1390587229322,
"name": "ADTR-37",
"id": "37",
"type": "deployment",
"targets": [{
"errors": ["\n The application BasicApp cannot have the resource \/deployments\/BasicApp\/plan\/Plan.xml updated dynamically. Either:\n1.) The resource does not exist. \n or \n2) The resource cannot be changed dynamically. \nPlease ensure the resource uri is correct, and redeploy the entire application for this change to take effect."],
"status": "failed",
"name": "myserver",
"type": "server"
}],
"deploymentName": "BasicApp",
"description": "[Deployer:149026]update application BasicApp on myserver."
}
}
このリソースはデプロイメント(アーカイブまたは展開済ディレクトリ)を調査し、関連する情報を返します。これは、デプロイ前のデプロイメントの情報、たとえばライブラリかアプリケーションかなどを検出する場合に便利です。
リソースでは、次のメソッドがサポートされます。
このリソースのOPTIONSメソッドは、デフォルト値が事前移入されているテンプレート・エンティティを返します。
デプロイメントを調査する場合、このメソッドを呼び出してテンプレートを取得し、deploymentPathどの値を入力して、POSTメソッドでこれを使用してデプロイメントを調査します。
例
この例は、OPTIONSメソッドを使用して、デプロイメント調査用のテンプレートを取得します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X OPTIONS http://localhost:7001/management/wls/latest/deployments/inspect
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{"item": {
"planPath": null,
"deploymentPath": null
}}
このリソースのPOSTメソッドは、デプロイメントを調べ、その情報を返します。
例
この例は、POSTメソッドを使用して、デプロイメントの前にライブラリを調査します。
リクエストの例
curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d "{
deploymentPath: '/deployments/aquarium_sv2_ivfab.ear'
}" \
-X POST http://localhost:7001/management/wls/latest/deployments/inspect
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments"
}],
"item": {
"deploymentType": "library",
"name": "aquarium_sv2_ivfab",
"specVersion": "2.0",
"implVersion": "fabulous",
"deploymentPath": "\/deployments\/aquarium_sv2_ivfab.ear"
}
}
このリソースは、このWLSドメインにデプロイされているライブラリを管理します。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、このWLSドメイン内のすべてのライブラリのリストを返します。
例
この例は、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メソッドは、デフォルト値が事前移入されているテンプレート・エンティティを返します。
ライブラリをデプロイする場合、このメソッドを呼び出してテンプレートを取得し、ライブラリへのパスなどの値を入力して、POSTメソッドでこれを使用してライブラリをデプロイします。
例
この例は、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メソッドは新規ライブラリをデプロイします。
リクエスト問合せパラメータ
このリソースは、ライブラリをデプロイするジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは201 Createdステータス・コードおよび新規ライブラリ・リソースへのリンクを含むLocationヘッダーを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードおよび想定される新規ライブラリ・リソースへのリンクを含むLocationヘッダーを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コード、ジョブ・リソースへのリンクおよび想定される新規ライブラリ・リソースへのリンクを含むLocationヘッダーを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。
例
この例は、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."
}
}
この例は、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."
}
}
このPOSTメソッドは新規ライブラリをアップロードおよびデプロイします。
注意: マルチパート・フォームを使用して作成する場合、次を実行する必要があります。
deploymentフォーム要素を使用してデプロイするファイルを指定します。
modelフォーム要素を使用して、テンプレートの他の部分で送信します。
リクエスト問合せパラメータ
このリソースは、ライブラリをアップロードしデプロイするジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
リクエスト本文
リクエスト本文には、multipart/form-dataのContent-Typeヘッダーを含むフォーム・データおよび次のフォーム・フィールドが含まれます。
(必須)デプロイするライブラリに関するすべての必要な情報を指定します。
Content-Dispositionヘッダーの名前パラメータはmodelに設定する必要があります。
Content-Typeヘッダーはapplication/jsonである必要があり、コンテンツは、Libraryエンティティを含みdeploymentフィールドを除くJSONオブジェクトである必要があります。
(必須)デプロイするライブラリを指定します。
Content-Dispositionヘッダーの名前パラメータはdeploymentに設定する必要があり、ファイル名パラメータは、ライブラリのサーバー上でのファイル名に設定する必要があります。
Content-Typeヘッダーはapplication/octet-streamである必要があり、コンテンツはライブラリ・データである必要があります。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは201 Createdステータス・コードおよび新規ライブラリ・リソースへのリンクを含むLocationヘッダーを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードおよび想定される新規ライブラリ・リソースへのリンクを含むLocationヘッダーを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コード、ジョブ・リソースへのリンクおよび想定される新規ライブラリ・リソースへのリンクを含むLocationヘッダーを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。
例
この例は、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."
}
}
この例は、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"
}]
}
このリソースは、ライブラリを管理します。
リソースでは、次のメソッドがサポートされます。
DELETEメソッドは、リソースURLで識別されるライブラリをアンデプロイします。
リクエスト問合せパラメータ
このリソースは、ライブラリをアンデプロイするジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コードおよびジョブ・リソースへのリンクを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。
例
この例は、DELETEメソッドを使用して、ライブラリをアンデプロイします。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X DELETE http://localhost:7001/management/wls/latest/deployments/library/id/airline
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"messages": [{
"message": "Undeployed the library 'airline'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/3"
}],
"item": {
"operation": "remove",
"status": "completed",
"beginTime": 1390587121460,
"endTime": 1390587121632,
"name": "ADTR-3",
"id": "3",
"type": "deployment",
"targets": [
{
"errors": [],
"status": "completed",
"name": "Cluster-0",
"type": "cluster"
},
{
"errors": [],
"status": "completed",
"name": "myserver",
"type": "server"
}
],
"deploymentName": "airline",
"description": "[Deployer:149117]remove library airline on Cluster-0,myserver."
}
}
このリソースのGETメソッドは、リソースURLによって識別されるライブラリに関する情報を返します。
レスポンス本文
返されるレスポンス本文には、指定したライブラリに関する情報を含むLibraryエンティティが含まれます。
このメソッドは次のリンクを返すことができます。
uri=/management/wls/{version}/deployments/library/id/{library-name}/undeploy rel=undeploy
例
この例は、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/id/airline
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/library"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/library\/id\/airline\/redeploy",
"title": "redeploy"
}
],
"item": {
"name": "airline",
"state": "active",
"type": "library",
"targets": ["myserver"],
"displayName": "airline",
"deploymentPath": "\/deployments\/airline.war"
}
}
このリソースは、ライブラリを再デプロイします。
リソースでは、次のメソッドがサポートされます。
このPOSTメソッドは、リソースURLで識別されるライブラリをアップロードし再デプロイします。このメソッドは、基底のデプロイメント・アーカイブまたは展開済ディレクトリを更新した後に呼び出す必要があります。
リクエスト問合せパラメータ
このリソースは、ライブラリをアップロードし再デプロイするジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
リクエスト本文
リクエスト本文には、multipart/form-dataのContent-Typeヘッダーを含むフォーム・データおよび次のフォーム・フィールドが含まれます。
(必須)再デプロイするライブラリを指定します。
Content-Dispositionヘッダーの名前パラメータはdeploymentに設定する必要があり、ファイル名パラメータは、ライブラリのサーバー上でのファイル名に設定する必要があります。
Content-Typeヘッダーはapplication/octet-streamである必要があり、コンテンツはライブラリ・データである必要があります。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むDeploymentJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コードおよびジョブ・リソースへのリンクを返します。この場合、レスポンスにはDeploymentJobエンティティが含まれません。
例
この例は、POSTメソッドを使用して、アーカイブをアップロードし、ライブラリとして再デプロイします。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -H Content-Type:multipart/form-data \ -F "deployment=@/deployments/fairShare.war" \ -X POST http://localhost:7001/management/wls/latest/deployments/library/id/airline/redeploy
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"messages": [{
"message": "Redeployed the library 'airline'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/9"
}],
"item": {
"operation": "deploy",
"status": "completed",
"beginTime": 1390587135085,
"endTime": 1390587135333,
"name": "ADTR-9",
"id": "9",
"type": "deployment",
"targets": [{
"errors": [],
"status": "completed",
"name": "myserver",
"type": "server"
}],
"deploymentName": "airline",
"description": "[Deployer:149117]deploy library airline on myserver."
}
}
この例は、POSTメソッドを使用して、アーカイブをアップロードし、ライブラリとして再デプロイします。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -H Content-Type:multipart/form-data \ -F "deployment=@/deployments/fairShare.war" \ -X POST http://localhost:7001/management/wls/latest/deployments/library/id/airline/redeploy?__detached=true
レスポンスの例
HTTP/1.1 202 Accepted
Response Body:
{
"messages": [{
"message": "Redeploying the library 'airline'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment\/id\/13"
}]
}
このリソースは、このWLSドメインで実行中のジョブをリストします。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、このWLSドメイン内のすべてのジョブのリストを返します。
レスポンス本文
返されるレスポンス本文には、Jobエンティティの集合が含まれます。また、対応するリソースへのリンクも含まれます。
このメソッドは次のリンクを返すことができます。
uri=/management/wls/{version}/jobs/deployment rel=deployment
uri=/management/wls/{version}/jobs/server rel=server
例
この例は、GETメソッドを使用して、すべてのジョブに関する情報を取得します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/jobs
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest"
},
{
"rel": "server",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server"
},
{
"rel": "deployment",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment"
},
{
"rel": "items.id",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_0_start",
"title": "Cluster-0-Server-1:_0_start"
}
],
"items": [{
"status": "completed",
"beginTime": 1390586983126,
"endTime": 1390586998781,
"name": "_0_start",
"id": "Cluster-0-Server-1:_0_start",
"type": "server",
"description": "Starting Cluster-0-Server-1 server ..."
}]
}
このリソースは、すべてのデプロイメント関連ジョブの情報を返します。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、デプロイメント操作に関連する各ジョブの情報を返します。
例
この例は、GETメソッドを使用して、すべてのデプロイメント・ジョブに関する情報を取得します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/jobs/deployment
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment"
}],
"items": [{
"operation": "deploy",
"status": "in progress",
"beginTime": 1390587139546,
"name": "ADTR-11",
"id": "11",
"type": "deployment",
"targets": [{
"errors": [],
"status": "in progress",
"name": "myserver",
"type": "server"
}],
"deploymentName": "airline",
"description": "[Deployer:149117]deploy library airline on myserver."
}]
}
このリソースは、デプロイメント関連ジョブの情報を返します。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、リソースURLによって識別されるデプロイメント関連ジョブの情報を返します。
例
この例は、GETメソッドを使用して、デプロイメント・ジョブに関する情報を取得します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/jobs/deployment/id/11
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/deployment"
}],
"item": {
"operation": "deploy",
"status": "in progress",
"beginTime": 1390587139546,
"name": "ADTR-11",
"id": "11",
"type": "deployment",
"targets": [{
"errors": [],
"status": "in progress",
"name": "myserver",
"type": "server"
}],
"deploymentName": "airline",
"description": "[Deployer:149117]deploy library airline on myserver."
}
}
このリソースは、すべてのサーバー・ライフサイクル・ジョブの情報を返します。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、サーバー・ライフサイクル操作に関連する各ジョブの情報を返します。
例
この例は、GETメソッドを使用して、すべてのサーバー・ライフサイクル・ジョブに関する情報を取得します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/jobs/server
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs"
},
{
"rel": "server",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_0_start",
"title": "Cluster-0-Server-1:_0_start"
}
],
"items": [{
"operation": "start",
"status": "completed",
"beginTime": 1390586983126,
"endTime": 1390586998781,
"name": "_0_start",
"id": "Cluster-0-Server-1:_0_start",
"type": "server",
"description": "Starting Cluster-0-Server-1 server ...",
"serverName": "Cluster-0-Server-1"
}]
}
このリソースは、サーバー・ライフサイクル・ジョブの情報を返します。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、リソースURLで識別された特定のサーバー・ライフサイクル・ジョブに関する情報を返します。
例
この例は、GETメソッドを使用して、サーバー・ライフサイクル・ジョブに関する情報を取得します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/jobs/server/id/Cluster-0-Server-1:_8_start
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server"
}],
"item": {
"operation": "start",
"status": "in progress",
"beginTime": 1390587038967,
"name": "_8_start",
"id": "Cluster-0-Server-1:_8_start",
"type": "server",
"description": "Starting Cluster-0-Server-1 server ...",
"serverName": "Cluster-0-Server-1"
}
}
このリソースは、WLSドメイン内のサーバーを列挙し、サマリー・メトリックおよび各サーバーの状態を示します。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、このドメインのサーバーのリストを返します。
リクエスト問合せパラメータ
このメソッドでは、レスポンスに含められるフィールドの制限に使用できるオプションの問合せパラメータがサポートされます。必要とする情報のみにフィールドを制限すると、大規模なデータ・セットとやりとりする際にレスポンス時間を短縮できます。
(オプション)これらの値が必須ではなく、レスポンスで省略可能であることを指定します。
(オプション)これらの値が必須であり、レスポンスに含める必要があることを指定します。
包含と除外は相互に排他的であり、いずれも指定しない場合すべての使用可能な情報が含まれます。
例
この例は、GETメソッドを使用して、このドメインのすべてのサーバーのリストを返します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/servers
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/myserver",
"title": "myserver"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/Cluster-0-Server-1",
"title": "Cluster-0-Server-1"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/Cluster-0-Server-2",
"title": "Cluster-0-Server-2"
}
],
"items": [
{
"name": "myserver",
"state": "running",
"heapFreeCurrent": 136785464,
"heapSizeCurrent": 423231488,
"activeHttpSessionCount": 0,
"activeThreadCount": 5,
"health": {"state": "ok"},
"usedPhysicalMemory": 3502743552,
"jvmProcessorLoad": 0
},
{
"name": "Cluster-0-Server-1",
"state": "shutdown"
},
{
"name": "Cluster-0-Server-2",
"state": "shutdown"
}
]
}
このリソースは、特定のサーバーの情報を取得します。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、リソースURLによって識別されるサーバーに関する情報を返します。
レスポンス本文
返されるレスポンス本文には、指定したサーバーに関する情報を含むServerエンティティが含まれます。
このメソッドは次のリンクを返すことができます。
uri=/management/wls/{version}/servers/id/{server-name}/logs rel=logs
例
この例は、GETメソッドを使用して、特定のサーバーに関する情報を取得します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers"
},
{
"rel": "logs",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/Cluster-0-Server-1\/logs"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/Cluster-0-Server-1\/start",
"title": "start"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/Cluster-0-Server-1\/restart",
"title": "restart"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/Cluster-0-Server-1\/suspend",
"title": "suspend"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/Cluster-0-Server-1\/resume",
"title": "resume"
},
{
"rel": "action",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/Cluster-0-Server-1\/shutdown",
"title": "shutdown"
}
],
"item": {
"name": "Cluster-0-Server-1",
"state": "running",
"heapFreeCurrent": 231060176,
"heapSizeCurrent": 320798720,
"activeHttpSessionCount": 0,
"activeThreadCount": 6,
"health": {"state": "ok"},
"usedPhysicalMemory": 3925577728,
"jvmProcessorLoad": 0
}
}
このリソースは、このサーバーに対して保持されているログのリストを返します。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、サーバーのログ・ファイル・リストを返します。
例
この例は、GETメソッドを使用して、サーバーで入手可能なログをすべて検索します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/logs
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/Cluster-0-Server-1"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/Cluster-0-Server-1\/logs\/id\/HTTPAccessLog",
"title": "HTTPAccessLog"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/Cluster-0-Server-1\/logs\/id\/DataSourceLog",
"title": "DataSourceLog"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/Cluster-0-Server-1\/logs\/id\/ServerLog",
"title": "ServerLog"
}
],
"items": [
{"name": "HTTPAccessLog"},
{"name": "DataSourceLog"},
{"name": "ServerLog"}
]
}
このリソースは、サーバーのログ内のエントリを表示します。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、サーバーのログを返します。
リクエスト問合せパラメータ
このメソッドでは、レスポンスに含められる結果のフィルタおよび制限に使用できるオプションの問合せパラメータがサポートされます。
(オプション)返されるエントリの最大数を指定します。
maxResultsが指定されていない場合または1未満の場合、ログ内のすべてのエントリが返されます。それ以外の場合、maxResultsエントリのみが返されます。一致するエントリがmaxResultsを超える場合、最後のmaxResultsエントリが(基底のログ内のエントリの順序に基づいて)返されます。
(オプション)返される最も古いログ・エントリを指定します。問合せパラメータを有効なURLに変換するにはエンコードする必要があります。スペースは%20、'/' (スラッシュ)は%2F、':' (コロン)は%3Aとなります。たとえば、management/wls/latest/servers/id/myserver/logs/id/mylog?startTime=11/21/14 12:06:53 would become management/wls/latest/servers/id/myserver/logs/id/mylog?startTime=11%2F21%2F14%2012%3A06%3A53となります。
(オプション)返される最も新しいログ・エントリを指定します。問合せパラメータを有効なURLに変換するにはエンコードする必要があります。スペースは%20、'/' (スラッシュ)は%2F、':' (コロン)は%3Aとなります。たとえば、management/wls/latest/servers/id/myserver/logs/id/mylog?endTime=11/21/14 02:23:15 would become management/wls/latest/servers/id/myserver/logs/id/mylog?endTime=11%2F21%2F14%2002%3A23%3A15となります。
(オプション)返されるエントリをフィルタおよび制限するために使用できるWeblogic診断フレームワーク(WLDF)問合せ式を指定します。(olink:WLDFC316)
例
この例は、GETメソッドを使用して、サーバー・ログ内の最新の5エントリを返します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/logs/id/ServerLog?maxResults=5
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/servers\/id\/Cluster-0-Server-1\/logs"
}],
"items": [
{
"timeStamp": "01\/24\/14 13:09:58 604",
"message": "The server \"myserver\" connected to this server.",
"severity": "Info",
"subSystem": "Server",
"userId": "WLS Kernel",
"contextId": "",
"recordId": "90",
"msgId": "BEA-002635"
},
{
"timeStamp": "01\/24\/14 13:09:58 613",
"message": "Starting \"async\" replication service with remote cluster address \"null\"",
"severity": "Notice",
"subSystem": "Cluster",
"userId": "WLS Kernel",
"contextId": "",
"recordId": "91",
"msgId": "BEA-000162"
},
{
"timeStamp": "01\/24\/14 13:09:58 670",
"message": "The server started in RUNNING mode.",
"severity": "Notice",
"subSystem": "WebLogicServer",
"userId": "WLS Kernel",
"contextId": "",
"recordId": "92",
"msgId": "BEA-000360"
},
{
"timeStamp": "01\/24\/14 13:09:59 507",
"message": "Server state changed to RUNNING.",
"severity": "Notice",
"subSystem": "WebLogicServer",
"userId": "WLS Kernel",
"contextId": "",
"recordId": "93",
"msgId": "BEA-000365"
},
{
"timeStamp": "01\/24\/14 13:09:59 512",
"message": "Instantiated an instance of org.hibernate.validator.engine.resolver.JPATraversableResolver.",
"severity": "Info",
"subSystem": "org.hibernate.validator.engine.resolver.DefaultTraversableResolver",
"userId": "WLS Kernel",
"contextId": "",
"recordId": "94",
"msgId": "BEA-000000"
}
]
}
このリソースは、特定のサーバーを再起動します。
リソースでは、次のメソッドがサポートされます。
POSTメソッドは、リソースURLで識別されるサーバーを再起動します。
リクエスト問合せパラメータ
このリソースは、サーバーを再起動するジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むServerJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コードおよびジョブ・リソースへのリンクを返します。この場合、レスポンスにはServerJobエンティティが含まれません。
例
この例は、POSTメソッドを使用して、サーバーを同期的に再起動します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/restart
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"messages": [{
"message": "Restarted the server 'Cluster-0-Server-1'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_4_start"
}],
"item": {
"operation": "start",
"status": "completed",
"beginTime": 1390587009914,
"endTime": 1390587022047,
"name": "_4_start",
"id": "Cluster-0-Server-1:_4_start",
"type": "server",
"description": "Starting Cluster-0-Server-1 server ...",
"serverName": "Cluster-0-Server-1"
}
}
この例は、POSTメソッドを使用して、デタッチ・モードでサーバーを再起動します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/restart?__detached=true
レスポンスの例
HTTP/1.1 202 Accepted
Response Body:
{
"messages": [{
"message": "Restarting the server 'Cluster-0-Server-1'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_12_start"
}]
}
このリソースはサーバーを再開します。
リソースでは、次のメソッドがサポートされます。
POSTメソッドは、中断またはADMIN状態のサーバー・インスタンスを再開します。
リクエスト問合せパラメータ
このリソースは、サーバーを再起動するジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むServerJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コードおよびジョブ・リソースへのリンクを返します。この場合、レスポンスにはServerJobエンティティが含まれません。
例
この例は、POSTメソッドを使用して、サーバーを同期的に再開します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/resume
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"messages": [{
"message": "Resumed the server 'Cluster-0-Server-1'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_2_resume"
}],
"item": {
"operation": "resume",
"status": "completed",
"beginTime": 1390587004735,
"endTime": 1390587004747,
"name": "_2_resume",
"id": "Cluster-0-Server-1:_2_resume",
"type": "server",
"description": "Resuming Cluster-0-Server-1 server ...",
"serverName": "Cluster-0-Server-1"
}
}
この例は、POSTメソッドを使用して、デタッチ・モードでサーバーを再開します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/resume?__detached=true
レスポンスの例
HTTP/1.1 202 Accepted
Response Body:
{
"messages": [{
"message": "Resuming the server 'Cluster-0-Server-1'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_10_resume"
}]
}
このリソースは、特定のサーバーの正常な停止を実行します。
リソースでは、次のメソッドがサポートされます。
POSTメソッドは、リソースURLで識別されるサーバーを停止します。
リクエスト問合せパラメータ
このリソースは、サーバーを停止するジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
(オプション)サーバーを正常に停止するか(false、デフォルト)、サーバーを強制的に停止するかを指定します(true)。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むServerJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コードおよびジョブ・リソースへのリンクを返します。この場合、レスポンスにはServerJobエンティティが含まれません。
例
この例は、POSTメソッドを使用して、サーバーを同期的に停止します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/shutdown
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"messages": [{
"message": "Shutdown the server 'Cluster-0-Server-1'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_7_shutdown"
}],
"item": {
"operation": "shutdown",
"status": "completed",
"beginTime": 1390587036811,
"endTime": 1390587036940,
"name": "_7_shutdown",
"id": "Cluster-0-Server-1:_7_shutdown",
"type": "server",
"description": "Shutting down Cluster-0-Server-1 server ...",
"serverName": "Cluster-0-Server-1"
}
}
この例は、POSTメソッドを使用して、デタッチ・モードでサーバーを停止します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/shutdown?__detached=true
レスポンスの例
HTTP/1.1 202 Accepted
Response Body:
{
"messages": [{
"message": "Shutting down the server 'Cluster-0-Server-1'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_11_shutdown"
}]
}
このリソースは、特定のサーバーを開始します。
リソースでは、次のメソッドがサポートされます。
POSTメソッドは、リソースURLで識別されるサーバーを開始します。
リクエスト問合せパラメータ
このリソースは、サーバーを開始するジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むServerJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コードおよびジョブ・リソースへのリンクを返します。この場合、レスポンスにはServerJobエンティティが含まれません。
例
この例は、POSTメソッドを使用して、サーバーを同期的に開始します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/start
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"messages": [{
"message": "Started the server 'Cluster-0-Server-1'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_0_start"
}],
"item": {
"operation": "start",
"status": "completed",
"beginTime": 1390586983126,
"endTime": 1390586998781,
"name": "_0_start",
"id": "Cluster-0-Server-1:_0_start",
"type": "server",
"description": "Starting Cluster-0-Server-1 server ...",
"serverName": "Cluster-0-Server-1"
}
}
この例は、POSTメソッドを使用して、デタッチ・モードでサーバーを開始します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/start?__detached=true
レスポンスの例
HTTP/1.1 202 Accepted
Response Body:
{
"messages": [{
"message": "Starting the server 'Cluster-0-Server-1'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_8_start"
}]
}
このリソースはサーバーを中断します。
リソースでは、次のメソッドがサポートされます。
POSTメソッドは、リソースURLで識別されるサーバーを、RUNNING状態からADMIN状態に移行します。
リクエスト問合せパラメータ
このリソースは、サーバーを中断するジョブを起動します。
(オプション)このメソッドがデタッチ(バックグラウンド)・モードで実行されるか同期的に実行されるかを指定します。
__detached=true問合せパラメータが指定されている場合(デタッチ呼出し)、このメソッドはジョブの起動後ただちに返されます。そうでない場合、ジョブが完了、失敗またはタイムアウトするのを待機します(同期呼び出し)。
レスポンス本文
メソッドが同期的に呼び出され、ジョブが正常に起動された場合、レスポンス本文には、ジョブの状態(完了、失敗またはタイムアウトで依然実行中)およびジョブ・リソースへのリンクを含むServerJobエンティティが含まれます。
レスポンス・コード
メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。
メソッドがデタッチで呼び出され、ジョブが正常に起動された場合、メソッドは202 Acceptedステータス・コードおよびジョブ・リソースへのリンクを返します。この場合、レスポンスにはServerJobエンティティが含まれません。
例
この例は、POSTメソッドを使用して、サーバーを同期的に中断します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/suspend
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"messages": [{
"message": "Suspended the server 'Cluster-0-Server-1'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_1_suspendWithTimeout"
}],
"item": {
"operation": "suspending",
"status": "completed",
"beginTime": 1390587002462,
"endTime": 1390587002489,
"name": "_1_suspendWithTimeout",
"id": "Cluster-0-Server-1:_1_suspendWithTimeout",
"type": "server",
"description": "suspending Cluster-0-Server-1 server ...",
"serverName": "Cluster-0-Server-1"
}
}
この例は、POSTメソッドを使用して、デタッチ・モードでサーバーを中断します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X POST http://localhost:7001/management/wls/latest/servers/id/Cluster-0-Server-1/suspend?__detached=true
レスポンスの例
HTTP/1.1 202 Accepted
Response Body:
{
"messages": [{
"message": "Suspending the server 'Cluster-0-Server-1'.",
"severity": "SUCCESS"
}],
"links": [{
"rel": "job",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/jobs\/server\/id\/Cluster-0-Server-1:_9_suspendWithTimeout"
}]
}
このリソースは、このWLSドメイン内のすべてのサーバーおよびクラスタをリストします。
リソースでは、次のメソッドがサポートされます。
このリソースのGETメソッドは、このWLSドメイン内のすべてのサーバーおよびクラスタを返します。
例
この例は、GETメソッドを使用して、このドメインのすべてのターゲットのリストを返します。
リクエストの例
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/wls/latest/targets
レスポンスの例
HTTP/1.1 200 OK
Response Body:
{
"links": [{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest"
}],
"items": [
{
"name": "myserver",
"type": "server"
},
{
"name": "Cluster-0",
"type": "cluster"
}
]
}
