Oracle® Fusion Middleware

Oracle WebLogic Server 12.1.3 RESTful管理インタフェース・リファレンス

12c (12.1.3)

E57542-02(原本部品番号:E49342-02)

2015年8月

このリファレンスは、WebLogic Server 12.1.3ドメインを管理するためのRESTful管理APIについて説明しています。

Oracle Fusion Middleware Oracle WebLogic Server 12.1.3 RESTful管理インタフェース・リファレンス, 12c (12.1.3)

E57542-02

Copyright © 2014, 2015, Oracle and/or its affiliates.All rights reserved.

このソフトウェアおよび関連ドキュメントの使用と開示は、ライセンス契約の制約条件に従うものとし、知的財産に関する法律により保護されています。ライセンス契約で明示的に許諾されている場合もしくは法律によって認められている場合を除き、形式、手段に関係なく、いかなる部分も使用、複写、複製、翻訳、放送、修正、ライセンス供与、送信、配布、発表、実行、公開または表示することはできません。このソフトウェアのリバース・エンジニアリング、逆アセンブル、逆コンパイルは互換性のために法律によって規定されている場合を除き、禁止されています。

ここに記載された情報は予告なしに変更される場合があります。また、誤りが無いことの保証はいたしかねます。誤りを見つけた場合は、オラクル社までご連絡ください。

このソフトウェアまたは関連ドキュメントを、米国政府機関もしくは米国政府機関に代わってこのソフトウェアまたは関連ドキュメントをライセンスされた者に提供する場合は、次の通知が適用されます。

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

このソフトウェアまたはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアまたはハードウェアは、危険が伴うアプリケーション(人的傷害を発生させる可能性があるアプリケーションを含む)への用途を目的として開発されていません。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性(redundancy)、その他の対策を講じることは使用者の責任となります。このソフトウェアまたはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、オラクル社およびその関連会社は一切の責任を負いかねます。

OracleおよびJavaはOracle Corporationおよびその関連企業の登録商標です。その他の名称は、それぞれの所有者の商標または登録商標です。

Intel、Intel Xeonは、Intel Corporationの商標または登録商標です。すべてのSPARCの商標はライセンスをもとに使用し、SPARC International, Inc.の商標または登録商標です。AMD、Opteron、AMDロゴ、AMD Opteronロゴは、Advanced Micro Devices, Inc.の商標または登録商標です。UNIXは、The Open Groupの登録商標です。

このソフトウェアまたはハードウェア、そしてドキュメントは、第三者のコンテンツ、製品、サービスへのアクセス、あるいはそれらに関する情報を提供することがあります。適用されるお客様とOracle Corporationとの間の契約に別段の定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスに関して一切の責任を負わず、いかなる保証もいたしません。適用されるお客様とOracle Corporationとの間の契約に定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスへのアクセスまたは使用によって損失、費用、あるいは損害が発生しても一切の責任を負いかねます。

目次

表一覧

タイトルおよび著作権情報

はじめに

- ドキュメントのアクセシビリティについて

- 表記規則

1 リソース

- スタート・ガイド

- WebLogic Serverを管理するためのREST URLフォーマット

- リソースURL内の{version}指定子

- RESTリソースでサポートされているコンテンツ・タイプ

- RESTリソース・メソッドを使用したWebLogic Serverの管理

- RESTリソース・ツリーの動的なナビゲート

- リンク・リストの解析

- 標準のHTTPステータス・コード

- /management/wls

- GETメソッド

- /management/wls/{version}

- GETメソッド

- /management/wls/{version}/changeManager

- GETメソッド

- /management/wls/{version}/changeManager/activate

- POSTメソッド

- /management/wls/{version}/changeManager/cancelEdit

- POSTメソッド

- /management/wls/{version}/changeManager/startEdit

- POSTメソッド

- /management/wls/{version}/datasources

- GETメソッド

- OPTIONSメソッド

- POSTメソッド

- /management/wls/{version}/datasources/id/{data-source-name}

- DELETEメソッド

- GETメソッド

- POSTメソッド

- /management/wls/{version}/datasources/id/{data-source-name}/clearStatementCache

- POSTメソッド

- /management/wls/{version}/datasources/id/{data-source-name}/reset

- POSTメソッド

- /management/wls/{version}/datasources/id/{data-source-name}/resume

- POSTメソッド

- /management/wls/{version}/datasources/id/{data-source-name}/shrink

- POSTメソッド

- /management/wls/{version}/datasources/id/{data-source-name}/shutdown

- POSTメソッド

- /management/wls/{version}/datasources/id/{data-source-name}/start

- POSTメソッド

- /management/wls/{version}/datasources/id/{data-source-name}/suspend

- POSTメソッド

- /management/wls/{version}/datasources/id/{data-source-name}/test

- POSTメソッド

- /management/wls/{version}/datasources/test

- OPTIONSメソッド

- POSTメソッド

- /management/wls/{version}/datasources/vendors

- GETメソッド

- /management/wls/{version}/datasources/vendors/id/{vendor}

- GETメソッド

- /management/wls/{version}/datasources/vendors/id/{vendor}/drivers/id/{driver-class-name}

- OPTIONSメソッド

- POSTメソッド

- /management/wls/{version}/deployments

- GETメソッド

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

- GETメソッド

- OPTIONSメソッド

- POSTメソッド

- "application/json"を受け入れるPOST

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

- /management/wls/{version}/deployments/application/id/{application-name}

- DELETEメソッド

- GETメソッド

- /management/wls/{version}/deployments/application/id/{application-name}/bindables

- GETメソッド

- POSTメソッド

- /management/wls/{version}/deployments/application/id/{application-name}/redeploy

- POSTメソッド

- "application/json"を受け入れるPOST

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

- /management/wls/{version}/deployments/application/id/{application-name}/start

- POSTメソッド

- /management/wls/{version}/deployments/application/id/{application-name}/stop

- POSTメソッド

- /management/wls/{version}/deployments/application/id/{application-name}/update

- POSTメソッド

- /management/wls/{version}/deployments/inspect

- OPTIONSメソッド

- POSTメソッド

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

- GETメソッド

- OPTIONSメソッド

- POSTメソッド

- "application/json"を受け入れるPOST

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

- /management/wls/{version}/deployments/library/id/{library-name}

- DELETEメソッド

- GETメソッド

- /management/wls/{version}/deployments/library/id/{library-name}/redeploy

- POSTメソッド

- "application/json"を受け入れるPOST

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

- /management/wls/{version}/jobs

- GETメソッド

- /management/wls/{version}/jobs/deployment

- GETメソッド

- /management/wls/{version}/jobs/deployment/id/{job-id}

- GETメソッド

- /management/wls/{version}/jobs/server

- GETメソッド

- /management/wls/{version}/jobs/server/id/{job-id}

- GETメソッド

- /management/wls/{version}/servers

- GETメソッド

- /management/wls/{version}/servers/id/{server-name}

- GETメソッド

- /management/wls/{version}/servers/id/{server-name}/logs

- GETメソッド

- /management/wls/{version}/servers/id/{server-name}/logs/id/{log-name}

- GETメソッド

- /management/wls/{version}/servers/id/{server-name}/restart

- POSTメソッド

- /management/wls/{version}/servers/id/{server-name}/resume

- POSTメソッド

- /management/wls/{version}/servers/id/{server-name}/shutdown

- POSTメソッド

- /management/wls/{version}/servers/id/{server-name}/start

- POSTメソッド

- /management/wls/{version}/servers/id/{server-name}/suspend

- POSTメソッド

- /management/wls/{version}/targets

- GETメソッド

2 エンティティ

- Application

- ApplicationBindable

- ApplicationBindables

- ApplicationDescriptorScope

- ChangeManager

- DatabaseConnection

- DatabaseConnectionStatus

- DatabaseDriver

- DatabaseDriverAttribute

- DatabaseDriverAttributes

- DatabaseVendor

- DataSource

- DataSourceMetrics

- Deployment

- DeploymentDescription

- DeploymentJob

- DeploymentJobTarget

- DeploymentReference

- Ejb

- EjbCacheMetrics

- EjbLockingMetrics

- EjbMetrics

- EjbPoolMetrics

- EjbTimerMetrics

- EjbTransactionMetrics

- Health

- JdbcConnectionPoolParams

- JdbcDataSourceParams

- JdbcDriverParams

- Job

- Library

- LogEntry

- LogReference

- Server

- ServerJob

- Servlet

- ServletMetrics

- Target

- Version

- Wls

表一覧

- 1-1 構成データを管理するためのRESTリソース・メソッド

はじめに

この「はじめに」では、ドキュメント・アクセシビリティ機能およびこのガイド『Oracle WebLogic Server 12.1.3 RESTful管理インタフェース・リファレンス』で使用される表記規則について説明しています。

ドキュメントのアクセシビリティについて

Oracleのアクセシビリティについての詳細情報は、Oracle Accessibility ProgramのWebサイト(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc)を参照してください。

Oracle Supportへのアクセス

サポートをご購入のOracleのお客様は、My Oracle Supportにアクセスして電子サポートを受けることができます。詳細情報は(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info) か、聴覚に障害のあるお客様は (http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs)を参照してください。

表記規則

このマニュアルでは次の表記規則を使用します。

規則

意味

太字

太字は、操作に関連するGraphical User Interface要素、または本文中で定義されている用語および用語集に記載されている用語を示します。

イタリック体

イタリックは、ユーザーが特定の値を指定するプレースホルダ変数を示します。

固定幅フォント

固定幅フォントは、段落内のコマンド、URL、サンプル内のコード、画面に表示されるテキスト、または入力するテキストを示します。

1 リソース

この項では、Oracle WebLogic Server 12.1.3 RESTful管理リソースについて説明します。

RESTful管理リソースは、サポートされているすべての環境内のOracle WebLogic Serverプラットフォームを構成、モニタリングおよび管理するための包括的なパブリック・インタフェースを提供します。

注意:
REST管理APIのURL形式が12.1.3で変更されました。12.1.2で導入されたURL形式は引き続き機能しますが、このりリースのWebLogic Serverでは非推奨になりました。

スタート・ガイド

WebLogic ServerドメインでRESTful管理サービスを使用するには、WebLogic管理者はWebLogic Server管理コンソールを使用してこれらを有効化する必要があります。詳細は、管理コンソール・オンライン・ヘルプのRESTful管理サービスの有効化に関する項を参照してください。または、WebLogic Scripting Tool (WLST)を使用して、DomainMBeanでRestfulManagementService Enabledプロパティを設定します。

WebLogic Serverを管理するためのREST URLフォーマット

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}指定子

リソースURLの{version}指定子は、RESTリソースのバージョンを暗黙的(/latest)または明示的(/12.1.3.0)に示します。将来のWLSリリースでは、現在のRESTリソース・バージョンを使用するには/latestを、前のバージョンを指定するにはバージョン番号を指定できます。

ベスト・プラクティスとして、ナビゲーションにブラウザまたはリソース内のリンクに従う再帰クライアントを使用しており、進化するリソースに対応できる場合、/latestを使用します。リソースが進化すると破損するコードを記述している場合、バージョンを明示的に指定します。

RESTリソースでサポートされているコンテンツ・タイプ

WebLogic Server RESTful管理サービスは、次の表示フォーマットをサポートしています。

- リソースから取得できるデータ・フォーマット(Acceptヘッダーなどを使用) - JSONのみ。

- リソース内で送信できるデータ・フォーマット(Content-Typeヘッダーなどを使用) - ほとんどはJSONのみをサポートしますが、一部はマルチパート・フォームもサポートします(アプリケーションおよびライブラリのデプロイのファイル・アップロード・バージョンなど)。

RESTリソース・メソッドを使用したWebLogic Serverの管理

WebLogic Server RESTインタフェースは、構成およびモニタリング・オブジェクト・ツリー内のオブジェクトにアクセスするためのメソッドをサポートします。

表1-1は、モニタリングおよび構成データを管理するためのRESTメソッド、および各メソッドで実行できるタスクを示しています。

表1-1 構成データを管理するためのRESTリソース・メソッド

タスク

RESTメソッド

ツリー内のオブジェクトがサポートするメソッドおよびメソッド・パラメータを特定します。

OPTIONS

ツリー内のオブジェクトのデータを取得します。

GET

オブジェクトをツリーに追加します。

POST

ツリー内のオブジェクトを更新します。

POST

ツリーからオブジェクトを削除します。

DELETE

WebLogic Server RESTリソースでは次の手順を使用します。

作成

新規エンティティを作成するには、次のようにします。

1. OPTIONSを呼び出し、新規エンティティのデフォルト値を含むテンプレート・オブジェクトを取得します。

2. 返されたオブジェクトでカスタマイズするプロパティの値を変更します。

3. 変更したオブジェクトをPOSTし、新規エンティティを作成します。

編集

エンティティの一部のプロパティを変更するには、次のようにします。

1. エンティティのURLでGETを呼び出し、エンティティの現在の値を含むオブジェクトを取得します。

2. 返されたオブジェクトで変更するプロパティの値を変更します。

3. 変更したオブジェクトをPOSTし、エンティティのURLに戻します。

非同期操作

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

結果のフィルタリング

_includeFieldsおよび_excludeFields問合せパラメータを指定し、レスポンスに含められるフィールドを制限します。必要とする情報のみに収集結果をフィルタリングすると、大規模なデータ・セットとやりとりする際にレスポンス時間を短縮できます。包含と除外は相互に排他的であり、いずれも指定しない場合すべての使用可能な情報が含まれます。

ファイルのアップロード

マルチパート・フォーム・データを使用して、バイトのストリームをクライアントからWLSリソースに渡します。たとえば、デプロイ(または再デプロイ)するファイルが管理サーバーのファイル・システムに存在しない場合などです。"multipart/form-data"を受け入れるPOSTを使用して、ファイルをクライアントのファイル・システムから管理サーバーにアップロードし、デプロイ(再デプロイ)します。

RESTリソース・ツリーの動的なナビゲート

WebLogic Server RESTインタフェースは、リソース・ツリーの動的なナビゲートをサポートします。このサポートを提供するために、各RESTリソースのGETメソッドは、リソース・ツリー内の前後のリソースへのURIリストを含むlinks要素を返します。これにより、この手法を使用してリソース・ツリーをナビゲートできます。

1. リテラルでハードコードされた値をURIとして指定して、既知のRESTリソースでHTTP GETリクエストを行います。

2. リソース内のlinksリストを解析し、適切な親または子リソースを識別します。詳細は、「リンク・リストの解析」を参照してください。

3. ナビゲートを終了しており、ステップ 2で識別されたRESTリソースが操作を実行する対象である場合、適切なHTTPリクエストで、linksリストから取得したURI値を使用して操作を実行します。
リソース・ツリーのナビゲートを続行する必要がある場合、linksリストから取得されたURI値を使用して、ステップ 2で識別されたRESTリソースでHTTP GETリクエストを行います。その後、ステップ 2に戻ります。

リソース・ツリーの動的ナビゲーションの使用には、様々な利点があります。

- 各HTTPリクエストにはリテラルなハードコードされたURI値は含まれないため、ソース・コードがよりメンテナンスしやすくなります。

- コード・デプロイメント中には名前が不明なサーバーやアプリケーションなどのオブジェクトの集合全体にわたってアクションを実行できます。

リンク・リストの解析

HTTP GETリクエストへのレスポンスの一部として返されるlinks要素は、従属要素であり、それぞれ現在のリソースに直接関連する単一リソースを記述します。各従属要素には、次のプロパティが含まれます。

rel

リンクされたリソースが現在のリソースにどのように関連するかを示す文字列値。文字列値は次のとおりです。

parent

リンクされたリソースは、現在のリソースの親です。

action

リンクされたリソースは、現在のリソースによって表されるオブジェクトでアクションを実行します。titleプロパティの値は、リンクされたリソースが実行するアクションのタイプを示します。

simple-name

ドット(.)を含まない文字列。リンクされたリソースには、現在のリソース固有の現在のリソースとの関係があります。たとえば、/management/wls/{version}リソースのGETメソッドでは、ドメイン内のオブジェクトのタイプに対応するsimple-name値を含むlinkリスト要素が返されます。

- changemanger

- datasources

- deployments

- jobs

- servers

- targets

dotted-name

1つのドット(.)を含む文字列。リンクされたリソースは、現在のリソースに従属するリソースの集合のメンバーであり、GETレスポンス内の別の要素はリンクされたリソースに関する詳細情報を提供します。このような集合の例として、/management/wls/{version}/serversリソースの下の個別のサーバーがあります。

dotted-name値の最初の部分は、詳細情報を含むGETレスポンス内のリスト要素の名前で、2番目の部分は各下位要素を識別するリスト要素の下位要素内のプロパティ名です。

list-element-name.subelement-property-name

リンクされたリソースに関する詳細情報を検出するには、そのdotted-name値をそのtitle値と組み合せて使用します。

1. dotted-name値を、その2つの部分であるlist-element-nameとsubelement-property-nameで解析します。

2. GETレスポンスで、list-element-nameという名前のリスト要素を探します。このリストで、subelement-property-nameプロパティ値が、リンクされたリソースのtitleプロパティ値に一致する下位要素を探します。

たとえば、dotted-name値がitems.nameで、title値がmyserverの場合、nameプロパティ値が文字列myserverと一致するitemsリストの下位要素をGETレスポンスで探します。

uri
リンクされたリソースにアクセスするためにHTTPリクエスト内で使用するURIを含む文字列値。

title
(オプション)relプロパティ値がactionまたはdotted-nameの場合、追加情報を提供する文字列値。

- relプロパティ値がactionの場合、titleプロパティ値は、リンクされたリソースが実行するアクションの種類を記述します。

- relプロパティ値がdotted-nameの場合、titleプロパティ値は、dotted-name値によって指定されるリスト要素の下位要素プロパティ内で一致する値です。

標準のHTTPステータス・コード

この項で説明されているリソースの操作に使用されるHTTPメソッドはすべて、次のHTTPステータス・コードのいずれかを返します。

200 OK

リクエストは正常に完了しました。200は、成功したGETまたはOPTIONSメソッド、またはリソースを(作成に対して)変更するためのPOSTメソッドに対して返されます。

201 Created

要求が満たされ、新規リソースが作成されます。新たに作成されたリソースの正規のURIを含むLocationヘッダーが返されます。

201は、同期リソース作成、またはレスポンスが返される前に完了した非同期リソース作成から返されます。

202 Accepted

要求の処理は受け入れられましたが、処理は完了していません。要求は、実際に処理が行われる際に拒否される可能性があるため、最終的には処理されない場合もあります。

非同期(__detached=true)リソース作成(アプリケーションのデプロイ時など)または更新(アプリケーションの再デプロイ時など)を指定する際、操作がまだ進行中である場合202が返されます。__detached=falseの場合、基底の操作が適切な時間で終了していないと202が返されることがあります。

レスポンスには、ジョブが終了した時期を検出するためにクライアントが調査する必要があるジョブ・リソースのLocationヘッダーが含まれます。また、ジョブの現在の状態を含むエンティティを返します。

400 Bad Request

情報が欠落しているか不適切であるため(入力フィールドでの検証エラー、必須値の欠落など)、リクエストを処理できませんでした。

401 Unauthorized

リクエストが認可されていません。このリクエストに認証資格証明がないか、または無効です。

403 Forbidden

ユーザーを認証できません。ユーザーは、このリクエストを実行する権限を所有していません。

404 Not Found

リクエストで、存在しないリソースのURIが指定されました。

405 Method Not Allowed

リクエストで指定されたHTTP動詞(DELETE、GET、HEAD、POST、PUT)は、このリクエストURIではサポートされていません。

406 Not Acceptable

このリクエストによって識別されたリソースは、リクエストのAcceptヘッダーのいずれかのメディア・タイプに対応する表現を生成できません。たとえば、クライアントのAcceptヘッダーは、XMLを要求しますが、リソースはJSONのみを返すことができます。

415 Not Acceptable

クライアントのContentTypeヘッダーに誤りがあります(たとえば、クライアントがXMLで送信しようとしたがリソースはJSONのみを受入れ可能な場合など)。

500 Internal Server Error

サーバーに予期しない状況が発生し、リクエストを遂行できなくなりました。

503 Service Unavailable

現在、サーバーは、一時的なオーバーロードまたはメンテナンスのため、要求を処理できません。WLS REST Webアプリケーションは現在実行中ではありません。

/management/wls

wlsリソースは、WLSドメインによってサポートされるRESTインタフェースのバージョンに関する情報を含みます。

RESTインタフェースによってサポートされるバージョンの詳細は、「リソースURL内の{version}指定子」を参照してください。

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、サポートされているこのRESTインタフェースの各バージョンに関する情報を返します。

RESTインタフェースによってサポートされるバージョンの詳細は、「リソースURL内の{version}指定子」を参照してください。

ロール

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

レスポンス本文

返されるレスポンス本文には、サポートされているこのRESTインタフェースのバージョンのリストVersionエンティティが含まれます。

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

- uri=/management/wls/{versions} rel=versions

- 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/12.1.3.0 rel=current

レスポンス・コード

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

例

例1   サポートされているバージョンの特定

この例は、サポートされている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
}
]
}

/management/wls/{version}

このリソースは、WLSドメインの全体的な情報を含みます。

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、このドメインの全体的な情報、たとえば、集計されたサーバー実行時統計などを返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、Wlsエンティティが含まれます。

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

- uri=/management/wls/{version}/jobs rel=jobs

- uri=/management/wls/{version}/servers rel=servers

- uri=/management/wls/{version}/deployments rel=deployments

- uri=/management/wls/{version}/datasources rel=datasources

- uri=/management/wls/{version}/changeManager rel=changeManager

- uri=/management/wls/{version}/targets rel=targets

- uri=/management/wls rel=parent

レスポンス・コード

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

例

例1   ドメインに関する情報の取得

この例は、ドメインのルート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"}
}
}

/management/wls/{version}/changeManager

changeManagerリソースは、編集セッションに関する情報を返します。このリソースを使用して、編集セッションを明示的に管理します。

1. changeManagerを使用して、編集セッションを開始します。

2. 他のリソースを使用して、様々な構成変更(データ・ソースの構成、アプリケーションのデプロイなど)を行います。

3. changeManagerを使用して、編集セッション内のすべての変更の取消しまたはそれらのアクティブ化を行います。

この方式は、すべての変更をまとめてバッチ処理しますが、これは、多くの構成変更をクライアントへの公開準備完了とする前にまとめて行う必要がある場合、一般的に本番環境で最も役に立つ方式です。

暗黙的な編集セッションでは、changeManagerを使用するかわりに、他のリソースを使用して構成を変更します(データ・ソースの作成など)。構成を変更する各REST呼出しは、それ自体の編集セッションを開始し、変更を行い、次にその変更をアクティブ化します。これは、一般的に開発環境で実行されるため、構成に対する小さい変更を行う場合に便利です。

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、編集セッションの現在のステータスに関する情報を返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、ChangeManagerエンティティが含まれます。

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

- uri=/management/wls/{version} rel=parent

- uri=/management/wls/{version}/changeManager/startEdit rel=action title=startEdit

- uri=/management/wls/{version}/changeManager/cancelEdit rel=action title=cancelEdit

- uri=/management/wls/{version}/changeManager/activate rel=action title=activate

レスポンス・コード

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

例

例1   変更管理情報の表示

この例は、GETメソッドを使用して、変更マネージャ情報を返します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/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"
}
],
"item": {"locked": false}
}

/management/wls/{version}/changeManager/activate

このリソースは、変更をアクティブ化します。

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

- POSTメソッド

POSTメソッド

このリソースのPOSTメソッドは、現在の編集セッション中に保存されまだデプロイされていない変更をアクティブ化します。

ロール

管理者

レスポンス本文

成功したレスポンス本文には、この操作によって返されたステータス・メッセージが含まれます。

レスポンス・コード

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

例

例1   構成変更のアクティブ化

この例は、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"
}]}

/management/wls/{version}/changeManager/cancelEdit

このリソースは、現在の編集セッションを取り消します。

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

- POSTメソッド

POSTメソッド

このリソースのPOSTメソッドは、現在の編集セッションを取り消し、編集ロックを解放し、保存済または未保存の変更を破棄します。

ロール

管理者

レスポンス本文

成功したレスポンス本文には、この操作によって返されたステータス・メッセージが含まれます。

レスポンス・コード

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

例

例1   編集セッションの停止

この例は、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"
}]}

/management/wls/{version}/changeManager/startEdit

このリソースは、構成の編集セッションを開始します。

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

- POSTメソッド

POSTメソッド

このリソースのPOSTメソッドは、編集セッションを開始します。

ロール

管理者

レスポンス本文

成功したレスポンス本文には、この操作によって返されたステータス・メッセージが含まれます。

レスポンス・コード

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

例

例1   編集セッションの開始

この例は、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"
}]}

/management/wls/{version}/datasources

このリソースは、このWLSドメインで実行されるデータ・ソースを管理します。

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

- GETメソッド

- OPTIONSメソッド

- POSTメソッド

GETメソッド

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

ロール

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

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

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

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

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

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

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

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

レスポンス本文

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

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

- uri=/management/wls/{version}/datasources/drivers rel=drivers

- uri=/management/wls/{version}/datasources/test rel=test

- uri=/management/wls/{version} rel=parent

- uri=/management/wls/{version}/datasources/id/{data-source-name} rel=items.name title=name

レスポンス・コード

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

例

例1   データ・ソースの表示

この例は、GETメソッドを使用して、すべての構成済データ・ソースに関する情報を表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/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メソッド

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

データ・ソースを作成する場合、このメソッドを呼び出してテンプレートを取得し、ドライバ・クラス名やデータベースURLなどの値を入力して、POSTメソッドでこれを使用してデータ・ソースを作成します。

ロール

管理者

レスポンス本文

返されるレスポンス本文には、カスタマイズして、新規データ・ソースの作成に使用できるDataSourceテンプレート・エンティティが含まれます。

レスポンス・コード

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

例

例1   テンプレート・データ・ソース・エンティティの取得

この例は、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メソッドは、新規データ・ソースを作成します。

ロール

管理者

リクエスト本文

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

レスポンス本文

レスポンス本文には、データ・ソースが作成されたことを示すメッセージが含まれます。

レスポンス・コード

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

例

例1   データ・ソースの作成

この例は、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"
}]}

/management/wls/{version}/datasources/id/{data-source-name}

このリソースは、リソースURLで識別されるデータ・ソースを管理します。

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

- DELETEメソッド

- GETメソッド

- POSTメソッド

DELETEメソッド

DELETEメソッドは、リソースURLで識別されるデータ・ソースを削除します。

ロール

管理者

レスポンス本文

返されるレスポンス本文には、データ・ソースの構成が削除されたことを示すメッセージが含まれます。

レスポンス・コード

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

例

例1   データ・ソースの削除

この例は、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メソッド

このリソースのGETメソッドは、リソースURLによって識別されるデータ・ソースに関する情報を返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、指定したデータ・ソースに関する情報を含むDataSourceエンティティが含まれます。

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

- uri=/management/wls/{version}/datasources rel=parent

- uri=/management/wls/{version}/datasources/id/{data-source-name}/start rel=action title=start

- uri=/management/wls/{version}/datasources/id/{data-source-name}/shutdown rel=action title=shutdown

- uri=/management/wls/{version}/datasources/id/{data-source-name}/test rel=action title=test

- uri=/management/wls/{version}/datasources/id/{data-source-name}/clearStatementCache rel=action title=clearStatementCache

- uri=/management/wls/{version}/datasources/id/{data-source-name}/reset rel=action title=reset

- uri=/management/wls/{version}/datasources/id/{data-source-name}/shrink rel=action title=shrink

- uri=/management/wls/{version}/datasources/id/{data-source-name}/suspend rel=action title=suspend

- uri=/management/wls/{version}/datasources/id/{data-source-name}/resume rel=action title=resume

レスポンス・コード

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

例

例1   データ・ソースの表示

この例は、GETメソッドを使用して、特定のデータ・ソースに関する情報を検索します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/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メソッド

このリソースのPOSTメソッドは、リソースURLによって識別されるデータ・ソースを再構成します。

ロール

管理者

リクエスト本文

POSTリクエスト本文には、完全に移入された、必要なデータ・ソース構成を含むDataSourceエンティティが含まれている必要があります。読取り専用パラメータ値は無視されます。

レスポンス本文

返されるレスポンス本文には、データ・ソースの構成が更新されたことを示すメッセージが含まれます。

レスポンス・コード

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

例

例1   データ・ソースの編集

この例は、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"
}]}

/management/wls/{version}/datasources/id/{data-source-name}/clearStatementCache

このリソースは、データ・ソース内の各接続の文キャッシュをクリアします。データソースの文キャッシュが有効な場合、WebLogic Serverでは、データソース内の各接続で使用されるプリコンパイル済文およびコール可能文がキャッシュされます。各接続はそれぞれ固有のキャッシュを持ちますが、各接続のキャッシュは、1つのグループとして構成および管理されます。あるデータ・ソースの文キャッシュをクリアすると、そのデータ・ソースのインスタンスに含まれるすべての接続の文キャッシュがクリアされます。

アプリケーションにより現在使用されている文をクリアすると、WebLogic Serverはその文をキャッシュから削除しますが閉じません。現在使用されてない文をクリアすると、WebLogic Serverはキャッシュからその文を削除して閉じます。

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

- POSTメソッド

POSTメソッド

このリソースのPOSTメソッドは、データ・ソース内の各接続の文キャッシュをクリアします。

ロール

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

レスポンス本文

成功したレスポンス本文には、この操作によって返されたステータス・メッセージが含まれます。

レスポンス・コード

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

例

例1   データ・ソースの文キャッシュのクリア

この例は、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"
}]}

/management/wls/{version}/datasources/id/{data-source-name}/reset

このリソースはデータ・ソースをリセットします。JDBCデータ・ソース内のデータベース接続をリセットすると、そのデータ・ソースの接続プールで使用可能なすべてのデータベース接続が閉じられ、再作成されます。

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

- POSTメソッド

POSTメソッド

このリソースのPOSTメソッドは、データ・ソースのデータベース接続をリセットします。

ロール

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

レスポンス本文

成功したレスポンス本文には、この操作によって返されたステータス・メッセージが含まれます。

レスポンス・コード

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

例

例1   データ・ソースのリセット

この例は、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"
}]}

/management/wls/{version}/datasources/id/{data-source-name}/resume

このリソースは中断したデータ・ソースを再開します。データ・ソースを再開すると、WebLogic Serverはデータ・ソースを有効とマークし、アプリケーションはデータ・ソースからの接続を予約できます。データ・ソースを中断した場合(強制中断ではない)、すべての接続が、中断前とまったく同じ状態で保持されます。データ・ソースの中断前に接続を予約していたクライアントは、中断が発生した時点の状態から作業を継続できます。

注意: たとえば、データベース・サーバーが使用不可の場合など、正しく起動しなかったデータ・ソースは再開できません。

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

- POSTメソッド

POSTメソッド

このリソースのPOSTメソッドは、中断状態の個別のデータ・ソースを再開します。

ロール

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

レスポンス本文

成功したレスポンス本文には、この操作によって返されたステータス・メッセージが含まれます。

レスポンス・コード

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

例

例1   中断したデータ・ソースの再開

この例は、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"
}]}

/management/wls/{version}/datasources/id/{data-source-name}/shrink

このリソースは、データ・ソースの個別のインスタンス内のデータベース接続のプールを縮小します。

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

- POSTメソッド

POSTメソッド

このリソースのPOSTメソッドは、データ・ソース内の接続プールを縮小します。

ロール

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

レスポンス本文

成功したレスポンス本文には、この操作によって返されたステータス・メッセージが含まれます。

レスポンス・コード

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

例

例1   データ・ソース内の接続プールの縮小

この例は、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"
}]}

/management/wls/{version}/datasources/id/{data-source-name}/shutdown

このリソースは、実行中のデータ・ソースを停止します。データ・ソースを停止すると(強制停止ではない)、WebLogic Serverはデータ・ソース内のデータベース接続を閉じ、データ・ソースを停止します。データ・ソースのいずれかの接続が使用中の場合、この操作は失敗します。

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

- POSTメソッド

POSTメソッド

このリソースのPOSTメソッドは、データ・ソースを停止します。

ロール

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

レスポンス本文

成功したレスポンス本文には、この操作によって返されたステータス・メッセージが含まれます。

レスポンス・コード

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

例

例1   データ・ソースの停止

この例は、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"
}]}

/management/wls/{version}/datasources/id/{data-source-name}/start

このリソースは停止したデータ・ソースを開始します。データ・ソースを開始すると、データ・ソースが再初期化され、接続が作成され、データ・ソースのヘルス状態が「実行中」に遷移します。

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

- POSTメソッド

POSTメソッド

このリソースのPOSTメソッドは、データ・ソースを開始します。

ロール

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

レスポンス本文

成功したレスポンス本文には、この操作によって返されたステータス・メッセージが含まれます。

レスポンス・コード

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

例

例1   データ・ソースの開始

この例は、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"
}]}

/management/wls/{version}/datasources/id/{data-source-name}/suspend

このリソースはデータ・ソースを中断します。データ・ソースを中断すると(強制中断ではない)、データ・ソースは無効とマークされ、アプリケーションはプール内の接続を予約できません。データ・ソース中断時にそのデータ・ソースからの接続をすでに予約していたアプリケーションは、その接続を予約しようとしたときに例外を受け取ります。データ・ソース内のすべての接続は、データ・ソースが中断される前とまったく同じ状態で保持されます。

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

- POSTメソッド

POSTメソッド

このリソースのPOSTメソッドは、データ・ソースの個別のインスタンスを中断します。データ・ソースを中断すると、アプリケーションはそのデータ・ソースからデータベース接続を取得できなくなります。

ロール

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

レスポンス本文

成功したレスポンス本文には、この操作によって返されたステータス・メッセージが含まれます。

レスポンス・コード

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

例

例1   データ・ソースの中断

この例は、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"
}]}

/management/wls/{version}/datasources/id/{data-source-name}/test

このリソースはデータ・ソースのデータベース接続をテストします。

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

- POSTメソッド

POSTメソッド

このリソースのPOSTメソッドは、データ・ソースのデータベース接続をテストします。

ロール

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

レスポンス本文

成功したレスポンス本文には、この操作によって返されたステータス・メッセージが含まれます。

レスポンス・コード

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

例

例1   データ・ソースのテスト

この例は、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"
}]}

/management/wls/{version}/datasources/test

このリソースはデータベース接続をテストします。一般的に、新規データ・ソースの作成に使用されるパラメータの検証に使用されます。

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

- OPTIONSメソッド

- POSTメソッド

OPTIONSメソッド

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

データベース接続をテストする場合、このメソッドを呼び出してテンプレートを取得し、ドライバ・クラス名や接続URLなどの値を入力して、POSTメソッドでこれを使用して接続をテストします。

ロール

管理者、デプロイヤ

レスポンス本文

返されるレスポンス本文には、DatabaseDriverAttributesエンティティが含まれます。

レスポンス・コード

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

例

例1   特定のドライバのデータベース接続を行うためのテンプレートの取得

この例は、OPTIONSメソッドを使用して、データベース接続のテンプレートを取得します。

リクエストの例

レスポンスの例

POSTメソッド

このリソースのPOSTメソッドは、ドライバ固有の属性のセットを、汎用のデータベース接続エンティティに変換し、接続URLおよびプロパティのリストを適切にフォーマットします。

注意: RESTリソースはクリアテキスト・パスワードを返すことができないため、ドライバ属性のいずれかにパスワードが保持されていても、返されるドライバにパスワードは入力されていません。これを補うために、クライアントは、データベース・ドライバ属性エンティティを保持し、そのpasswordAttributeNameプロパティを使用してパスワードを保持する属性を検索し、返されたデータベース接続エンティティのpasswordプロパティをそのパスワードに設定する必要があります。

ロール

管理者、デプロイヤ

リクエスト本文

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

レスポンス本文

返されるレスポンス本文には、DatabaseConnectionエンティティが含まれます。

レスポンス・コード

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

例

例1   特定のデータベースのデータベース接続のテスト

この例は、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
}}

/management/wls/{version}/datasources/vendors

このリソースは、このWLSドメイン内の使用可能なデータベース・ドライバのベンダーをリストします。

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、このドメインの使用可能なデータベース・ドライバのベンダー・リストを返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、DatabaseVendorエンティティの集合が含まれます。そのdriversプロパティに値が移入されていないことに注意してください。

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

- uri=/management/wls/{version}/datasources rel=parent

- uri=/management/wls/{version}/datasources/vendors/id/{vendorName} rel=items.name title=name

レスポンス・コード

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

例

例1   使用可能なデータベース・ドライバ・ベンダーの表示

この例は、GETメソッドを使用して、ドメインが認識している使用可能なデータベース・ドライバ・ベンダーをすべて検出します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/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"}
]
}

/management/wls/{version}/datasources/vendors/id/{vendor}

このリソースでは、データベース・ドライバ・ベンダーが記述されます。

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、このベンダーのデータベース・ドライバのリストを返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、DatabaseVendorエンティティが含まれます。

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

- uri=/management/wls/{version}/datasources/vendors rel=parent

- uri=/management/wls/{version}/datasources/vendors/id/{vendor}/id/{driverName} rel=item.drivers.name title=name

レスポンス・コード

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

例

例1   ベンダーのデータベース・ドライバの表示

この例は、GETメソッドを使用して、サポートされているデータベース・ベンダーのドライバをすべて検出します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/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"
}
]
}
}

/management/wls/{version}/datasources/vendors/id/{vendor}/drivers/id/{driver-class-name}

このリソースは、特定のデータベース・ドライバに適切なデータベース接続の構築を支援します。

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

- OPTIONSメソッド

- POSTメソッド

OPTIONSメソッド

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

特定の種類のデータベース・ドライバに適切なデータベース接続を構築する場合、ドライバ・クラス名を検索し、このメソッドを呼び出して、このドライバに入力する必要がある属性がリストされたテンプレートを取得します。値を入力した後、入力済テンプレートをデータベース接続に変換するPOSTメソッドでこれを使用します。

ロール

管理者、デプロイヤ

レスポンス本文

返されるレスポンス本文には、DatabaseDriverAttributesエンティティが含まれます。

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

- uri=/management/wls/{version}/datasources/vendors/id/{vendor}/drivers/id/{driver-class-name}/connection rel=connection

レスポンス・コード

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

例

例1   特定のドライバのデータベース接続を行うためのテンプレートの取得

この例は、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メソッド

このリソースのPOSTメソッドは、ドライバ固有の属性のセットを、汎用のデータベース接続エンティティに変換し、接続URLおよびプロパティのリストを適切にフォーマットします。

注意: RESTリソースはクリアテキスト・パスワードを返すことができないため、ドライバ属性のいずれかにパスワードが保持されていても、返されるドライバにパスワードは入力されていません。これを補うために、クライアントは、データベース・ドライバ属性エンティティを保持し、そのpasswordAttributeNameプロパティを使用してパスワードを保持する属性を検索し、返されたデータベース接続エンティティのpasswordプロパティをそのパスワードに設定する必要があります。

ロール

管理者、デプロイヤ

リクエスト本文

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

レスポンス本文

返されるレスポンス本文には、DatabaseConnectionエンティティが含まれます。

レスポンス・コード

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

例

例1   特定のデータベースのデータベース接続の作成

この例は、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"
}}

/management/wls/{version}/deployments

このリソースは、このWLSドメインで実行されるデプロイメントをリストします。

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

- GETメソッド

GETメソッド

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

ロール

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

レスポンス本文

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

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

- uri=/management/wls/{version}/deployments/inspect rel=inspect

- uri=/management/wls/{version}/deployments/application rel=application

- uri=/management/wls/{version}/deployments/library rel=library

- uri=/management/wls/{version} rel=parent

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

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

レスポンス・コード

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

例

例1   デプロイメントの表示

この例は、GETメソッドを使用して、ドメイン内のデプロイメントをすべて表示します。

リクエストの例

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

レスポンスの例

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"
}
]
}

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

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

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

- GETメソッド

- OPTIONSメソッド

- POSTメソッド

GETメソッド

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

ロール

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

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

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

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

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

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

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

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

レスポンス本文

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

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

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

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

レスポンス・コード

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

例

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

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

リクエストの例

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

レスポンスの例

HTTP/1.1 200 OK

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

OPTIONSメソッド

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

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

ロール

管理者

レスポンス本文

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

レスポンス・コード

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

POSTメソッド

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

- "application/json"を受け入れるPOST

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

application/json"を受け入れるPOST

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

ロール

管理者

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

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

_detached

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

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

リクエスト本文

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

レスポンス本文

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

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

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

レスポンス・コード

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

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

例

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

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

リクエストの例

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

レスポンスの例

HTTP/1.1 201 Created

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

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

例2   アプリケーションの非同期デプロイ

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

リクエストの例

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

レスポンスの例

HTTP/1.1 202 Accepted

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

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

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

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

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

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

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

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

ロール

管理者

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

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

_detached

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

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

リクエスト本文

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

model

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

deployment

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

plan

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

レスポンス本文

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

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

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

レスポンス・コード

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

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

例

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

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

リクエストの例

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

レスポンスの例

HTTP/1.1 100 Continue
HTTP/1.1 201 Created

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

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

/management/wls/{version}/deployments/application/id/{application-name}

このリソースは、アプリケーションを管理します。

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

- DELETEメソッド

- GETメソッド

DELETEメソッド

DELETEメソッドは、リソースURLで識別されるアプリケーションをアンデプロイします。

ロール

管理者

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

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

_detached

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

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

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

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

この例は、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."
}
}

例2   アプリケーションの非同期アンデプロイ

この例は、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メソッド

このリソースのGETメソッドは、リソースURLによって識別されるアプリケーションに関する情報を返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、指定したアプリケーションに関する情報を含むApplicationエンティティが含まれます。

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

- uri=/management/wls/{version}/deployments/application/id/{application-name}/bindables rel=bindables

- uri=/management/wls/{version}/deployments/application rel=parent

- uri=/management/wls/{version}/deployments/application/id/{application-name}/redeploy rel=action title=redeploy

- uri=/management/wls/{version}/deployments/application/id/{application-name}/update rel=action title=update

- uri=/management/wls/{version}/deployments/application/id/{application-name}/start rel=action title=start

- uri=/management/wls/{version}/deployments/application/id/{application-name}/stop rel=action title=stop

レスポンス・コード

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

例

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

この例は、GETメソッドを使用して、特定のアプリケーションに関する情報を表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/deployments/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": []
}
}

/management/wls/{version}/deployments/application/id/{application-name}/bindables

このリソースは、アプリケーションの外部リソース参照を管理します。

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

- GETメソッド

- POSTメソッド

GETメソッド

このリソースのGETメソッドは、このアプリケーションの外部リソース参照のリストを返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、指定したアプリケーションの外部リソース参照に関する情報を含むApplicationBindablesエンティティが含まれます。

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

- uri=/management/wls/{version}/deployments/application/id/{application-name} rel=parent

レスポンス・コード

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

例

例1   アプリケーション・バインド可能値の表示

この例は、GETリクエストを使用して、アプリケーションのバインド可能値を表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/deployments/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メソッドは、アプリケーションの外部リソース参照を更新します。このメソッドを呼び出すには、アプリケーションにデプロイメント・プランが必要です。

ロール

管理者、デプロイヤ

リクエスト本文

リクエスト本文には、完全に移入された、アプリケーションのバインド可能値を記述するApplicationBindablesエンティティが含まれている必要があります。

レスポンス本文

返されるレスポンス本文には、アプリケーション・バインド可能値が更新されたことを示すメッセージが含まれます。

レスポンス・コード

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

例

例1   アプリケーション・バインド可能値の更新

この例は、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"
}]}

/management/wls/{version}/deployments/application/id/{application-name}/redeploy

このリソースは、アプリケーションを再デプロイします。

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

- POSTメソッド

POSTメソッド

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

- "application/json"を受け入れるPOST

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

application/json"を受け入れるPOST

このPOSTメソッドは、リソースURLで識別されるアプリケーションを再デプロイします。再デプロイするファイルが管理サーバーのファイル・システムにすでにある場合、このメソッドを使用します。たとえば、デプロイメントが参照するファイルを物理的に置き換えて、新規ファイルを使用してデプロイメントを開始する場合などです。

このメソッドは、基底のデプロイメント・アーカイブまたは展開済ディレクトリを更新した後に呼び出す必要があります。

ロール

管理者、デプロイヤ

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

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

_detached

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

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

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

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

この例は、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."
}
}

例2   アプリケーションの非同期再デプロイ

この例は、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"
}]
}

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

このPOSTメソッドは、アプリケーションをアップロードおよび再デプロイします。再デプロイするファイルがクライアントのファイル・システムに存在する場合、このメソッドを使用します。ファイルを管理サーバーにアップロードし、次にそれを使用して起動するようにデプロイメントに信号を送信します。

ロール

管理者

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

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

_detached

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

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

リクエスト本文

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

deployment

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

plan

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

archiveVersion

(オプション)アーカイブ・バージョンを文字列として指定します。Content-Dispositionヘッダーの名前パラメータはarchiveVersionに設定する必要があります。Content-Typeヘッダーはtext/plainである必要があります。

planVersion

(オプション)プラン・バージョンを文字列として指定します。Content-Dispositionヘッダーの名前パラメータはplanVersionに設定する必要があります。Content-Typeヘッダーはtext/plainである必要があります。

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

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

この例は、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."
}
}

例2   アプリケーションの非同期でのアップロードおよび再デプロイ

この例は、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"
}]
}

/management/wls/{version}/deployments/application/id/{application-name}/start

このリソースは、アプリケーションを開始します。

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

- POSTメソッド

POSTメソッド

POSTメソッドは、リソースURLで識別されるアプリケーションを開始します。

ロール

管理者、デプロイヤ

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

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

_detached

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

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

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

例1   アプリケーションの同期的な開始

この例は、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."
}
}

例2   アプリケーションの非同期開始

この例は、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"
}]
}

/management/wls/{version}/deployments/application/id/{application-name}/stop

このリソースは、アプリケーションを停止します。

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

- POSTメソッド

POSTメソッド

POSTメソッドは、リソースURLで識別されるアプリケーションを停止します。

ロール

管理者、デプロイヤ

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

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

_detached

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

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

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

例1   アプリケーションの停止

この例は、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."
}
}

例2   アプリケーションの非同期停止

この例は、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"
}]
}

/management/wls/{version}/deployments/application/id/{application-name}/update

このリソースは、アプリケーションを更新します。アプリケーションを再デプロイせずに、デプロイメント・プラン内の動的要素を更新する場合、このリソースを使用します。セッションは失われません。再デプロイ・リソースを使用して実際のデプロイメントを更新します。デプロイメント・プラン内のすべての変更も更新しますが、セッションが失われます。

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

- POSTメソッド

POSTメソッド

POSTメソッドは、リソースURLで識別されるアプリケーションを更新します。このメソッドは、基底のデプロイメント・プランを更新した後に呼び出す必要があります。

ロール

管理者、デプロイヤ

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

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

_detached

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

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

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

例1   アプリケーションの更新

この例は、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."
}
}

/management/wls/{version}/deployments/inspect

このリソースはデプロイメント(アーカイブまたは展開済ディレクトリ)を調査し、関連する情報を返します。これは、デプロイ前のデプロイメントの情報、たとえばライブラリかアプリケーションかなどを検出する場合に便利です。

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

- OPTIONSメソッド

- POSTメソッド

OPTIONSメソッド

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

デプロイメントを調査する場合、このメソッドを呼び出してテンプレートを取得し、deploymentPathどの値を入力して、POSTメソッドでこれを使用してデプロイメントを調査します。

ロール

管理者、デプロイヤ

レスポンス本文

返されるレスポンス本文には、カスタマイズして、デプロイメントの調査に使用できるDeploymentReferenceテンプレート・エンティティが含まれます。

レスポンス・コード

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

例

例1   テンプレート・デプロイメント参照の取得

この例は、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メソッドは、デプロイメントを調べ、その情報を返します。

ロール

管理者

リクエスト本文

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

レスポンス本文

返されるレスポンス本文には、DeploymentDescriptionエンティティが含まれます。

レスポンス・コード

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

例

例1   バージョン付きライブラリの調査

この例は、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"
}
}

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

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

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

- GETメソッド

- OPTIONSメソッド

- POSTメソッド

GETメソッド

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

ロール

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

レスポンス本文

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

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

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

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

レスポンス・コード

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

例

例1   ライブラリの表示

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

リクエストの例

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

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"links": [
{
"rel": "parent",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments"
},
{
"rel": "items.name",
"uri": "http:\/\/localhost:7001\/management\/wls\/latest\/deployments\/library\/id\/airline",
"title": "airline"
}
],
"items": [{
"name": "airline",
"state": "active",
"type": "library",
"targets": ["myserver"],
"displayName": "airline",
"deploymentPath": "\/deployments\/airline.war"
}]
}

OPTIONSメソッド

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

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

ロール

管理者

レスポンス本文

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

レスポンス・コード

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

例

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

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

リクエストの例

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

レスポンスの例

HTTP/1.1 200 OK

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

POSTメソッド

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

- "application/json"を受け入れるPOST

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

application/json"を受け入れるPOST

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

ロール

管理者

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

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

_detached

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

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

リクエスト本文

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

レスポンス本文

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

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

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

レスポンス・コード

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

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

例

例1   ライブラリのデプロイ

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

リクエストの例

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

レスポンスの例

HTTP/1.1 201 Created

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

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

例2   ライブラリの非同期デプロイ

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

リクエストの例

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

レスポンスの例

HTTP/1.1 201 Created

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

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

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

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

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

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

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

ロール

管理者

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

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

_detached

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

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

リクエスト本文

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

model

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

deployment

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

レスポンス本文

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

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

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

レスポンス・コード

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

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

例

例1   ライブラリのアップロードおよびデプロイ

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

リクエストの例

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

レスポンスの例

HTTP/1.1 201 Created

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

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

例2   ライブラリの非同期アップロードおよびデプロイ

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

リクエストの例

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

レスポンスの例

HTTP/1.1 202 Accepted

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

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

/management/wls/{version}/deployments/library/id/{library-name}

このリソースは、ライブラリを管理します。

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

- DELETEメソッド

- GETメソッド

DELETEメソッド

DELETEメソッドは、リソースURLで識別されるライブラリをアンデプロイします。

ロール

管理者

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

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

_detached

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

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

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

例1   ライブラリのアンデプロイ

この例は、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メソッド

このリソースのGETメソッドは、リソースURLによって識別されるライブラリに関する情報を返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、指定したライブラリに関する情報を含むLibraryエンティティが含まれます。

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

- uri=/management/wls/{version}/deployments/library/id/{library-name}/undeploy rel=undeploy

- uri=/management/wls/{version}/deployments/library rel=parent

レスポンス・コード

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

例

例1   ライブラリの表示

この例は、GETメソッドを使用して、特定のライブラリに関する情報を検索します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/deployments/library/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"
}
}

/management/wls/{version}/deployments/library/id/{library-name}/redeploy

このリソースは、ライブラリを再デプロイします。

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

- POSTメソッド

POSTメソッド

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

- "application/json"を受け入れるPOST

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

application/json"を受け入れるPOST

このPOSTメソッドは、リソースURLで識別されるライブラリを再デプロイします。このメソッドは、基底のデプロイメント・アーカイブまたは展開済ディレクトリを更新した後に呼び出す必要があります。

ロール

管理者、デプロイヤ

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

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

_detached

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

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

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

例1   ライブラリの再デプロイ

この例は、POSTメソッドを使用して、指定されたライブラリを再デプロイします。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-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\/5"
}],
"item": {
"operation": "redeploy",
"status": "completed",
"beginTime": 1390587126314,
"endTime": 1390587126328,
"name": "ADTR-5",
"id": "5",
"type": "deployment",
"targets": [{
"errors": [],
"status": "completed",
"name": "myserver",
"type": "server"
}],
"deploymentName": "airline",
"description": "[Deployer:149117]redeploy library airline on myserver."
}
}

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

このPOSTメソッドは、リソースURLで識別されるライブラリをアップロードし再デプロイします。このメソッドは、基底のデプロイメント・アーカイブまたは展開済ディレクトリを更新した後に呼び出す必要があります。

ロール

管理者、デプロイヤ

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

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

_detached

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

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

リクエスト本文

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

deployment

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

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

例1   ライブラリのアップロードおよび再デプロイ

この例は、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."
}
}

例2   ライブラリの非同期アップロードおよび再デプロイ

この例は、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"
}]
}

/management/wls/{version}/jobs

このリソースは、このWLSドメインで実行中のジョブをリストします。

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

- GETメソッド

GETメソッド

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

ロール

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

レスポンス本文

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

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

- uri=/management/wls/{version}/jobs/server rel=server

- uri=/management/wls/{version}/jobs/deployment rel=deployment

- uri=/management/wls/{version} rel=parent

- uri=/management/wls/{version}/jobs/{job-type}/id/{job-id} rel=items.id title=id

レスポンス・コード

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

例

例1   すべてのジョブの表示

この例は、GETメソッドを使用して、すべてのジョブに関する情報を取得します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/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 ..."
}]
}

/management/wls/{version}/jobs/deployment

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、デプロイメント操作に関連する各ジョブの情報を返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、DeploymentJobエンティティが含まれます。

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

- uri=/management/wls/{version}/jobs rel=parent

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

レスポンス・コード

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

例

例1   すべてのデプロイメント・ジョブの表示

この例は、GETメソッドを使用して、すべてのデプロイメント・ジョブに関する情報を取得します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/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."
}]
}

/management/wls/{version}/jobs/deployment/id/{job-id}

このリソースは、デプロイメント関連ジョブの情報を返します。

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、リソースURLによって識別されるデプロイメント関連ジョブの情報を返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、指定したデプロイメント関連ジョブの情報を含むDeploymentJobエンティティが含まれます。

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

- uri=/management/wls/{version}/jobs/deployment rel=parent

レスポンス・コード

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

例

例1   デプロイメント関連ジョブの表示

この例は、GETメソッドを使用して、デプロイメント・ジョブに関する情報を取得します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/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."
}
}

/management/wls/{version}/jobs/server

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、サーバー・ライフサイクル操作に関連する各ジョブの情報を返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、ServerJobエンティティが含まれます。

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

- uri=/management/wls/{version}/jobs rel=parent

- uri=/management/wls/{version}/jobs/server/id/{job-id} rel=server title=name

レスポンス・コード

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

例

例1   すべてのサーバー・ジョブの取得

この例は、GETメソッドを使用して、すべてのサーバー・ライフサイクル・ジョブに関する情報を取得します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/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"
}]
}

/management/wls/{version}/jobs/server/id/{job-id}

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、特定のサーバー・ライフサイクル・ジョブに関する情報を返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、ServerJobエンティティが含まれます。

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

- uri=/management/wls/{version}/jobs/server rel=parent

レスポンス・コード

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

例

例1   サーバー・ジョブ情報の取得

この例は、GETメソッドを使用して、サーバー・ライフサイクル・ジョブに関する情報を取得します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/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"
}
}

/management/wls/{version}/servers

このリソースは、WLSドメイン内のサーバーを列挙し、サマリー・メトリックおよび各サーバーの状態を示します。

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、このドメインのサーバーのリストを返します。

ロール

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

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

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

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

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

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

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

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

レスポンス本文

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

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

- uri=/management/wls/{version} rel=parent

- uri=/management/wls/{version}/servers/id/{server-name} rel=items.name title=name

レスポンス・コード

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

例

例1   サーバーの表示

この例は、GETメソッドを使用して、このドメインのすべてのサーバーのリストを返します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/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"
}
]
}

/management/wls/{version}/servers/id/{server-name}

このリソースは、特定のサーバーの情報を取得します。

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、リソースURLによって識別されるサーバーに関する情報を返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、指定したサーバーに関する情報を含むServerエンティティが含まれます。

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

- uri=/management/wls/{version}/servers/id/{server-name}/logs rel=logs

- uri=/management/wls/{version}/servers rel=parent

- uri=/management/wls/{version}/servers/id/{server-name}/start rel=action title=start

- uri=/management/wls/{version}/servers/id/{server-name}/restart rel=action title=restart

- uri=/management/wls/{version}/servers/id/{server-name}/suspend rel=action title=suspend

- uri=/management/wls/{version}/servers/id/{server-name}/resume rel=action title=resume

- uri=/management/wls/{version}/servers/id/{server-name}/shutdown rel=action title=shutdown

レスポンス・コード

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

例

例1   特定のサーバーの表示

この例は、GETメソッドを使用して、特定のサーバーに関する情報を取得します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/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
}
}

/management/wls/{version}/servers/id/{server-name}/logs

このリソースは、このサーバーに対して保持されているログのリストを返します。

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、サーバーのログ・ファイル・リストを返します。

ロール

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

レスポンス本文

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

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

- uri=/management/wls/{version}/servers/id/{server-name} rel=parent

- uri=/management/wls/{version}/servers/id/{server-name}/logs/id/{log-name} rel=items.name title=name

レスポンス・コード

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

例

例1   サーバーのログの表示

この例は、GETメソッドを使用して、サーバーで入手可能なログをすべて検索します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/wls/latest/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"}
]
}

/management/wls/{version}/servers/id/{server-name}/logs/id/{log-name}

このリソースは、サーバーのログ内のエントリを表示します。

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、サーバーのログを返します。

ロール

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

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

このメソッドでは、レスポンスに含められる結果のフィルタおよび制限に使用できるオプションの問合せパラメータがサポートされます。

maxResults=long

(オプション)返されるエントリの最大数を指定します。maxResultsが指定されていない場合または1未満の場合、ログ内のすべてのエントリが返されます。それ以外の場合、maxResultsエントリのみが返されます。一致するエントリがmaxResultsを超える場合、最後のmaxResultsエントリが(基底のログ内のエントリの順序に基づいて)返されます。

startTime=mm/dd/yy hh:mm:ss ms

(オプション)返される最も古いログ・エントリを指定します。問合せパラメータを有効な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となります。

endTime=mm/dd/yy hh:mm:ss ms

(オプション)返される最も新しいログ・エントリを指定します。問合せパラメータを有効な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となります。

query=wldf expression

(オプション)返されるエントリをフィルタおよび制限するために使用できるWeblogic診断フレームワーク(WLDF)問合せ式を指定します。

レスポンス本文

返されるレスポンス本文には、LogEntryエンティティの集合が含まれます。エンティティは、基底のログ内の対応するエントリと同じ順序になります。

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

- uri=/management/wls/{version}/servers/id/{server-name}/logs rel=parent

レスポンス・コード

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

例

例1   サーバーのログの表示

この例は、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"
}
]
}

/management/wls/{version}/servers/id/{server-name}/restart

このリソースは、特定のサーバーを再起動します。

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

- POSTメソッド

POSTメソッド

POSTメソッドは、リソースURLで識別されるサーバーを再起動します。

ロール

管理者

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

このリソースは、サーバーを再起動するジョブを起動します。

_detached

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

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

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

例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

レスポンスの例

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

例2   サーバーの非同期再起動

この例は、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"
}]
}

/management/wls/{version}/servers/id/{server-name}/resume

このリソースはサーバーを再開します。

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

- POSTメソッド

POSTメソッド

POSTメソッドは、中断またはADMIN状態のサーバー・インスタンスを再開します。

ロール

管理者

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

このリソースは、サーバーを再起動するジョブを起動します。

_detached

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

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

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

例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

レスポンスの例

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

例2   サーバーの非同期再開

この例は、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"
}]
}

/management/wls/{version}/servers/id/{server-name}/shutdown

このリソースは、特定のサーバーの正常な停止を実行します。

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

- POSTメソッド

POSTメソッド

POSTメソッドは、リソースURLで識別されるサーバーを停止します。

ロール

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

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

このリソースは、サーバーを停止するジョブを起動します。

_detached

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

force

(オプション)サーバーを正常に停止するか(false、デフォルト)、サーバーを強制的に停止するかを指定します(true)。

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

例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

レスポンスの例

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

例2   サーバーの非同期停止

この例は、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"
}]
}

/management/wls/{version}/servers/id/{server-name}/start

このリソースは、特定のサーバーを開始します。

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

- POSTメソッド

POSTメソッド

POSTメソッドは、リソースURLで識別されるサーバーを開始します。

ロール

管理者

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

このリソースは、サーバーを開始するジョブを起動します。

_detached

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

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

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

例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

レスポンスの例

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

例2   サーバーの非同期開始

この例は、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"
}]
}

/management/wls/{version}/servers/id/{server-name}/suspend

このリソースはサーバーを中断します。

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

- POSTメソッド

POSTメソッド

POSTメソッドは、リソースURLで識別されるサーバーを、RUNNING状態からADMIN状態に移行します。

ロール

管理者

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

このリソースは、サーバーを中断するジョブを起動します。

_detached

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

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

レスポンス本文

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

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

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

レスポンス・コード

メソッドが同期的に呼び出され、ジョブが正常に完了した場合、メソッドは200 OKステータス・コードを返します。ジョブがタイムアウトした場合、メソッドは202 Acceptedステータス・コードを返します。

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

例

例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

レスポンスの例

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

例2   サーバーの非同期中断

この例は、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"
}]
}

/management/wls/{version}/targets

このリソースは、このWLSドメイン内のすべてのサーバーおよびクラスタをリストします。

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

- GETメソッド

GETメソッド

このリソースのGETメソッドは、このWLSドメイン内のすべてのサーバーおよびクラスタを返します。

ロール

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

レスポンス本文

レスポンス本文には、Targetエンティティの集合が含まれます。

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

- uri=/management/wls/{version} rel=parent

レスポンス・コード

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

例

例1   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"
}
]
}

2 エンティティ

次の各項では、WebLogic Server 12.1.3のRESTリソースが動作するデータ・モデルについて説明します。これらのデータ・モデルは、RESTリソースでやりとりされる情報を記述したものです。

この項でのこれらのデータ・モデルの説明には、各データ・フィールドに適用される制約の説明が含まれます。

データ・フィールドの制約

コンフィデンシャル

この値が暗号化され、GETメソッドによって返されないことを指定します。更新するために、POSTで指定することは可能です。

不変

このフィールドの内容は、作成中に1回書込み可能であり、その後は変更できません。

Null以外

このフィールドに値を指定する必要があることを指定します。

読取り専用

この値は、GETによって読取り可能ですが、POST中は無視されることを指定します。

Application

Applicationエンティティには、アプリケーション・デプロイメントの構成およびモニタリング情報が含まれます。

Applicationエンティティには、次のプロパティに加えて、すべてのデプロイメント・プロパティが含まれることに注意してください。

Applicationエンティティのプロパティは、次のとおりです。

planPath

(オプション)デプロイメント・プランを含むファイルのパス名(管理サーバーへの相対パス)。

タイプ: 文字列

制約: 不変

archiveVersion

アーカイブのバージョン(デプロイメント・マニフェスト・ファイルから)。

タイプ: 文字列

制約: 読取り専用

planVersion

デプロイメント・プランのバージョン(デプロイメント時に指定)。

タイプ: 文字列

制約: 不変

applicationType

アプリケーション・タイプ: ear、war、ejbまたはgar。

タイプ: 文字列

制約: 読取り専用

health

このアプリケーションのヘルス(実行中の場合)。このヘルス・ステータスは、このアプリケーションを実行しているすべてのサーバーにわたり集約され、最も重大なヘルス状況が発生していることを示します。

タイプ: ヘルス

制約: 読取り専用

urls

各コンテキスト・ルートのURLのリスト。アプリケーションへのpingの実行に使用できます。

タイプ: リスト<String>

制約: 読取り専用

openSessionsCurrentCount

このサーバー内のオープン・セッションの最大合計数。この数は、サーバーがアクティブ化されるたびにゼロから始まります。この最適化方法をとると非常に役立つ統計になります。変更の通知を使用して実装することもできますが、効率がよくありません。

タイプ: int

制約: 読取り専用

sessionsOpenedTotalCount

オープンしているセッションの合計数。

タイプ: int

制約: 読取り専用

servlets

このアプリケーション内のすべてのサーブレットの実行時情報。

タイプ: リスト<Servlet>

制約: 読取り専用

ejbs

このアプリケーション内のすべてのEJBの実行時情報。

タイプ: リスト<Ejb>

制約: 読取り専用

ApplicationBindable

ApplicationBindableエンティティでは、リソースにバインドでき、デプロイメント・プランによってオーバーライドできるディスクリプタ要素に関する情報が記述されます。

ApplicationBindableエンティティのプロパティは、次のとおりです。

name

このバインド可能ディスクリプタ値の名前。

タイプ: 文字列

制約: 読取り専用

path

ディスクリプタ値を特定および識別するために使用されるデプロイメント内のパス。

タイプ: リスト<ApplicationDescriptorScope>

制約: 読取り専用

type

このディスクリプタ値にバインドされるリソースのタイプ(制約されている場合): jms destination、jms connection factory、resource adapterまたはejb。

タイプ: 文字列

制約: 読取り専用

jndiName

このアプリケーションにバインドする必要があるリソースのJNDI名。

タイプ: 文字列

ApplicationBindables

ApplicationBindablesエンティティは、アプリケーション内のApplicationBindableディスクリプタ値の集合です。各エントリは、アプリケーションのデプロイメント・プラン内で指定およびオーバーライドできるリソースへの参照を表します。

ApplicationBindablesエンティティのプロパティは、次のとおりです。

writeable

Writeableは、このアプリケーション構成がデプロイメント・プランのディスクリプタ値の上書きをサポートしていることを示します。デプロイメントが、デプロイメント・プランによってサポートされていない場合、値は上書きされます。

タイプ: ブール

制約: 読取り専用

bindables

Bindablesは、ApplicationBindableディスクリプタ値の集合です。

タイプ: リスト<ApplicationBindable>

制約: 読取り専用

ApplicationDescriptorScope

ApplicationDescriptorScopeエンティティは、デプロイメント・ディスクリプタ・ツリー内のパスまたはスコープを識別します。

ApplicationDescriptorScopeエンティティのプロパティは、次のとおりです。

name

ユーザーが判読できることを目的としたこのスコープの名前。

タイプ: 文字列

制約: 読取り専用

path

デプロイメントのディスクリプタ・パスを識別する、このスコープのパス。

タイプ: 文字列

制約: 読取り専用

type

このディスクリプタ・スコープのタイプ。

タイプ: 文字列

制約: 読取り専用

ChangeManager

ChangeManagerエンティティには、変更管理に必要なプロパティが含まれます。

ChangeManagerエンティティのプロパティは、次のとおりです。

locked

構成セッションが現在アクティブな場合True。

タイプ: ブール

制約: 読取り専用

lockOwner

現在の構成ロックの所有者のユーザー名。

タイプ: 文字列

制約: 読取り専用

hasChanges

保存された変更はあるが、現在および前の編集セッションでアクティブ化されていない場合True。

タイプ: ブール

制約: 読取り専用

DatabaseConnection

DatabaseConnectionエンティティでは、データベースへの接続を確立するために必要なキー・プロパティについて記述されます。これは、DataSourceエンティティの基盤であり、データベース接続を正常に確立可能であることを検証するために使用できます。

DatabaseConnectionエンティティのプロパティは、次のとおりです。

url

データベースの接続に使用されるURL。

タイプ: 文字列

driverName

この接続のドライバ名。

タイプ: 文字列

properties

この接続のプロパティ。

タイプ: リスト<Property>

password

この接続のパスワード。

タイプ: 文字列

制約: コンフィデンシャル

DatabaseConnectionStatus

DatabaseConnectionStatusエンティティでは、データベース接続の試行時に発生する結果が記述されます。

DatabaseConnectionStatusエンティティのプロパティは、次のとおりです。

ok

接続ステータス。この接続が成功した場合True。

タイプ: ブール

制約: 読取り専用

cause

この試行時に問題が明らかになった場合、causeを使用して、これらの問題を説明する、ユーザーが判読可能な文字列を取得できます。

タイプ: リスト<String>

制約: 読取り専用

DatabaseDriver

DatabaseDriverエンティティには、特定のデータベース・ドライバとやりとりするために必要なプロパティが含まれます。

DatabaseDriverエンティティのプロパティは、次のとおりです。

name

このドライバの名前。

タイプ: 文字列

制約: 読取り専用

driverClassName

ドライバ・クラス名。

タイプ: 文字列

制約: 読取り専用

type

このドライバのタイプで、制約はありませんが、通常Thin、OCI、Type 2またはType 4です。

タイプ: 文字列

制約: 読取り専用

testSql

このドライバとやりとりする際に使用する必要があるテストSQL文。

タイプ: 文字列

制約: 読取り専用

description

ユーザーが判読できる、このドライバの説明。

タイプ: 文字列

制約: 読取り専用

forXa

このドライバがXA接続をサポートしているかどうか。

タイプ: ブール

制約: 読取り専用

DatabaseDriverAttribute

DatabaseDriverAttributeエンティティは、このドライバによる接続をサポートするために必要なドライバ固有の属性を表します。

DatabaseDriverAttributeエンティティのプロパティは、次のとおりです。

name

この属性の名前。

タイプ: 文字列

制約: 読取り専用

description

ユーザーが判読できる、この属性の説明文字列。

タイプ: 文字列

制約: 読取り専用

defaultValue

この属性のデフォルト値(存在する場合)。

タイプ: 文字列

制約: 読取り専用

inUrl

trueの場合、この属性はフォーマットされ、ドライバとやりとりするために使用されるURL文字列に含められます。

タイプ: ブール

制約: 読取り専用

required

trueの場合、この属性は必須です。そうでない場合、属性はオプションで省略可能です。

タイプ: ブール

制約: 読取り専用

value

ユーザーが指定した、この属性の値。

タイプ: 文字列

DatabaseDriverAttributes

DatabaseDriverAttributesエンティティは、データベース・ドライバに関連付けられる属性のリストを表します。これらの属性は、このドライバによる接続をサポートするために必要なドライバ固有のプロパティを表します。

DatabaseDriverAttributesエンティティのプロパティは、次のとおりです。

passwordAttributeName

パスワード属性の名前であり、機密情報が漏れないようにクライアントでの特別な処理を必要とします。

タイプ: 文字列

制約: 読取り専用

attributes

このドライバの属性のリスト。

タイプ: リスト<DatabaseDriverAttribute>

DatabaseVendor

DatabaseVendorエンティティでは、データベース・ドライバのベンダーが記述されます。各ベンダーには、選択および適用できる1つ以上のドライバが含まれます。

DatabaseVendorエンティティのプロパティは、次のとおりです。

name

このデータベース・ドライバ・ベンダーの名前。

タイプ: 文字列

制約: 読取り専用

drivers

このベンダーで使用可能なドライバのリスト。

タイプ: リスト<DatabaseDriver>

制約: 読取り専用

DataSource

DataSourceエンティティは、データベースとやりとりするためにアプリケーションによって使用される、データ・ソース・リソースの構成および実行時メトリックを表します。

DataSourceエンティティのプロパティは、次のとおりです。

name

このデータ・ソースの名前。

タイプ: 文字列

制約: 不変、Null以外

jdbcDataSourceParams

このデータ・ソースの一般パラメータ。このデータ・ソースの基本構成パラメータは、このパラメータにより指定されます。

タイプ: JdbcDataSourceParams

制約: 読取り専用

jdbcConnectionPoolParams

このデータ・ソースの接続プール・パラメータ。このデータ・ソースの接続プール構成パラメータは、このパラメータにより指定されます。

タイプ: JdbcConnectionPoolParams

制約: 読取り専用

jdbcDriverParams

このデータ・ソースのドライバ・パラメータ。このデータ・ソースによって使用されるJDBCドライバの構成パラメータは、このパラメータにより指定されます。

タイプ: JdbcDriverParams

制約: 読取り専用

aggregateMetrics

このデータ・ソースの実行中のすべてのインスタンスにわたり計算される集計メトリック。

タイプ: DataSourceMetrics

制約: 読取り専用

dataSourceMetrics

このデータ・ソースのサーバーごとの実行時メトリックのリスト。

タイプ: リスト<DataSourceMetrics>

制約: 読取り専用

targets

このデータ・ソースのターゲットのリスト。

タイプ: リスト<String>

制約: 読取り専用

DataSourceMetrics

DataSourceMetricsエンティティには、データ・ソースのモニターに使用できる属性が含まれます。

DataSourceMetricsエンティティのプロパティは、次のとおりです。

serverName

このデータ・ソース・インスタンスが実行されるサーバーの名前。

タイプ: 文字列

制約: 読取り専用

state

このデータ・ソースの状態: running、suspended、shutdown、overloadedまたはunknown。

タイプ: 文字列

制約: 読取り専用

leakedConnectionCount

リークされた接続の数。リークされた接続とは、データ・ソースから予約されたが、close()呼出しでデータ・ソースに戻されなかった接続のことです。

タイプ: int

制約: 読取り専用

failuresToReconnectCount

データ・ソースがデータベース接続のリフレッシュを試行して失敗した回数。リフレッシュの失敗は、データベースが使用できない場合、またはデータベースへのネットワーク接続が遮断されている場合に発生する可能性があります。

タイプ: int

制約: 読取り専用

connectionDelayTime

データベースへの物理接続の作成に要する平均時間(ミリ秒)。この値は、接続にかかった総時間を接続の総数で除算して計算されます。

タイプ: int

制約: 読取り専用

prepStmtCacheAccessCount

文キャッシュがアクセスされた、現在の累積回数。

タイプ: ロング

制約: 読取り専用

prepStmtCacheAddCount

文キャッシュに追加された文の現在の累積数。接続プール内の接続ごとに、独自の文キャッシュが保持されます。この数は、接続プール内の各接続のキャッシュに追加された文の合計数です。

タイプ: ロング

制約: 読取り専用

prepStmtCacheDeleteCount

キャッシュから破棄された文の現在の累積数。接続プール内の接続ごとに、独自の文キャッシュが保持されます。この数は、接続プールのすべての接続のキャッシュから破棄された文の数の合計です。

タイプ: ロング

制約: 読取り専用

prepStmtCacheCurrentSize

文キャッシュに現在キャッシュされているプリコンパイルされた文および呼出し可能文の数。接続プール内の接続ごとに、独自の文キャッシュが保持されます。この数は、接続プール内すべての接続のキャッシュにある文の数の合計です。

タイプ: int

制約: 読取り専用

prepStmtCacheHitCount

キャッシュにある文が使用された、現在の累積回数。

タイプ: int

制約: 読取り専用

prepStmtCacheMissCount

キャッシュにある文で文リクエストを満たすことができなかった回数。

タイプ: int

制約: 読取り専用

activeConnectionsCurrentCount

アプリケーションが現在使用中の接続の数。

タイプ: int

制約: 読取り専用

waitingForConnectionCurrentCount

データベース接続を待機している接続リクエストの数。

タイプ: int

制約: 読取り専用

activeConnectionsHighCount

データ・ソースのインスタンス化以降の、データ・ソースのこのインスタンスにおけるアクティブなデータベース接続の最大数。アクティブな接続とは、アプリケーションが使用中の接続のことです。

タイプ: int

制約: 読取り専用

activeConnectionsAverageCount

データ・ソースのこのインスタンスにおけるアクティブな接続の平均数。アクティブな接続とは、アプリケーションが使用中の接続のことです。この値は縮小を許可するようにリソースが構成されている場合にのみ有効です。

タイプ: int

制約: 読取り専用

reserveRequestCount

このデータ・ソースの接続に対するリクエストの現在の累積数。

タイプ: ロング

制約: 読取り専用

failedReserveRequestCount

このデータ・ソースの接続に対するリクエストのうち、満たすことのできなかったリクエストの現在の累積数。

タイプ: ロング

制約: 読取り専用

waitingForConnectionHighCount

データ・ソースのこのインスタンスの接続を同時に待機するアプリケーション・リクエストの最大数。

タイプ: int

制約: 読取り専用

waitingForConnectionTotal

このデータ・ソースの接続に対するリクエストのうち、接続を取得する際に待機する必要があったリクエストの現在の累積数。最終的に接続を取得できたリクエストと取得できなかったリクエストの両方が含まれます。

タイプ: ロング

制約: 読取り専用

waitingForConnectionSuccessTotal

このデータ・ソースの接続に対するリクエストのうち、接続を取得する際に待機する必要があり、最終的に接続を取得することのできたリクエストの現在の累積数。

タイプ: ロング

制約: 読取り専用

waitingForConnectionFailureTotal

このデータ・ソースの接続に対するリクエストのうち、接続を取得する際に待機する必要があり、最終的に接続を取得することのできなかったリクエストの現在の累積数。待機中の接続リクエストが失敗する理由は、待機時間がConnectionReserveTimeoutSecondsを超えたなど、様々です。

タイプ: ロング

制約: 読取り専用

waitSecondsHighCount

接続プールがインスタンス化された後、接続プールのそのインスタンスからの接続をアプリケーションが待機する最大秒数(最大接続予約待機時間)。完了したgetConnectionリクエストが以前のリクエストよりも接続を返すのに長時間かかる場合は、この値が更新されます。

タイプ: int

制約: 読取り専用

connectionsTotalCount

データ・ソースのデプロイ以降にこのデータ・ソースで作成されたデータベース接続の累計数。

タイプ: int

制約: 読取り専用

currCapacity

データ・ソースの接続プールにあるJDBC接続の現在の数。

タイプ: int

制約: 読取り専用

currCapacityHighCount

データ・ソースのデプロイ以降に、データ・ソースのこのインスタンスで使用可能または使用中だったデータベース接続の最大数(現在の容量)。

タイプ: int

制約: 読取り専用

numAvailable

データ・ソースのこのインスタンスにおいて、現在アイドル状態でアプリケーションが使用できるデータベース接続の数。

タイプ: int

制約: 読取り専用

highestNumAvailable

データ・ソースのデプロイ以降に、データ・ソースのこのインスタンスにおいて、任意の時点でアイドル状態でアプリケーションが使用できたデータベース接続の最大数。

タイプ: int

制約: 読取り専用

numUnavailable

データ・ソースのこのインスタンスにおいて、現在テスト中またはアプリケーションが現在使用中の接続の数。

タイプ: int

制約: 読取り専用

highestNumUnavailable

データ・ソースのデプロイ以降、データ・ソースのこのインスタンスにおいて、アプリケーションによる使用中またはシステムによるテスト中であったデータベース接続の最大数。

タイプ: int

制約: 読取り専用

Deployment

Deploymentエンティティには、すべてのデプロイメント・タイプに共通する必須情報が含まれます。

Deploymentエンティティのプロパティは、次のとおりです。

name

このデプロイメントの名前。

タイプ: 文字列

制約: 不変

displayName

ユーザーが判読できる、このデプロイメントの名前であり、フォーマットされたバージョン情報が含まれます。

タイプ: 文字列

制約: 読取り専用

deploymentPath

デプロイメント・アーカイブを含むファイルまたは展開されたデプロイメントを含むディレクトリのパス名(管理サーバーへの相対パス)。

タイプ: 文字列

制約: 不変

type

このデプロイメントのタイプ: applicationまたはlibrary。

タイプ: 文字列

制約: 読取り専用

state

このデプロイメントの状態:active、admin、update pending、prepared、failed、retiredまたはnew。

タイプ: 文字列

制約: 読取り専用

targets

このデプロイメントのターゲットのリスト。

タイプ: リスト<String>

制約: 読取り専用

DeploymentDescription

DeploymentDescriptionエンティティは、デプロイメントの構成へのアクセスを提供します。

DeploymentDescriptionエンティティのプロパティは、次のとおりです。

deploymentPath

デプロイメント・アーカイブを含むファイルまたは展開されたデプロイメントを含むディレクトリのパス名(管理サーバーへの相対パス)。

タイプ: 文字列

制約: 読取り専用

planPath

(オプション)デプロイメント・プランを含むファイルのパス名(管理サーバーへの相対パス)。

タイプ: 文字列

制約: 読取り専用

deploymentType

デプロイメントのタイプ: library、applicationまたはunknown。

タイプ: 文字列

制約: 読取り専用

name

このデプロイメントの名前(使用可能な場合)。(これは、新規デプロイメントの推奨名です。)

タイプ: 文字列

制約: 読取り専用

archiveVersion

デプロイメントがアプリケーションであり、そのアーカイブ・バージョンが指定されている場合のアーカイブ・バージョン。

タイプ: 文字列

制約: 読取り専用

planVersion

デプロイメントがアプリケーションであり、そのプラン・バージョンが指定されている場合のプラン・バージョン。

タイプ: 文字列

制約: 読取り専用

specVersion

デプロイメントがライブラリであり、その仕様バージョンが指定されている場合の仕様バージョン。

タイプ: 文字列

制約: 読取り専用

implVersion

デプロイメントがライブラリであり、その実装バージョンが指定されている場合の実装バージョン。

タイプ: 文字列

制約: 読取り専用

DeploymentJob

DeploymentJobエンティティは、Jobエンティティの属性を含み、デプロイメント操作に一意の次の属性を追加します。

DeploymentJobエンティティのプロパティは、次のとおりです。

status

このデプロイメント・ジョブのステータス: initialized、in progress、completed、failedまたはdeferred。

タイプ: 文字列

制約: 読取り専用

operation

このジョブが追跡しているデプロイメント操作: activate、prepare、deactivate、remove、unprepare、distribute、start、stop、redeploy、update、deployまたはundeploy。

タイプ: 文字列

制約: 読取り専用

deploymentName

このジョブの影響を受けるデプロイメントの名前。

タイプ: 文字列

制約: 読取り専用

targets

このジョブに関連付けられているターゲット固有のステータス情報。

タイプ: リスト<DeploymentJobTarget>

制約: 読取り専用

DeploymentJobTarget

DeploymentJobTargetエンティティは、デプロイメント・ジョブのターゲット固有のステータス情報へのアクセスを提供します。

DeploymentJobTargetエンティティのプロパティは、次のとおりです。

name

このターゲットの名前。

タイプ: 文字列

制約: 読取り専用

type

このターゲットのタイプ:unknown、server、cluster、JMS server、virtual hostまたはSAF agent。

タイプ: 文字列

制約: 読取り専用

status

このターゲットのデプロイメント操作のステータス: initialized、in progress、completed、failedまたはunavailable。

タイプ: 文字列

制約: 読取り専用

errors

デプロイメント・ジョブ中に発生した問題(存在する場合)を説明するエラー・メッセージのリスト。

タイプ: リスト<String>

制約: 読取り専用

DeploymentReference

DeploymentReferenceエンティティは、検査用のデプロイメントまたはデプロイメントの識別に使用されます。

DeploymentReferenceエンティティのプロパティは、次のとおりです。

deploymentPath

デプロイメント・アーカイブを含むファイルまたは展開されたデプロイメントを含むディレクトリのパス名(管理サーバーへの相対パス)。

タイプ: 文字列

制約: Null以外

planPath

(オプション)デプロイメント・プランを含むファイルのパス名(管理サーバーへの相対パス)。

タイプ: 文字列

Ejb

Ejbエンティティには、各EJBの情報が含まれます。

Ejbエンティティのプロパティは、次のとおりです。

ejbName

javax.ejb.EJBアノテーションに定義されているこのEJBの名前、またはejb-jar.xmlデプロイメント・ディスクリプタを使用している場合はejb-name。

タイプ: 文字列

制約: 読取り専用

type

このEJBのタイプ: entity、stateless、stateful、singletonまたはmessage driven。

タイプ: 文字列

制約: 読取り専用

moduleName

このEJBモジュールの名前。

タイプ: 文字列

制約: 読取り専用

aggregateMetrics

このEJBの実行中のすべてのインスタンスにわたり計算される集計メトリック。

タイプ: EjbMetrics

制約: 読取り専用

ejbMetrics

このEJBのサーバーごとの実行時メトリックのリスト。

タイプ: リスト<EjbMetrics>

制約: 読取り専用

EjbCacheMetrics

EjbCacheMetricsエンティティには、各EJBに対する実行時のキャッシュ・モニタリング情報が含まれます。

EjbCacheMetricsエンティティのプロパティは、次のとおりです。

cachedBeansCurrentCount

現在EJBキャッシュにある、このEJBホームからのBeanの合計数。

タイプ: int

制約: 読取り専用

cacheAccessCount

キャッシュからBeanへのアクセスの試行の合計回数。

タイプ: ロング

制約: 読取り専用

cacheMissCount

キャッシュからBeanへのアクセスの試行が失敗した合計回数。

タイプ: ロング

制約: 読取り専用

activationCount

アクティブ化された、このEJBホームからのBeanの合計数。

タイプ: ロング

制約: 読取り専用

passivationCount

パッシブ化された、このEJBホームからのBeanの合計数。

タイプ: ロング

制約: 読取り専用

EjbLockingMetrics

EjbLockingMetricsエンティティには、各EJBに対する実行時のロック・モニタリング情報が含まれます。

EjbLockingMetricsエンティティのプロパティは、次のとおりです。

lockEntriesCurrentCount

現在ロックされているBeanの数。

タイプ: int

制約: 読取り専用

lockManagerAccessCount

Bean上でのロックの取得が試行された合計回数。これには、クライアントのためにすでにロックされているBean上のロック取得に対する試行も含まれます。

タイプ: ロング

制約: 読取り専用

waiterTotalCount

Bean上でロックを待機したスレッドの合計数。

タイプ: ロング

制約: 読取り専用

waiterCurrentCount

Bean上でロックを待機したスレッドの現在の数。

タイプ: int

制約: 読取り専用

timeoutTotalCount

Bean上でロックを待機していてタイムアウトしたスレッドの現在の数。

タイプ: ロング

制約: 読取り専用

EjbMetrics

EjbMetricsエンティティには、EJBインスタンスの実行時のモニタリング情報が含まれます。

EjbMetricsエンティティのプロパティは、次のとおりです。

serverName

このEJBインスタンスが実行されるサーバーの名前。

タイプ: 文字列

制約: 読取り専用

transactionMetrics

EJBトランザクション・メトリック(該当する場合)。

タイプ: EjbTransactionMetrics

制約: 読取り専用

timerMetrics

EJBタイマー・メトリック(該当する場合)。

タイプ: EjbTimerMetrics

制約: 読取り専用

poolMetrics

EJBプール・メトリック(該当する場合)。

タイプ: EjbPoolMetrics

制約: 読取り専用

cacheMetrics

EJBキャッシュ・メトリック(該当する場合)。

タイプ: EjbCacheMetrics

制約: 読取り専用

lockingMetrics

EJBロック・メトリック(該当する場合)。

タイプ: EjbLockingMetrics

制約: 読取り専用

EjbPoolMetrics

EjbPoolMetricsエンティティには、各EJBに対する実行時のプール・モニタリング情報が含まれます。

EjbPoolMetricsエンティティのプロパティは、次のとおりです。

accessTotalCount

フリー・プールからのインスタンス取得が試行された合計回数。

タイプ: ロング

制約: 読取り専用

missTotalCount

フリー・プールからのインスタンス取得の試行が失敗した合計回数。プール内に使用可能なインスタンスがない場合、プールからのBean取得の試行は失敗します。

タイプ: ロング

制約: 読取り専用

destroyedTotalCount

非アプリケーション例外をスローしたために、このプールからのBeanインスタンスが破棄された合計回数。

タイプ: ロング

制約: 読取り専用

pooledBeansCurrentCount

フリー・プールからの、使用可能なBeanインスタンスの現在の数。

タイプ: int

制約: 読取り専用

beansInUseCurrentCount

フリー・プールからの、現在使用されているBeanインスタンスの数。

タイプ: int

制約: 読取り専用

waiterCurrentCount

フリー・プールからの、使用可能なBeanインスタンスを現在待機しているスレッドの合計数。

タイプ: int

制約: 読取り専用

timeoutTotalCount

フリー・プールからの、使用可能なBeanインスタンスを待機していてタイムアウトしたスレッドの合計数。

タイプ: ロング

制約: 読取り専用

EjbTimerMetrics

EjbTimerMetricsエンティティには、各EJBに対する実行時タイマー・モニタリング情報が含まれます。

EjbTimerMetricsエンティティのプロパティは、次のとおりです。

timeoutCount

このEJBについて行われた正常なタイムアウト通知の合計数。

タイプ: ロング

制約: 読取り専用

cancelledTimerCount

このEJBについて明示的に取り消されたタイマーの合計数。

タイプ: ロング

制約: 読取り専用

activeTimerCount

このEJBについてのアクティブなタイマーの現在の数。

タイプ: int

制約: 読取り専用

disabledTimerCount

このEJBについて一時的に無効化されたタイマーの現在の数。

タイプ: int

制約: 読取り専用

EjbTransactionMetrics

EjbTransactionMetricsエンティティには、各EJBに対する実行時のトランザクション・モニタリング情報が含まれます。

EjbTransactionMetricsエンティティのプロパティは、次のとおりです。

transactionsCommittedTotalCount

このEJBについてコミットされたトランザクションの合計数。

タイプ: ロング

制約: 読取り専用

transactionsRolledBackTotalCount

このEJBについてロールバックされたトランザクションの合計数。

タイプ: ロング

制約: 読取り専用

transactionsTimedOutTotalCount

このEJBについてタイムアウトしたトランザクションの合計数。

タイプ: ロング

制約: 読取り専用

Health

Healthエンティティは、WebLogicドメインのヘルスを表します。

Healthエンティティのプロパティは、次のとおりです。

state

ドメインのヘルス状態: ok、warn、critical、failed、overloadedまたはunknown。

タイプ: 文字列

制約: 読取り専用

reasons

このドメインのヘルス状態の理由。

タイプ: 文字列

制約: 読取り専用

JdbcConnectionPoolParams

JdbcConnectionPoolParamsエンティティには、データ・ソースの接続プールのパラメータが含まれます。

JdbcConnectionPoolParamsエンティティのプロパティは、次のとおりです。

initialCapacity

データ・ソースに接続プールを作成するときに作成する物理接続の数。この数の接続を作成できない場合、データ・ソースの作成は失敗します。

タイプ: int

maxCapacity

この接続プールが保有できる物理接続の最大数。

タイプ: int

minCapacity

初期化後にこの接続プールに含めることのできる物理接続の最小数。

タイプ: int

shrinkFrequencySeconds

接続プールが需要に見合うよう増加された後、縮小するまでの秒数。ゼロ(0)に設定すると、縮小機能は無効化されます。

タイプ: int

highestNumWaiters

データ・ソースの接続プールからの接続の予約を待機する間、同時にスレッドをブロックできる接続リクエストの最大数。

タイプ: int

connectionCreationRetryFrequencySeconds

この値を設定しないと、データベースが使用できない場合にデータ・ソースの作成が失敗します。この値を設定して、データ・ソースの作成時にデータベースが使用できない場合、指定した秒数が経過するたびにプール内における接続の作成を再試行し、成功するまで続行します。ゼロ(0)に設定すると、接続の再試行は無効化されます。

タイプ: int

connectionReserveTimeoutSeconds

接続プールから接続を予約する呼出しがタイムアウトになるまでの秒数。ゼロ(0)に設定すると、呼出しはタイムアウトにはなりません。-1に設定すると、呼出しは即座にタイムアウトになります。

タイプ: int

testFrequencySeconds

未使用の接続をテストするときに、次のテストが試行されるまでWebLogic Serverインスタンスが待機する秒数(「テスト対象の表名」を指定する必要があります。)テストに失敗した接続は閉じられ、再度開かれて有効な物理接続が再確立されます。テストが再度失敗すると、その接続は閉じられます。

マルチ・データ・ソースのコンテキストでは、この属性は、以前に異常としてマークされたデータ・ソースの状態がチェックされる頻度を制御します。

ゼロ(0)に設定すると、この機能は無効化されます。

タイプ: int

testConnectionsOnReserve

接続をクライアントに渡す前にWebLogic Serverでテストできるようにします。(「テスト対象の表名」を指定する必要があります。)

このテストを行うと、クライアントがプールに接続をリクエストした場合、そのリクエストに応えるまでに短い遅延が生じますが、クライアントでは有効な接続を確実に受け取ることができます。

タイプ: ブール

profileHarvestFrequencySeconds

プロファイル・データが収集される間隔(秒)。ゼロ(0)に設定すると、データの収集は無効化されます。

タイプ: int

ignoreInUseConnectionsEnabled

プールから取得した接続がまだ使用されている場合でも、データ・ソースを停止できるようにします。

タイプ: ブール

inactiveConnectionTimeoutSeconds

WebLogic Serverによって接続が再び要求されて接続プールに戻されるまでに、予約接続が非アクティブな秒数。

「非アクティブ接続タイムアウト」の機能を使用すると、リークされた接続(アプリケーションによって明示的に閉じられなかった接続)を再び要求できます。これは、接続を正常に閉じるために使用する機能ではありません。

ゼロ(0)に設定すると、この機能は無効化されます。

タイプ: int

testTableName

物理データベース接続のテスト時に使用するデータベース表の名前。「テスト頻度」を指定し、予約時に接続をテストを有効化した場合、この名前は必須になります。

接続をテストするために使用されるデフォルトのSQLコードは、select count(*) from TestTableNameです。ほとんどのデータベース・サーバーはこのSQLを最適化して表スキャンを回避しますが、「テスト対象の表名」を、行が少ない(またはまったくない)表の名前に設定することも有益です。

テスト対象の表名がSQLで始まる場合、SQLより後の文字列は、標準の問合せのかわりに接続をテストするリテラルのSQL文として扱われます。例: SQL BEGIN; Null; END;

Oracleデータベースの場合、「テスト対象の表名」をSQL PINGDATABASEに設定すると、pingDatabase()メソッドを使用してOracle接続のテストが実行されるため、接続テストのオーバーヘッドを減らすことができます。

タイプ: 文字列

loginDelaySeconds

各物理データベース接続を作成するまでにかかる遅延時間(秒)。この遅延により、短時間に連続する複数の接続リクエストを処理できないデータベース・サーバーがサポートされます。

この遅延は、最初にデータ・ソースが作成されるときにも、データ・ソースの生存期間中に物理データベース接続が作成されるときにも発生します。

タイプ: int

initSql

新しく作成した物理データベース接続を初期化するときに実行されるSQL文。文の記述はSQLで開始し、その後はスペースとします。

初期化SQL値がSQLで始まる場合、SQLより後の文字列は、データベース接続を初期化するリテラルのSQL文として扱われます。初期化SQL値がSQLで始まらない場合、その値は表の名前として扱われ、次のSQL文が接続の初期化に使用されます。select count(*) from InitSQL

表InitSQLが存在し、接続を使用するデータベース・ユーザーからアクセスできる必要があります。ほとんどのデータベース・サーバーはこのSQLを最適化して表スキャンを回避しますが、InitSQLを行が少ない(またはまったくない)表の名前に設定することも有益です。

タイプ: 文字列

制約: Null以外

statementCacheSize

キャッシュに格納されるプリコンパイルされた文および呼出し可能文の数。(これによって、サーバーのパフォーマンスが向上する場合があります。)

再ロードせずにキャッシュ内の文を再利用できるため、サーバーのパフォーマンスが向上する場合があります。接続プール内の接続ごとに、独自の文キャッシュが保持されます。

文のキャッシュ・サイズをゼロ(0)に設定すると、文のキャッシュは行われません。

タイプ: int

statementCacheType

文キャッシュに格納されたプリコンパイルされた文の管理に使用するアルゴリズム。

- least recently used - 新しいプリコンパイルされた文および呼出し可能文が使用されたときに、最も長い時間未使用の文がキャッシュ内で置換されます。

- fixed - 最初の固定数のプリコンパイルされた文および呼出し可能文がキャッシュされます。

タイプ: 文字列

removeInfectedConnections

アプリケーションで基底のベンダー接続オブジェクトが使用された後で、接続プールから接続を削除するかどうかを指定します。

影響のある接続の削除を無効化すると、データベース接続が他のアプリケーションでの再利用に適していることを確認する必要があります。

true (デフォルト)に設定すると、アプリケーションで論理的な接続が閉じられた後に、物理的な接続が接続プールに戻されません。かわりに、物理的な接続は閉じられ、再作成されます。

falseに設定すると、アプリケーションで論理的な接続が閉じられたときに、物理的な接続は接続プールに戻され、そのアプリケーションや別のアプリケーションによって再利用できます。

タイプ: ブール

secondsToTrustAnIdlePoolConnection

接続がアプリケーションに渡される前、または定期的な接続テストの処理中に、その接続がまだ有効であると信頼されて接続テストがスキップされる接続の秒数。

これは、特に大量のトラフィックが発生している場合に接続テストがパフォーマンスに及ぼす影響を最小限に抑える最適化オプションです。

タイプ: int

statementTimeout

現在実行されている文がタイム・アウトするまでの時間。

文のタイムアウトは、基底のJDBCドライバ・サポートに依存します。WebLogic Serverでは、java.sql.Statement.setQueryTimeout()メソッドを使用して、指定された時間をJDBCドライバに渡します。使用しているJDBCドライバでこのメソッドをサポートしていない場合、例外がスローされてタイムアウト値が無視されることがあります。

-1に設定すると、この機能は無効になります。値が0(ゼロ)の場合、文はタイムアウトしません。

タイプ: int

profileType

JDBCサブシステムについて収集するプロファイル・データのタイプ。

タイプ: int

jdbcXaDebugLevel

XAドライバのJDBCデバッグのレベルであり、範囲内で大きな値であればあるほどより多くのデバッグ情報が提供されます。

タイプ: int

credentialMappingEnabled

データ・ソースに対して「接続時にクライアントIDを設定」を有効化します。アプリケーションがデータベース接続をリクエストすると、WebLogic Serverによりデータベース接続に対して軽量クライアントIDが設定されます。

デフォルトでは、資格証明マッピングを使用して、WebLogic ServerユーザーIDがデータベース・ユーザーIDにマップされます。ただし、use-database-credentialsがtrue,に設定されている場合は、資格証明マッピングは実行されず、IDがそのままデータベース・ユーザーIDとして使用されます。

現時点では、IBM DB2ドライバとOracle Thinドライバでサポートされています。この機能のサポートは、将来のOracle Thinドライバのリリースで廃止されます。この機能のかわりに、プロキシ認証を使用することをお薦めします。

タイプ: ブール

driverInterceptor

JDBCドライバに対するメソッド呼出しのインターセプトに使用されるアプリケーション・クラスの絶対名。指定するアプリケーションは、weblogic.jdbc.extensions.DriverInterceptorインタフェースを実装している必要があります。

WebLogic Serverは、JDBCドライバ内のメソッドを呼び出す前後に、登録されたアプリケーションのpreInvokeCallback()、postInvokeExceptionCallback()およびpostInvokeCallback()メソッドを呼び出します。この機能を使用すると、JDBCドライバの使用状況のプロファイルや、次の監視を行うことができます。

- 実行中のメソッド

- スローされた例外

- メソッドを実行しているドライバ内部で経過した時間

タイプ: 文字列

制約: Null以外

pinnedToThread

アプリケーションによって論理接続が閉じられた後でもプールされたデータベース接続を実行スレッドが保持できるようにすることによって、パフォーマンスを向上できるオプションを有効化します。有効化された場合は次のようになります。

- アプリケーションが実行スレッドを使用して初めて接続を予約するときに接続プールからのデータベース接続がその実行スレッドに固定されます。アプリケーションで接続の使用が終了し、connection.close()がコールされても、接続は実行スレッドに固定された状態で保持され、接続プールに戻されません。その後、アプリケーションが同じ実行スレッドを使用して接続をリクエストすると、WebLogic Serverによってスレッドで予約済みの接続が提供されます。

- 複数のスレッドが1つの接続を同時に予約しようとしても、接続プールでロック競合は発生しません。数に限りのあるデータベース接続から複数のスレッドが同じ接続を予約しようとしても、スレッド競合は発生しません。

- アプリケーションが同じ実行スレッドを使用して接続プールからの複数の接続を同時に予約する場合、WebLogic Serverでは追加のデータベース接続が作成され、それらがスレッドに固定されます。

タイプ: ブール

identityBasedConnectionPoolingEnabled

データ・ソースのアイデンティティ・ベースの接続プールを有効化します。アプリケーションがデータベース接続をリクエストすると、WebLogic ServerはWebLogicユーザーIDおよびデータベースIDのマップに基づき、リクエストされたDBMSのIDを備える物理的接続を選択または作成します。また、WebLogic ServerユーザーIDのマップをデータベース・ユーザーIDに指定する必要があります(資格証明マッピング)。

タイプ: ブール

wrapTypes

デフォルトでは、Array、Blob、Clob、NClob、Ref、SQLXMLおよびStructのデータ型オブジェクトに加えてParameterMetaDataおよびResultSetMetaDataオブジェクトがWebLogicラッパーでラップされます。これにより、デバッグおよび接続使用状況などの機能をサーバーで処理できるようになります。ラップを無効にするには、この値をfalseに設定します。これによりパフォーマンスが(場合によっては大幅に)向上し、アプリケーションでネイティブ・ドライバ・オブジェクトを直接使用できるようになります。

タイプ: ブール

fatalErrorCodes

致命的エラーとして扱われるエラー・コードのカンマ区切リスト。これらのエラーには、サーバーがブートできなくなるデプロイメント・エラーおよび接続を接続プールに戻せなくなる接続エラーが含まれます。

このオプションのプロパティは致命的エラー・コードの定義に使用され、SQLException (sqlException.getErrorCode()によって取得)内で例外コードとして指定された場合に、致命的エラーが発生して接続が使用できなくなったことを示します。Oracleデータベースでは、次の致命的エラー・コードがWLSに事前定義されており、構成ファイルに配置する必要はありません:

- 3113: end-of-file on communication channel

- 3114: not connected to ORACLE

- 1033: ORACLE initialization or shutdown in progress

- 1034: ORACLE not available

- 1089: immediate shutdown in progress - no operations are permitted

- 1090: shutdown in progress - connection is not permitted

- 17002: I/O exception

タイプ: 文字列

制約: Null以外

connectionLabelingCallback

接続ラベリング・コールバックのクラス名。これは、データ・ソースの作成時に自動的にregisterConnectionLabelingCallbackに渡されます。このクラスはoracle.ucp.ConnectionLabelingCallbackを実装する必要があります。

タイプ: 文字列

制約: Null以外

connectionHarvestMaxCount

接続収集が行われるときに収集できる接続の最大数。有効値の範囲は1からMaxCapacityです。

タイプ: int

connectionHarvestTriggerCount

接続収集がいつ行われるかを判断するために使用される使用可能な接続(トリガー値)の数。

- 収集は、使用可能な接続数が接続プールのトリガー値を下回った場合に行われます。

- 有効値の範囲は-1からMaxCapacityです。

- デフォルト値は-1です。

- 値を-1に設定すると、接続収集が無効になります。

タイプ: int

countOfTestFailuresTillFlush

さらなるデータベース・テストによって発生する遅延を最小限に抑えるためにWebLogic Serverが接続プール内のすべての接続を閉じるまでの間許可される、テストの失敗数。

タイプ: int

countOfRefreshFailuresTillDisable

さらなるデータベース・テストによって発生する遅延を最小限に抑えるためにWebLogic Serverが接続プール内のすべての接続を閉じるまでの間許可される、リフレッシュの失敗数。

タイプ: int

wrapJdbc

デフォルトでは、CallableStatement、PreparedStatement、ResultSet、StatementおよびDatabaseMetaDataのSQLオブジェクトは、WebLogicラッパーでラップされます。ラップにより、デバッグおよび接続使用状況などの機能をサーバーで実行できるようになります。

falseの場合、ラップは無効化されます。ラップを無効にするとパフォーマンスが(場合によっては大幅に)向上し、アプリケーションでネイティブ・ドライバ・オブジェクトを直接使用できるようになります。falseの場合、データ型のラップも無効化されます。

タイプ: ブール

JdbcDataSourceParams

JdbcDataSourceParamsエンティティには、データ・ソースの基本構成設定が含まれます。

JdbcDataSourceParamsエンティティのプロパティは、次のとおりです。

jndiNames

このデータ・ソースのバインド先のJNDIパス。デフォルトでは、JNDI名はデータ・ソースの名前です。JNDIパスをルックアップするアプリケーションは、このデータ・ソースに対応するjavax.sql.DataSourceインスタンスを取得します。

タイプ: リスト<String>

scope

データ・ソースのスコープ: グローバルまたはアプリケーション

タイプ: 文字列

rowPrefetch

1回のサーバー・アクセスで複数の行のプリフェッチ(つまり、サーバーからクライアントに送る)を有効化します。

タイプ: ブール

rowPrefetchSize

行のプリフェッチが有効化されている場合、クライアント用にプリフェッチする結果セットの行数を指定します。

タイプ: int

streamChunkSize

ストリーム・データ型のデータ・チャンク・サイズ。

タイプ: int

algorithmType

マルチ・データ・ソースの接続リクエスト処理を決定するアルゴリズム: failoverまたはload balancing

タイプ: 文字列

dataSourceList

マルチ・データ・ソースが接続リクエストを送信するデータ・ソースのリスト。リスト内のデータ・ソースの順番でフェイルオーバーの順序が決まります。

タイプ: 文字列

connectionPoolFailoverCallbackHandler

マルチ・データ・ソースがマルチ・データ・ソース内の別のデータ・ソースに接続リクエストをフェイルオーバーまたはフェイルバックする準備ができているときに、送られたコールバックを処理するアプリケーション・クラスの名前。この名前は、weblogic.jdbc.extensions.ConnectionPoolFailoverCallbackインタフェースを実装するアプリケーション・クラスの絶対名である必要があります。

タイプ: 文字列

failoverRequestIfBusy

「フェイルオーバー」アルゴリズムのマルチ・データ・ソースに対して、現在のデータ・ソースのすべての接続が使用されている場合に、マルチ・データ・ソースが接続リクエストを次のデータ・ソースにフェイルオーバーできるようにします。

タイプ: ブール

globalTransactionsProtocol

データ・ソースのトランザクション・プロトコル(グローバル・トランザクション処理の動作): two phase commit、logging last resource、emulate two phase commit、one phase commitまたはnone

タイプ: 文字列

keepConnAfterLocalTx

WebLogic Serverがローカル・トランザクションをコミットするときに、接続を解放し必要に応じて別の物理接続を取得するかわりに、論理的接続に関連付けられている物理的なデータベース接続を保持できるようにします。このプロパティをtrueに設定すると、データベースでの追加の接続の構成が必要となる場合があります。

タイプ: ブール

keepConnAfterGlobalTx

WebLogic Serverがグローバル・トランザクションをコミットするときに、接続を解放するかわりに必要に応じて別の物理接続を取得することで、論理的接続に関連付けられている物理的なデータベース接続を保持できるようにします。このプロパティをtrueに設定すると、データベースでの追加の接続の構成が必要となる場合があります。

タイプ: ブール

JdbcDriverParams

JdbcDriverParamsエンティティには、データ・ソースによって使用されるJDBCドライバのドライバ・パラメータが含まれます。

JdbcDriverParamsエンティティのプロパティは、次のとおりです。

useXaDataSourceInterface

WebLogic ServerでJDBCドライバのXAインタフェースが使用されることを指定します。データベース接続の作成に使用されるJDBCドライバ・クラスがJDBCドライバのXAバージョンと非XAバージョンの両方を実装している場合、この属性を設定すると、JDBCドライバがXAドライバまたは非XAドライバとして扱われるよう指定できます。

タイプ: ブール

usePasswordIndirection

データベース資格証明が、userプロパティをキーとして使用して、資格証明マッパーから取得されるかどうかを指定します。trueの場合、資格証明は資格証明マッパーから取得されます。falseの場合、データベースのユーザー名とパスワードは、userプロパティおよびパスワード要素からそれぞれ取得されます。

タイプ: ブール

systemProperties

物理的なデータベース接続の作成中にJDBCドライバに渡されるプロパティのリスト。

ドライバ・レベルの機能を有効にするには、ドライバ・プロパティとその値を「プロパティ」リストに追加します。「プロパティ」リストにあるドライバ・レベルのプロパティがドライバのConnectionPoolDataSourceオブジェクトに設定されます。

注意: セキュリティ上の理由で、WebLogic Serverが本番モードで動作している場合は、このプロパティ・リストにデータベース・パスワードを指定することはできません。プロパティ・リストにパスワードが指定されていると、データ・ソースのデプロイメントが失敗します。このセキュリティ・チェックをオーバーライドするには、サーバーの起動時にコマンドライン引数weblogic.management.allowClearTextPasswordsを使用します。

タイプ: リスト<Property>

Job

Jobエンティティには、非同期タスクの情報が含まれます。

Jobエンティティのプロパティは、次のとおりです。

id

特定のジョブ・タイプ内のジョブの一意のID。表示されることを目的としていません。URLの構築およびジョブの追加情報の問合せを行う際に便利です。

タイプ: 文字列

制約: 読取り専用

name

このジョブに関連付ける名前。

タイプ: 文字列

制約: 読取り専用

type

ジョブのタイプ: serverまたはdeployment

タイプ: 文字列

制約: 読取り専用

status

このジョブのステータス。

タイプ: 文字列

制約: 読取り専用

description

このジョブに関連付ける説明。

タイプ: 文字列

制約: 読取り専用

beginTime

このジョブの開始時刻。

タイプ: ロング

制約: 読取り専用

endTime

このジョブの完了時刻。実行中の場合ゼロ(0)。

タイプ: ロング

制約: 読取り専用

error

このジョブのエラー・メッセージ(存在する場合)。

タイプ: 文字列

制約: 読取り専用

Library

Libraryエンティティには、ライブラリ・デプロイメントの情報(このライブラリに依存するライブラリやアプリケーションなど)が含まれます。

Libraryエンティティには、次のプロパティに加えて、すべてのDeploymentプロパティが含まれることに注意してください。

Libraryエンティティのプロパティは、次のとおりです。

specVersion

ライブラリ仕様のバージョン(デプロイメント・マニフェスト・ファイルから)。

タイプ: 文字列

制約: 読取り専用

implVersion

ライブラリ実装のバージョン(デプロイメント・マニフェスト・ファイルから)。

タイプ: 文字列

制約: 読取り専用

referencingApplications

このライブラリを参照するアプリケーション名のリスト。

タイプ: リスト<String>

制約: 読取り専用

referencingLibraries

このライブラリを参照するその他のライブラリ名のリスト。

タイプ: リスト<String>

制約: 読取り専用

LogEntry

LogEntryエンティティでは、ログ・ファイル内の特定のログ・エントリが記述されます。

WebLogic Server内のログ・ファイルに記録されるフィールドは、ログ・タイプ(データ・ソース、HTTPアクセスまたはサーバー・ログ)に応じて大きく異なります。LogEntryエンティティに返される情報も、表示しているログ・ファイルに応じて異なります。

LogEntryエンティティのプロパティは、次のとおりです。

recordId

このログ内のこのログ・エントリの一意の識別子。

タイプ: 文字列

制約: 読取り専用

timeStamp

このログ・エントリの日時。リソース・アダプタ・ログにはありません。

タイプ: 文字列

制約: 読取り専用

severity

この状況の重大度(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

subSystem

この状況に関連付けられているサブシステム(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

msgId

この状況のメッセージID(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

message

この状況に関連付けられているメッセージ(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

host

この状況のホスト(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

remoteUser

この状況に関連付けられているリモート・ユーザー(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

authUser

この状況に関連付けられている認可されたユーザー(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

request

この状況に関連付けられているリクエスト(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

status

この状況のステータス(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

userId

この状況に関連付けられているユーザーID(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

contextId

この状況に関連付けられているコンテキストID(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

datasource

この状況に関連付けられているデータ・ソース(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

profileType

この状況に関連付けられているプロファイル・タイプ(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

user

この状況に関連付けられているユーザー(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

profileInformation

この状況に関連付けられているプロファイル情報(このログ・タイプに該当する場合)。

タイプ: 文字列

制約: 読取り専用

LogReference

LogReferenceエンティティでは、特定の名前付きログが記述されます。

LogReferenceエンティティのプロパティは、次のとおりです。

name

ログの名前。

タイプ: 文字列

制約: 読取り専用

Server

Serverエンティティでは、WebLogic Serverインスタンスに関連付けられている構成、状態およびメトリックが記述されます。

Serverエンティティのプロパティは、次のとおりです。

name

このサーバー・インスタンスの名前。

タイプ: 文字列

制約: 読取り専用

state

このサーバー・インスタンスの現在の状態。

- shutdown

- starting

- running

- standby

- admin

- suspending

- force suspending

- resuming

- shutting down

- force shutting down

- failed

- unknown

- discovered

- failed restarting

- activate later

- failed not restartable

- failed migratable

タイプ: 文字列

制約: 読取り専用

health

このサーバー・インスタンスのヘルス(実行中の場合)。このヘルス・ステータスは、すべてのサーバー・コンポーネントにわたり集約され、最も重大なヘルス状況が発生していることを示します。

タイプ: ヘルス

制約: 読取り専用

jvmProcessorLoad

VMがすべてのプロセッサに与えている平均負荷(0%から100%までのパーセント値)

タイプ: int

制約: 読取り専用

usedPhysicalMemory

このサーバーで現在使用されている物理メモリー量(バイト)。

タイプ: ロング

制約: 読取り専用

heapSizeCurrent

このサーバーによって使用されるJVMヒープの現在のサイズ(バイト)。

タイプ: ロング

制約: 読取り専用

heapFreeCurrent

JVMヒープで現在使用可能なメモリー量(バイト)。

タイプ: ロング

制約: 読取り専用

activeHttpSessionCount

このサーバーによってホストされるすべてのサーブレットの現在アクティブなHTTPセッション数。

タイプ: int

制約: 読取り専用

activeThreadCount

このサーバーのすべてのアプリケーションおよびリソースによって使用されているアクティブなスレッド数。

タイプ: int

制約: 読取り専用

ServerJob

ServerJobエンティティは、Jobエンティティの属性を含み、サーバー・ライフサイクル操作に一意の追加属性を追加します。

ServerJobエンティティのプロパティは、次のとおりです。

status

サーバー・ジョブ・ステータス: in progress、completedまたはfailed。

タイプ: 文字列

制約: 読取り専用

serverName

このジョブの影響を受けるサーバーの名前。

タイプ: 文字列

制約: 読取り専用

operation

このジョブによって追跡されるサーバー・ライフサイクルの状態遷移。

- start

- shutdown

- start in standby

- resume

- force shutdown

- suspending

- force suspend

タイプ: 文字列

制約: 読取り専用

Servlet

Servletエンティティには、各サーブレットの情報が含まれます。

Servletエンティティのプロパティは、次のとおりです。

servletName

サーブレットのこのインスタンスの名前。

タイプ: 文字列

制約: 読取り専用

moduleName

このサーブレットに関連付けるモジュール。

タイプ: 文字列

制約: 読取り専用

contextPath

このサーブレットのコンテキスト・パス。

タイプ: 文字列

制約: 読取り専用

aggregateMetrics

このサーブレットの実行中のすべてのインスタンスにわたり計算される集計メトリック。

タイプ: ServletMetrics

制約: 読取り専用

servletMetrics

このサーブレットのサーバーごとの実行時メトリックのリスト。

タイプ: リスト<ServletMetrics>

制約: 読取り専用

ServletMetrics

ServletMetricsエンティティには、サーブレット・インスタンスの実行時のモニタリング情報が含まれます。

ServletMetricsエンティティのプロパティは、次のとおりです。

serverName

このサーブレット・インスタンスが実行されるサーバーの名前。

タイプ: 文字列

制約: 読取り専用

reloadTotalCount

このサーブレットが再ロードされた合計回数。

タイプ: int

制約: 読取り専用

invocationTotalCount

このサーブレットが呼び出された合計回数。

タイプ: int

制約: 読取り専用

executionTimeTotal

サーブレットが作成されてから、実行されたサーブレットのすべての呼出しの合計時間。

タイプ: ロング

制約: 読取り専用

executionTimeHigh

サーブレットが作成されてから、実行されたサーブレットの最も長かった呼出しの時間。

タイプ: int

制約: 読取り専用

executionTimeLow

サーブレットが作成されてから、実行されたサーブレットの最も短かった呼出しの時間。CounterMonitorの場合は別のオプションを使用する必要があります。

タイプ: int

制約: 読取り専用

Target

Targetエンティティは、WLSターゲットを表します。

Targetエンティティのプロパティは、次のとおりです。

name

このターゲットの名前。

タイプ: 文字列

制約: 読取り専用

type

このターゲットのタイプ: serverまたはcluster。

タイプ: 文字列

制約: 読取り専用

Version

Versionエンティティでは、WLSリソースのバージョンが記述されます。

Versionエンティティのプロパティは、次のとおりです。

version

このバージョンの名前。

タイプ: 文字列

制約: 読取り専用

isLatest

これがデフォルト・バージョンの場合True。

タイプ: ブール

制約: 読取り専用

state

このバージョンのライフサイクル: activeまたはdeprecated

タイプ: 文字列

制約: 読取り専用

lifecycle

タイプ: 文字列

Wls

Wlsエンティティは、WebLogic Serverドメインの全体の状態および状況へのアクセスを提供します。

Wlsエンティティのプロパティは、次のとおりです。

name

このドメインの名前。

タイプ: 文字列

制約: 読取り専用

productionMode

このドメインが本番モードで稼働中の場合True。このドメインが開発モードで稼働中の場合False。

タイプ: ブール

制約: 読取り専用

activeHttpSessionCount

このドメイン内のすべてのアプリケーションおよびすべてのサーバー内のアクティブなHTTPセッションの合計数。

タイプ: int

制約: 読取り専用

activeThreadCount

すべてのサーバー上で現在使用中のアクティブなスレッドの合計数。

タイプ: int

制約: 読取り専用

configuredServerCount

潜在的なWebLogic Serverインスタンス数。

タイプ: int

制約: 読取り専用

activeServerCount

現在アクティブなWebLogic Serverインスタンス数。

タイプ: int

制約: 読取り専用

overallServiceHealth

このドメインのヘルス。このヘルス・ステータスは、実行中のすべてのサーバーにわたり集約されており、最も重大なヘルス状況が発生したことを示します。

タイプ: ヘルス

制約: 読取り専用

オラクル社の法律上の注意点について

コピーライトについて

Copyright © 1994-2015, Oracle and/or its affiliates.All rights reserved.

商標と登録商標について

OracleおよびJavaはOracle Corporationおよびその関連企業の登録商標です。その他の名称は、それぞれの所有者の商標または登録商標です。

Intel、Intel Xeonは、Intel Corporationの商標または登録商標です。すべてのSPARCの商標はライセンスをもとに使用し、SPARC International, Inc.の商標または登録商標です。AMD、Opteron、AMDロゴ、AMD Opteronロゴは、Advanced Micro Devices, Inc.の商標または登録商標です。UNIXは、The Open Groupの登録商標です。

ライセンス制約の保証と結果的に生じる損害の免責

このソフトウェアおよび関連ドキュメントの使用と開示は、ライセンス契約の制約条件に従うものとし、知的財産に関する法律により保護されています。ライセンス契約で明示的に許諾されている場合もしくは法律によって認められている場合を除き、形式、手段に関係なく、いかなる部分も使用、複写、複製、翻訳、放送、修正、ライセンス供与、送信、配布、発表、実行、公開または表示することはできません。このソフトウェアのリバース・エンジニアリング、逆アセンブル、逆コンパイルは互換性のために法律によって規定されている場合を除き、禁止されています。

保証免責

ここに記載された情報は予告なしに変更される場合があります。また、誤りが無いことの保証はいたしかねます。誤りを見つけた場合は、オラクル社までご連絡ください。

制限付権利

このソフトウェアまたは関連ドキュメントを、米国政府機関もしくは米国政府機関に代わってこのソフトウェアまたは関連ドキュメントをライセンスされた者に提供する場合は、次の通知が適用されます。

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.No other rights are granted to the U.S. Government.

危険な用途への使用について

このソフトウェアもしくはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアもしくはハードウェアは、危険が伴うアプリケーション（人的傷害を発生させる可能性があるアプリケーションを含む）への用途を目的として開発されていません。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性（redundancy）、その他の対策を講じることは使用者の責任となります。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、オラクル社およびその関連会社は一切の責任を負いかねます。

第三者のコンテンツ、製品、サービスに対する免責事項

このソフトウェアまたはハードウェア、そしてドキュメントは、第三者のコンテンツ、製品、サービスへのアクセス、あるいはそれらに関する情報を提供することがあります。オラクル社およびその関連会社は、第三者のコンテンツ、製品、サービスに関して一切の責任を負わず、いかなる保証もいたしません。オラクル社およびその関連会社は、第三者のコンテンツ、製品、サービスへのアクセスまたは使用によって損失、費用、あるいは損害が発生しても一切の責任を負いかねます。

ドラフトのアルファ版およびベータ版ドキュメントについて

このドキュメントが試作版の場合:

このドキュメントは試作版であり、デモおよび暫定使用のみを目的としたものです。このソフトウェアを使用するハードウェアに限定するものではありません。オラクル社およびその関連会社は、このドキュメントに関して一切の責任を負わず、いかなる保証もいたしません。また、このドキュメントを使用したことによって損失、費用、あるいは損害が発生しても、一切の責任を負いかねます。