Oracle® Fusion Middleware

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

12c (12.2.1.2.0)

E82696-01(原本部品番号:E78018-01)

2016年9月

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

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

E82696-01

Copyright © 2014, 2016, Oracle and/or its affiliatesAll 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 リソース

- /lifecycle

- GET

- /lifecycle/{version}

- GET

- /lifecycle/{version}/environmentCreateForm

- GET

- /lifecycle/{version}/environments

- GET

- POST

- /lifecycle/{version}/environments/{environment-name}

- DELETE

- GET

- /lifecycle/{version}/environments/{environment-name}/associatePartitions

- POST

- /lifecycle/{version}/environments/{environment-name}/deprovision

- POST

- /lifecycle/{version}/environments/{environment-name}/dissociatePartitions

- POST

- /lifecycle/{version}/environments/{environment-name}/partitionCreateForm

- GET

- /lifecycle/{version}/environments/{environment-name}/partitions

- GET

- POST

- /lifecycle/{version}/environments/{environment-name}/runtimes/{runtime-name}/partitions/{partition-name}

- DELETE

- GET

- /lifecycle/{version}/environments/{environment-name}/runtimes/{runtime-name}/partitions/{partition-name}/migrate

- POST

- /lifecycle/{version}/environments/{environment-name}/runtimes/{runtime-name}/partitions/{partition-name}/{operation}/task/{partitionOrResource}/{task-name}

- DELETE

- GET

- /lifecycle/{version}/environments/{environment-name}/runtimes/{runtime-name}/partitions/{partition-name}/quiesce

- POST

- /lifecycle/{version}/environments/{environment-name}/runtimes/{runtime-name}/partitions/{partition-name}/restart

- POST

- /lifecycle/{version}/environments/{environment-name}/runtimes/{runtime-name}/partitions/{partition-name}/start

- POST

- /lifecycle/{version}/environments/{environment-name}/sync

- POST

- /lifecycle/{version}/plugins

- GET

- POST

- /lifecycle/{version}/plugins/{plugin-name}

- DELETE

- GET

- /lifecycle/{version}/runtimeCreateForm

- GET

- /lifecycle/{version}/runtimes

- GET

- POST

- /lifecycle/{version}/runtimes/{runtime-name}

- DELETE

- GET

- POST

- /lifecycle/{version}/runtimes/{runtime-name}/partitionCreateForm

- GET

- /lifecycle/{version}/runtimes/{runtime-name}/partitions

- DELETE

- GET

- POST

- /lifecycle/{version}/runtimes/{runtime-name}/partitions/{partition-name}

- DELETE

- GET

- POST

- /lifecycle/{version}/runtimes/{runtime-name}/quiesce

- POST

- /lifecycle/{version}/runtimes/{runtime-name}/quiesce/task/{server-name}/{task-name}

- DELETE

- GET

- /lifecycle/{version}/runtimes/{runtime-name}/scaleDown

- POST

- /lifecycle/{version}/runtimes/{runtime-name}/scaleUp

- POST

- /lifecycle/{version}/runtimes/{runtime-name}/scaleUp/task/{cluster-name}/{task-name}

- DELETE

- GET

- /lifecycle/{version}/runtimes/{runtime-name}/start

- POST

- /lifecycle/{version}/runtimes/{runtime-name}/start/task/{server-name}/{task-name}

- DELETE

- GET

- /lifecycle/{version}/runtimes/{runtime-name}/sync

- POST

- /lifecycle/{version}/sync

- POST

- /lifecycle/{version}/tenantCreateForm

- GET

- /lifecycle/{version}/tenants

- GET

- POST

- /lifecycle/{version}/tenants/{tenant-name}

- DELETE

- GET

- POST

- /lifecycle/{version}/tenants/{tenant-name}/serviceCreateForm

- GET

- /lifecycle/{version}/tenants/{tenant-name}/services

- GET

- POST

- /lifecycle/{version}/tenants/{tenant-name}/services/{service-name}

- DELETE

- GET

- POST

- /lifecycle/{version}/tenants/{tenant-name}/services/{service-name}/PDB

- DELETE

- GET

- POST

- /lifecycle/{version}/tenants/{tenant-name}/services/{service-name}/PDBCreateForm

- GET

2 エンティティ

- AssociatePartitions

- Deprovision

- DissociatePartitions

- Environment

- EnvironmentPartition

- MigratePartition

- Orchestration

- PDB

- Property

- QuiescePartition

- QuiesceRuntime

- RegisterPlugin

- RestartPartition

- Runtime

- RuntimePartition

- ScaleRuntime

- Service

- StartPartition

- StartRuntime

- Task

- Tenant

- Version

はじめに

この「はじめに」では、ドキュメント・アクセシビリティ機能およびこのガイド『Oracle WebLogic Server 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 RESTfulライフ・サイクル管理リソースについて説明します。

WLS RESTリファレンス・ドキュメントとその説明の一覧は、RESTful管理サービスによるOracle WebLogic Serverの管理を参照してください。

/lifecycle

バージョン・リソースは、現在のWLSドメインでアクティブでありサポートされているライフサイクルRESTインタフェースのバージョンに関する情報を含みます。

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

- GET

GET

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

ロール

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

レスポンス本文

返されるレスポンス本文には、サポートされているこのRESTインタフェースのバージョンのVersionエンティティのリストが含まれます。返される情報には、最新バージョンと、各バージョンがアクティブかどうかが含まれます。

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

- uri=/lifecycle/12.2.1.0 rel=current

レスポンス・コード

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

例

例1   バージョンのリスト

この例では、GETメソッドを使用して使用可能なバージョンをリストします。

リクエストの例

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"items": [{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/12.2.1.0"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/12.2.1.0"
}
],
"version": "12.2.1.0",
"isLatest": true,
"lifecycle": "active"
}],
"links": [
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/"
},
{
"rel": "current",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/12.2.1.0"
}
]
}

/lifecycle/{version}

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

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

- GET

GET

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

ロール

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

レスポンス本文

返されるレスポンス本文には、現在のWLSリリースでアクティブでありサポートされている最新のサポート対象のRESTライフサイクル・インタフェース・バージョンに関する情報を含むVersionエンティティが含まれます。

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

- uri=/lifecycle/{version}/environmentCreateForm rel=environmentCreateForm

- uri=/lifecycle/{version}/environments rel=environments

- uri=/lifecycle/{version}/plugins rel=plugins

- uri=/lifecycle/{version}/runtimeCreateForm rel=runtimeCreateForm

- uri=/lifecycle/{version}/runtimes rel=runtimes

- uri=/lifecycle/{version}/tenantCreateForm rel=tenantCreateForm

- uri=/lifecycle/{version}/tenants rel=tenants

レスポンス・コード

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

例

例1   バージョンの記述

この例では、GETメソッドを使用してバージョンを記述します。

リクエストの例

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"version": "12.2.1.0",
"isLatest": true,
"lifecycle": "active",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/"
},
{
"rel": "environmentCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environmentCreateForm"
},
{
"rel": "environments",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments"
},
{
"rel": "runtimeCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimeCreateForm"
},
{
"rel": "runtimes",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes"
},
{
"rel": "tenantCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenantCreateForm"
},
{
"rel": "tenants",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants"
},
{
"rel": "plugins",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins"
}
]
}

/lifecycle/{version}/environmentCreateForm

このリソースは、環境の作成に必要な情報を記述します。

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

- GET

GET

このリソースのGETメソッドは、環境用の空のフォームを返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、環境の作成時に指定する必要があるフィールドに関する情報を含むEnvironmentエンティティが含まれます。

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

- uri=/environments rel=/environments

レスポンス・コード

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

例

例1   環境作成フォームの取得

この例では、GETメソッドを使用して環境作成フォームを取得します。

リクエストの例

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/environmentCreateForm

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"name": null,
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environmentCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environmentCreateForm"
},
{
"rel": "environments",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments"
}
]
}

/lifecycle/{version}/environments

このリソースは、環境を管理します。

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

- GET

- POST

GET

このリソースのGETメソッドは、環境のリストを返します。

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   環境の表示

この例では、GETメソッドを使用して環境を表示します。

リクエストの例

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

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"items": [{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
}
],
"name": "sprite"
}],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environmentCreateForm"
}
]
}

POST

POSTメソッドは、環境を作成します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   環境の作成

この例では、POSTメソッドを使用して空の環境を作成します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d "{ "name": "sprite" }" \
-X POST http://localhost:7001/management/lifecycle/latest/environments

レスポンスの例

HTTP/1.1 201 Created

Location: http://localhost:7001/management/lifecycle/latest/environments/sprite

Response Body:
{}

この例では、POSTメソッドを使用してオーケストレーションに基づく環境を作成し、最初にパーティションが作成されてから環境に追加されるようにします。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"name": "coke",
"orchestration": {"name": "orchestration1",
"args": [
{"name": "wls",
"properties": [
{"name": "partitionName", "value": "wlspartition1"},
{"name": "runtimeName", "value": "WLSTestRuntime"},
{"name": "partitionProperties",
"properties": [
{ "name" : "resourceGroups",
"properties" : [
{ "name" : "g1",
"properties" : [
{ "name" : "resourceGroupTemplate", "value" : "template1" },
{ "name" : "targets" , "value" : "VirtualHost-0"}]}]},
{"name" : "availableTargets" , "value" : "VirtualHost-0"}]
}]}]}}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments

レスポンスの例

HTTP/1.1 201 Created

Location: http://localhost:7001/management/lifecycle/latest/environments/sprite

Response Body:
{}

/lifecycle/{version}/environments/{environment-name}

このリソースは、環境を管理します。

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

- DELETE

- GET

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/lifecycle/latest/environments/sprite

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

GET

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

ロール

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

レスポンス本文

返されるレスポンス本文には、指定した環境に関する情報を含むEnvironmentエンティティが含まれます。

レスポンス・コード

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

例

例1   環境の表示

この例では、GETメソッドを使用して特定の環境に関する情報を表示します。

リクエストの例

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

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"name": "sprite",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
},
{
"rel": "partitionCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/test1\/partitionCreateForm"
},
{
"rel": "partitions",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/test1\/partitions"
},
{
"rel": "associatePartitions",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/test1\/associatePartitions"
}
]
}

/lifecycle/{version}/environments/{environment-name}/associatePartitions

このリソースは、2つの環境パーティションを相互に関連付けるために使用されます。

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

- POST

POST

POSTメソッドは、2つの環境パーティションを相互に関連付けます。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   WLSパーティションとPDBパーティションの関連付け

この例では、POSTメソッドを使用して2つのパーティションを相互に関連付けます。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{
"partition1Name": "SpritePartition",
"partition1RuntimeName": "WLSRuntime",
"partition2Name": "SpritePDB",
"partition2RuntimeName": "DBRuntime",
"properties":[
{"name": "jdbcSystemResource", "properties" : [
{"name": "resourceGroups", "properties": [
{"name": "g1", "value": "SpritePDB"}]}]},
{"name": "jdbcSystemResourceOverride", "value": "SpritePDB" }]}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/associatePartitions

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

/lifecycle/{version}/environments/{environment-name}/deprovision

このリソースは、環境をクリーン・アップおよび削除します。これには、パーティションのプロビジョニング解除、関連付け解除および削除が含まれます。

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

- POST

POST

POSTメソッドは、指定した環境内のパーティションをプロビジョニング解除および関連付け解除します。指定した環境はその後削除されます。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   プロビジョニング解除を含む環境クリーン・アップ

この例では、POSTメソッドを使用して環境をクリーン・アップします。これには、パーティションのプロビジョニング解除、パーティションの削除、および環境の削除が含まれます。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d '{
"orchestration": {"name": "deleteAll",
"args": [
{"name": "wls",
"properties": [
{"name": "component", "properties": [
{"name": "componentName", "value": "MockComponent"},
{"name": "configurableAttributes", "properties": [
{"name": "name", "value": "MockComponent"},
{"name": "configurableAttributes", "properties": [
{"name": "mockUser", "value": "jennifer"}
]}
]}
]},
{"name": "partitionName", "value": "wlspartition1"}
]}
]}
}' -X POST http://localhost:7001/management/lifecycle/latest/environments/cokeenv/deprovision

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

/lifecycle/{version}/environments/{environment-name}/dissociatePartitions

このリソースでは、関連付けられたパーティションの関連付けを解除できます。

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

- POST

POST

POSTメソッドは、2つのパーティションの関連付けを解除します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   WLSパーティションとPDBの関連付け解除

この例では、POSTメソッドを使用して2つのパーティションの関連付けを解除します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{
"partition1Name": "SpritePartition",
"partition1RuntimeName": "WLSRuntime",
"partition2Name": "SpritePDB",
"partition2RuntimeName": "DBRuntime",
"properties":[
{"name": "jdbcSystemResource", "properties" : [
{"name": "resourceGroups", "properties": [
{"name": "g1", "value": "SpritePDB"}]}]},
{"name": "jdbcSystemResourceOverride", "value": "SpritePDB" }]}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/dissociatePartitions

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

/lifecycle/{version}/environments/{environment-name}/partitionCreateForm

このリソースは、環境へのパーティションの追加に必要な情報を記述します。

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

- GET

GET

このリソースのGETメソッドは、パーティション用の空のフォームを返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、環境にパーティションを追加する際に指定する必要があるフィールドに関する情報を含むEnvironmentPartitionエンティティが含まれます。

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

- uri=/partitions rel=/partitions

レスポンス・コード

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

例

例1   パーティション作成フォームの取得

この例では、GETメソッドを使用してパーティション作成フォームを取得します。

リクエストの例

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/environments/sprite/partitionCreateForm

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"runtimeName": null,
"name": null,
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitionCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitionCreateForm"
},
{
"rel": "partitions",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitions"
}
]
}

/lifecycle/{version}/environments/{environment-name}/partitions

このリソースは、環境パーティションを管理します。

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

- GET

- POST

GET

このリソースのGETメソッドは、リソースURLによって識別される環境のパーティションのリストを返します。

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   パーティションの表示

この例では、GETメソッドを使用して特定の環境のパーティションを表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/environments/sprite/partitions

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"items": [
{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
}
],
"runtimeName": "WLSRuntime",
"name": "SpritePartition"
}
],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitions"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitions"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitionCreateForm"
}
]
}

POST

POSTメソッドは、リソースURLで識別される環境にパーティションを追加します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   環境へのパーティションの追加

この例では、POSTメソッドを使用して環境にパーティションを追加します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"name": "SpritePartition", "runtimeName": "WLSRuntime"}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/partitions

レスポンスの例

HTTP/1.1 201 Created

Location: http://localhost:7001/management/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition

Response Body:
{}

/lifecycle/{version}/environments/{environment-name}/runtimes/{runtime-name}/partitions/{partition-name}

このリソースは、環境パーティションを管理します。

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

- DELETE

- GET

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/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

GET

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

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   パーティションに関する情報の表示

この例では、GETメソッドを使用して特定のパーティションに関する情報を表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"runtimeName": "WLSRuntime",
"name": "SpritePartition",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/partitions"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
}
]
}

/lifecycle/{version}/environments/{environment-name}/runtimes/{runtime-name}/partitions/{partition-name}/migrate

このリソースは、パーティションを移行します。

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

- POST

POST

このリソースのPOSTメソッドは、リソースURLによって識別されるパーティションを移行します。

ロール

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

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   パーティションの移行

この例では、POSTメソッドを使用して特定のパーティションを移行します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{ "runtimeName": "WLSRuntime", "phase": "", "properties": [] }' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/partitions/SpritePartition

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

/lifecycle/{version}/environments/{environment-name}/runtimes/{runtime-name}/partitions/{partition-name}/{operation}/task/{partitionOrResource}/{task-name}

このリソースは、パーティション・タスクを管理します。

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

- DELETE

- GET

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/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition/quiesce/task/quiescePartition/SpritePartition/_1_STOP

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

GET

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

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   タスクの表示

この例では、GETメソッドを使用して特定のタスクに関する情報を表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition/quiesce/task/quiescePartition/SpritePartition/_1_STOP

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"status": "TASK COMPLETED",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition\/quiesce\/task\/quiescePartition\/SpritePartition\/_1_STOP"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition\/quiesce\/task\/quiescePartition\/SpritePartition\/_1_STOP"
}
]
}

/lifecycle/{version}/environments/{environment-name}/runtimes/{runtime-name}/partitions/{partition-name}/quiesce

このリソースは、パーティションを静止します。

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

- POST

POST

POSTメソッドは、指定したパーティションに対して静止処理を実行します。

ロール

管理者

レスポンス本文

返されるレスポンス本文には、対応するタスク・リソースへのリンクが含まれます。

レスポンス・コード

このメソッドは、標準のHTTPレスポンス・コード、ステータス・コードを返します。

例

例1   パーティションの静止

この例では、POSTメソッドを使用してパーティションを静止します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"phase": "", "properties" : []}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition/quiesce

レスポンスの例

HTTP/1.1 202 Accepted

Response Body:
{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition\/quiesce\/task\/quiescePartition\/SpritePartition\/_1_STOP"
}]}

/lifecycle/{version}/environments/{environment-name}/runtimes/{runtime-name}/partitions/{partition-name}/restart

このリソースは、パーティションの再起動に使用されます。

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

- POST

POST

POSTメソッドは、指定したパーティションに対して再起動処理を実行します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   パーティションの再起動

この例では、POSTメソッドを使用してパーティションを再起動します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d '{"phase": "", "properties" : []}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/cokeenv/partitions/wlspartition1/restart

レスポンスの例

{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/cokeenv\/partitions\/wlspartition1\/restart\/task\/restartPartition\/wlspartition1\/_1_FORCE_RESTART"
}]}

/lifecycle/{version}/environments/{environment-name}/runtimes/{runtime-name}/partitions/{partition-name}/start

このリソースは、パーティションの起動に使用されます。パーティションを起動すると、すべてのアプリケーション・デプロイメントおよびリソースがアクティブになり、エンド・ユーザーおよびその他のコンポーネントに応答するようになります。

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

- POST

POST

POSTメソッドは、指定したパーティションに対して起動処理を実行します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   パーティションの起動

この例では、POSTメソッドを使用してパーティションを起動します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"phase": "", "properties" : []}' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/runtimes/WLSRuntime/partitions/SpritePartition/start

レスポンスの例

HTTP/1.1 202 Accepted

Response Body:
{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/sprite\/runtimes\/WLSRuntime\/partitions\/SpritePartition\/start\/task\/startPartition\/SpritePartition\/_2_START"
}]}

/lifecycle/{version}/environments/{environment-name}/sync

このリソースは、環境を同期します。

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

- POST

POST

POSTメソッドは、環境を同期します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   環境の同期

この例では、POSTメソッドを使用して環境を同期します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '' \
-X POST http://localhost:7001/management/lifecycle/latest/environments/sprite/sync

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

/lifecycle/{version}/plugins

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

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

- GET

- POST

GET

このリソースのGETメソッドは、登録済プラグインのリストを返します。

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   プラグインのリストの表示

この例では、GETメソッドを使用して登録済プラグインのリストを表示します。

リクエストの例

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

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"items": [
{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins\/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins\/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar"
}
],
"name": "com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar",
"path": "\/opt\/wls\/src1214_build\/Oracle_Home\/wlserver\/modules\/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar"
}
],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins"
}
]
}

POST

POSTメソッドは、プラグインを登録します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   プラグインの登録

この例では、POSTメソッドを使用してプラグインを登録します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{ "path": "/opt/wls/src1214_build/Oracle_Home/wlserver/modules/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar" }' \
-X POST http://localhost:7001/management/lifecycle/latest/plugins

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

/lifecycle/{version}/plugins/{plugin-name}

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

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

- DELETE

- GET

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/lifecycle/latest/plugins/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

GET

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

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   プラグインの表示

この例では、GETメソッドを使用して特定のプラグインに関する情報を表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/plugins/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"name": "com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar",
"path": "\/opt\/wls\/src1214_build\/Oracle_Home\/wlserver\/modules\/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins\/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/plugins\/com.oracle.weblogic.lifecycle.plugin.wls_1.0.0.0.jar"
}
]
}

/lifecycle/{version}/runtimeCreateForm

このリソースは、ランタイムの登録に必要な情報を記述します。

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

- GET

GET

このリソースのGETメソッドは、ランタイム用の空のフォームを返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、ランタイムの登録時に指定する必要があるフィールドに関する情報を含むRuntimeエンティティが含まれます。

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

- uri=/runtimes rel=/runtimes

レスポンス・コード

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

例

例1   ランタイム作成フォームの取得

この例では、GETメソッドを使用してランタイム作成フォームを取得します。

リクエストの例

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/runtimeCreateForm

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"name": null,
"properties": [],
"type": null,
"port": null,
"hostName": null,
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimeCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimeCreateForm"
},
{
"rel": "runtimes",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes"
}
]
}

/lifecycle/{version}/runtimes

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

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

- GET

- POST

GET

このリソースのGETメソッドは、ランタイムのリストを返します。

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   ランタイムのリストの表示

この例では、GETメソッドを使用してランタイムのリストを表示します。

リクエストの例

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

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"items": [
{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
}
],
"name": "WLSRuntime",
"properties": [
{
"name": "password",
"value": "password"
},
{
"name": "username",
"value": "username"
}
],
"type": "wls",
"protocol": "http",
"port": "7001",
"hostName": "localhost"
}
],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimeCreateForm"
}
]
}

POST

POSTメソッドは、ランタイムを登録します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   ランタイムの登録

この例では、POSTメソッドを使用してランタイムを登録します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"name": "WLSRuntime", "type": "wls",  "protocol": "http", "hostName": "localhost", "port": "7001", "properties": [{"name": "username", "value": "username"}, {"name": "password", "confidentialValue": "password"}]}'
-X POST http://localhost:7001/management/lifecycle/latest/runtimes

レスポンスの例

HTTP/1.1 201 Created

Location: http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime

Response Body:
{}

/lifecycle/{version}/runtimes/{runtime-name}

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

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

- 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/lifecycle/latest/runtimes/WLSRuntime

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

GET

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

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   ランタイム情報の表示

この例では、GETメソッドを使用して特定のランタイムに関する情報を表示します。

リクエストの例

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

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"name": "WLSRuntime",
"properties": [
{
"name": "password",
"confidentialValue": "@_Oracle_Confidential_Property_Set_V1.1_#"
},
{
"name": "username",
"value": "username"
}
],
"type": "wls",
"protocol": "http",
"port": "7001",
"hostName": "localhost",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "partitionCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitionCreateForm"
},
{
"rel": "partitions",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions"
}
]
}

POST

POSTメソッドは、リソースURLで識別されるランタイムを更新します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   ランタイムの更新

この例では、POSTメソッドを使用して特定のランタイムを更新します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"hostName": "localhost", "port": "7001", "properties": [{"name": "username", "value": "username"}, {"name": "password", "value": "password"}]}'
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

/lifecycle/{version}/runtimes/{runtime-name}/partitionCreateForm

このリソースは、パーティションの作成に必要な情報を記述します。

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

- GET

GET

このリソースのGETメソッドは、パーティション用の空のフォームを返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、パーティションの作成時に指定する必要があるフィールドに関する情報を含むRuntimePartitionエンティティが含まれます。

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

- uri=/partitions rel=/partitions

レスポンス・コード

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

例

例1   パーティション作成フォームの取得

この例では、GETメソッドを使用してパーティション作成フォームを取得します。

リクエストの例

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/partitionCreateForm

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"name": null,
"properties": [],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitionCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitionCreateForm"
},
{
"rel": "partitions",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions"
}
]
}

/lifecycle/{version}/runtimes/{runtime-name}/partitions

このリソースは、ランタイム・パーティションを管理します。

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

- DELETE

- GET

- POST

DELETE

DELETEメソッドは、名前で識別されるパーティションの登録を解除します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   パーティションの登録解除

この例では、DELETEメソッドを使用してパーティションの登録を解除します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X DELETE http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/partitions?name=SpritePartition

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

GET

このリソースのGETメソッドは、リソースURLによって識別されるランタイムのパーティションのリストを返します。

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   パーティションのリストの表示

この例では、GETメソッドを使用して特定のランタイムのパーティションのリストを表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSTestRuntime/partitions

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"items": [{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
}
],
"name": "SpritePartition",
"id": "429aaa5a-058d-452d-b256-ce874d6e8583"
}],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitionCreateForm"
}
]
}

POST

POSTメソッドは、リソースURLで識別されるランタイムでパーティションを作成または登録します。モデル・プロパティでパーティションIDが渡されている場合、パーティションが登録されます。それ以外の場合は、作成されます。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   ランタイムにおけるパーティションの作成

この例では、POSTメソッドを使用してランタイムにパーティションを作成します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"name":"SpritePartition",
"properties" : [
{ "name" : "resourceGroups",
"properties" : [
{ "name" : "g1",
"properties" : [
{ "name" : "useDefaultTarget", "value" : "false" },
{ "name" : "resourceGroupTemplate", "value" : "template1" },
{ "name" : "targets" , "values" : ["VirtualHost-0"]}]}]},
{"name" : "availableTargets" , "values" : ["VirtualHost-0"]}]}' \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/partitions

レスポンスの例

HTTP/1.1 201 Created

Location: http://localhost:7001/management/lifecycle/latest/runtimes/WLSTestRuntime/partitions/SpritePartition

Response Body:
{}

例2   ランタイムにおける既存のパーティションの登録

この例では、POSTメソッドを使用してランタイムに既存のパーティションを登録します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"name":"SpritePartition",
"id":"4f138249-5e6b-40fe-9c42-a675f027cd9b"}' \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/partitions

レスポンスの例

HTTP/1.1 201 Created

Location: http://localhost:7001/management/lifecycle/latest/runtimes/WLSTestRuntime/partitions/SpritePartition

Response Body:
{}

/lifecycle/{version}/runtimes/{runtime-name}/partitions/{partition-name}

このリソースは、ランタイム・パーティションを管理します。

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

- 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/lifecycle/latest/runtimes/WLSRuntime/partitions/SpritePartition

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

GET

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

ロール

管理者

レスポンス本文

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

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

- uri=/lifecycle/{version}/environments/{environment-name}/partitions/{partition-name} rel=environment

- uri=/lifecycle/{version}/tenants/{tenant-name} rel=tenant

レスポンス・コード

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

例

例1   パーティションの表示

この例では、GETメソッドを使用して特定のパーティションに関する情報を表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSTestRuntime/partitions/SpritePartition

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"name": "SpritePartition",
"id": "429aaa5a-058d-452d-b256-ce874d6e8583",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/partitions\/SpritePartition"
},
{
"rel": "environment",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/environments\/srpite",
"title": "name"
}
]
}

POST

POSTメソッドは、リソースURLで識別されるパーティションを更新します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   パーティションの更新

この例では、POSTメソッドを使用して特定のパーティションを更新します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d "{"properties" : [
{ "name" : "resourceGroups",
"properties" : [
{ "name" : "g1",
"properties" : [
{ "name" : "useDefaultTarget", "value" : "false" }
]}
]}
]}" \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/partitions/SpritePartition

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

/lifecycle/{version}/runtimes/{runtime-name}/quiesce

このリソースは、ランタイムを静止します。

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

- POST

POST

POSTメソッドは、指定したランタイムに対して静止処理を実行します。

ロール

管理者

レスポンス本文

返されるレスポンス本文には、対応するタスク・リソースへのリンクが含まれます。

レスポンス・コード

このメソッドは、標準のHTTPレスポンス・コード、ステータス・コードを返します。

例

例1   ランタイムの静止

この例では、POSTメソッドを使用してランタイムを静止します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"phase": "", "properties" : [{"name": "managedserver", "value": "managedserver"}]}' \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/quiesce

レスポンスの例

HTTP/1.1 202 Accepted

Response Body:
{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/quiesce\/task\/managedserver\/_0_shutdown"
}]}

/lifecycle/{version}/runtimes/{runtime-name}/quiesce/task/{server-name}/{task-name}

このリソースは、ランタイム静止タスクを管理します。

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

- DELETE

- GET

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/lifecycle/latest/runtimes/WLSRuntime/quiesce/task/managedserver/_0_shutdown

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

GET

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

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   タスク・ステータスの表示

この例では、GETメソッドを使用して特定のタスクに関する情報を表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/quiesce/task/managedserver/_0_shutdown

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"status": "TASK COMPLETED",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/start\/task\/managedserver\/_0_shutdown"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/start\/task\/managedserver\/_0_shutdown"
}
]
}

/lifecycle/{version}/runtimes/{runtime-name}/scaleDown

このリソースは、ランタイムのスケール・ダウンに使用されます。

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

- POST

POST

POSTメソッドは、指定したランタイムに対してスケール・ダウン処理を実行します。ランタイムをスケール・ダウンすると、ランタイムに関連付けられたオリジン・サーバーがオリジン・サーバー・プールから削除されます。

ロール

管理者

レスポンス本文

返されるレスポンス本文には、対応するタスク・リソースへのリンクが含まれます。

レスポンス・コード

このメソッドは、標準のHTTPレスポンス・コード、ステータス・コードを返します。

例

例1   ランタイムのスケール・ダウン

この例では、POSTメソッドを使用してランタイムをスケール・ダウンします。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"scaleFactor": "2", "properties" : [{"name": "cluster-name", "value" : "wls_cluster"]}' \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/scaleDown

レスポンスの例

HTTP/1.1 202 Accepted

Response Body:
{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management/lifecycle\/latest\/runtimes\/WLSRuntime\/scaleDown\/task\/wls-cluster\/ScaleDown_2"
}]}

/lifecycle/{version}/runtimes/{runtime-name}/scaleUp

このリソースは、ランタイムのスケール・アップに使用されます。

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

- POST

POST

POSTメソッドは、指定したランタイムに対してスケール・アップ処理を実行します。ランタイムをスケール・アップすると、Oracle Traffic Directorにより新規オリジン・サーバーが作成され、既存のオリジン・サーバー・プールに追加されます。

ロール

管理者

レスポンス本文

返されるレスポンス本文には、対応するタスク・リソースへのリンクが含まれます。

レスポンス・コード

このメソッドは、標準のHTTPレスポンス・コード、ステータス・コードを返します。

例

例1   ランタイムのスケール・アップ

この例では、POSTメソッドを使用してランタイムをスケール・アップします。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"scaleFactor": "2", "properties" : [{"name": "cluster-name", "value" : "wls_cluster"]}' \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/scaleUp

レスポンスの例

HTTP/1.1 202 Accepted

Response Body:
{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/scaleUp\/task\/wls-cluster\/ScaleUp_1"
}]}

/lifecycle/{version}/runtimes/{runtime-name}/scaleUp/task/{cluster-name}/{task-name}

このリソースは、スケール・アップ済タスクを管理します。

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

- DELETE

- GET

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/lifecycle/latest/runtimes/WLSRuntime/scaleUp/task/wls-cluster/ScaleUp_1

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

GET

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

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   タスク・ステータスの表示

この例では、GETメソッドを使用して特定のタスクに関するステータス情報を表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/ScaleUp/task/wls-cluster/ScaleUp_1

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"status": "TASK COMPLETED",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/scaleDown\/task\/wls-cluster\/ScaleUp_1"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/scaleDown\/task\/wls-cluster\/ScaleUp_1"
}
]
}

/lifecycle/{version}/runtimes/{runtime-name}/start

このリソースは、ランタイムの起動に使用されます。

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

- POST

POST

POSTメソッドは、指定したランタイムに対して起動処理を実行します。

ロール

管理者

レスポンス本文

返されるレスポンス本文には、対応するタスク・リソースへのリンクが含まれます。

レスポンス・コード

このメソッドは、標準のHTTPレスポンス・コード、ステータス・コードを返します。

例

例1   ランタイムの起動

この例では、POSTメソッドを使用してランタイムを起動します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"phase": "", "properties" : [{"name": "managedserver", "value": "managedserver"}]}' \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/start

レスポンスの例

HTTP/1.1 202 Accepted

Response Body:
{"links": [{
"rel": "task",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/start\/task\/managedserver\/_1_start"
}]}

/lifecycle/{version}/runtimes/{runtime-name}/start/task/{server-name}/{task-name}

このリソースは、スケール・アップ済タスクを管理します。

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

- DELETE

- GET

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/lifecycle/latest/runtimes/WLSRuntime/start/task/managedserver/_1_start

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

GET

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

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   タスクのステータスの表示

この例では、GETメソッドを使用して特定のタスクに関する情報を表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/start/task/managedserver/_1_start

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"status": "TASK COMPLETED",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/start\/task\/managedserver\/_1_start"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime\/start\/task\/managedserver\/_1_start"
}
]
}

/lifecycle/{version}/runtimes/{runtime-name}/sync

このリソースは、環境を同期します。

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

- POST

POST

POSTメソッドは、ランタイムを同期します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   ランタイムの同期

この例では、POSTメソッドを使用してランタイムを同期します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '' \
-X POST http://localhost:7001/management/lifecycle/latest/runtimes/WLSRuntime/sync

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

/lifecycle/{version}/sync

このリソースは、すべての環境を同期します。

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

- POST

POST

POSTメソッドは、すべての環境を同期するか、定期的な同期を構成します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   すべての環境を同期します。

すべての環境を同期します。この例では、POSTメソッドを使用してすべての環境を同期します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '' \
-X POST http://localhost:7001/management/lifecycle/latest/sync

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

例2   すべての環境の定期的な同期を構成します。

すべての環境の定期的な同期を構成します。この例では、POSTメソッドを使用してすべての環境の定期的な同期を構成します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{
"sync": "true",
"syncInterval": "1"}' \
-X POST http://localhost:7001/management/lifecycle/latest/sync

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

/lifecycle/{version}/tenantCreateForm

このリソースは、テナントの登録に必要な情報を記述します。

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

- GET

GET

ロール

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

レスポンス本文

返されるレスポンス本文には、テナントの登録時に指定する必要があるフィールドに関する情報を含むTenantエンティティが含まれます。

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

- uri=/tenants rel=/tenants
このリソースのGETメソッドは、テナント用の空のフォームを返します。

レスポンス・コード

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

例

例1   作成フォームの取得

この例では、GETメソッドを使用してテナント作成フォームを取得します。

リクエストの例

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/tenantCreateForm

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"topLevelDir": null,
"name": null,
"id": null,
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenantCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenantCreateForm"
},
{
"rel": "tenants",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants"
}
]
}

/lifecycle/{version}/tenants

このリソースは、テナントを管理します。

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

- GET

- POST

GET

このリソースのGETメソッドは、テナントのリストを返します。

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   テナントの表示

この例では、GETメソッドを使用してテナントを表示します。

リクエストの例

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

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"items": [{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/lifecycle\/latest\/tenants\/Sprite"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/lifecycle\/latest\/tenants\/Sprite"
}
],
"topLevelDir": "Sprite\/top\/level\/dir",
"name": "Sprite",
"id": "123"
}],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/lifecycle\/latest\/tenants"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/lifecycle\/latest\/tenants"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/lifecycle\/latest\/tenantCreateForm"
}
]
}

POST

POSTメソッドは、テナントを登録します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   テナントの登録

この例では、POSTメソッドを使用してテナントを登録します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"uuid" : "55ec0a13-7152-4040-8352-ad1e7726bad9", "name" : "Sprite", "topLevelDir": "Sprite/top/level/dir" }' \
-X POST http://localhost:7001/lifecycle/latest/tenants

レスポンスの例

HTTP/1.1 201 Created

Location: http://localhost:7001/lifecycle/latest/tenants/Sprite

Response Body:
{}

/lifecycle/{version}/tenants/{tenant-name}

このリソースは、テナントを管理します。

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

- 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/lifecycle/latest/tenants/Sprite

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

GET

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

ロール

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

レスポンス本文

返されるレスポンス本文には、指定したテナントに関する情報を含むTenantエンティティが含まれます。

レスポンス・コード

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

例

例1   テナントの表示

この例では、GETメソッドを使用して特定のテナントに関する情報を表示します。

リクエストの例

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

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"topLevelDir": "Sprite\/top\/level\/dir",
"name": "Sprite",
"id": "123",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite"
},
{
"rel": "serviceCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/serviceCreateForm"
},
{
"rel": "services",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/services"
}
]
}

POST

POSTメソッドは、リソースURLで識別されるテナントを更新します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   テナントの更新

この例では、POSTメソッドを使用して特定のテナントを更新します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"topLevelDir": "Sprite/top/level/dir" }' \
-X POST http://localhost:7001/management/lifecycle/latest/tenants/Sprite

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

/lifecycle/{version}/tenants/{tenant-name}/serviceCreateForm

このリソースは、サービスへのテナントのオンボードに必要な情報を記述します。

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

- GET

GET

ロール

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

レスポンス本文

返されるレスポンス本文には、テナントをサービスにオンボードする際に指定する必要があるフィールドに関する情報を含むServiceエンティティが含まれます。

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

- uri=/services rel=/services
このリソースのGETメソッドは、サービス用の空のフォームを返します。

レスポンス・コード

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

例

例1   作成フォームの取得

この例では、GETメソッドを使用してサービス作成フォームを取得します。

リクエストの例

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/tenants/sprite/serviceCreateForm

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"environmentRef": null,
"name": null,
"type": null,
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/serviceCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/serviceCreateForm"
},
{
"rel": "services",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/services"
}
]
}

/lifecycle/{version}/tenants/{tenant-name}/services

このリソースは、テナントのサービスを管理します。

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

- GET

- POST

GET

このリソースのGETメソッドは、リソースURLで識別されるテナントのサービスのリストを返します。

ロール

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

レスポンス本文

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

レスポンス・コード

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

例

例1   サービスの表示

この例では、GETメソッドを使用してテナントのサービスを表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"items": [{
"links": [
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite"
}
],
"topLevelDir": "Sprite\/top\/level\/dir",
"name": "Sprite",
"id": "123"
}],
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenantCreateForm"
}
]
}

POST

POSTメソッドは、テナントをサービスにオンボードします。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   テナントのオンボード

この例では、POSTメソッドを使用してテナントをサービスにオンボードします。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"uuid" : "30ec0a13-7102-4040-8352-ad1e7726bad9", "name" : "HCMProd", "type" : "HCMService", "environmentRef" : "sprite", "topLevelDir": "sprite/top/level/dir"}' \
-X POST http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services

レスポンスの例

HTTP/1.1 201 Created

Location: http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd

Response Body:
{}

/lifecycle/{version}/tenants/{tenant-name}/services/{service-name}

このリソースは、テナントのサービスを管理します。

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

- DELETE

- GET

- POST

DELETE

DELETEメソッドは、テナントのサービスを削除します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   サービスの削除

この例では、DELETEメソッドを使用してテナントのサービスを削除します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X DELETE http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

GET

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

ロール

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

レスポンス本文

返されるレスポンス本文には、指定したサービスに関する情報を含むServiceエンティティが含まれます。

レスポンス・コード

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

例

例1   サービスの表示

この例では、GETメソッドを使用して特定のサービスに関する情報を表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"uuid": "30ec0a13-7102-4040-8352-ad1e7726bad9",
"topLevelDir": "sprite\/top\/level\/dir",
"environmentRef": "sprite",
"name": "HCMProd",
"type": "HCMService",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd"
},
{
"rel": "PDBCreateForm",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd\/PDBCreateForm"
},
{
"rel": "PDB",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd\/PDB"
}
]
}

POST

POSTメソッドは、リソースURLで識別されるサービスを更新します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   サービスの更新

この例では、POSTメソッドを使用して特定のサービスを更新します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-H Content-Type:application/json \
-d '{"topLevelDir": "sprite/top/level/dir"}' \
-X POST http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

/lifecycle/{version}/tenants/{tenant-name}/services/{service-name}/PDB

このリソースは、サービスのPDBを管理します。

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

- DELETE

- GET

- POST

DELETE

DELETEメソッドは、リソースURLで識別されるサービスからPDBを削除します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   サービスからのPDBの削除

この例では、DELETEメソッドを使用して指定のサービスからPDBを削除します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X DELETE http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd/PDB

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{}

GET

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

ロール

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

レスポンス本文

返されるレスポンス本文には、指定したサービスに関する情報を含むPDBエンティティが含まれます。

レスポンス・コード

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

例

例1   PDB情報の表示

この例では、GETメソッドを使用して特定のサービスに関するPDB情報を表示します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd/PDB

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"status": "ACTIVE",
"name": "SpriteHCMPDBProd",
"id": "444",
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd\/PDB"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd\/PDB"
},
{
"rel": "create-form",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/Sprite\/services\/HCMProd\/PDBCreateForm"
}
]
}

POST

POSTメソッドは、リソースURLで識別されるサービスに対してPDBを追加します。

ロール

管理者

レスポンス本文

空のレスポンス本文が返されます。

レスポンス・コード

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

例

例1   サービスに対するPDBの追加

この例では、POSTメソッドを使用してサービスに対してPDBを追加します。

リクエストの例

curl -v \
--user username:password \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-d '{"name" : "spriteHCMPDBProd", "id" : "444", "status" : "ACTIVE"}' \
-X POST http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd/PDB

レスポンスの例

HTTP/1.1 201 Created

Location: http://localhost:7001/management/lifecycle/latest/tenants/Sprite/services/HCMProd/PDB

Response Body:
{}

/lifecycle/{version}/tenants/{tenant-name}/services/{service-name}/PDBCreateForm

このリソースは、サービスへのPDBの追加に必要な情報を記述します。

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

- GET

GET

ロール

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

レスポンス本文

返されるレスポンス本文には、サービスにPDBを追加する際に指定する必要があるフィールドに関する情報を含むPDBエンティティが含まれます。

レスポンス・コード

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

例

例1   作成フォームの取得

この例では、GETメソッドを使用してPDB作成フォームを取得します。

リクエストの例

curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/lifecycle/latest/tenants/sprite/services/CRMProd/PDBCreateForm

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
"status": "ACTIVE",
"name": null,
"id": null,
"links": [
{
"rel": "parent",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/services\/CRMProd"
},
{
"rel": "self",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/services\/CRMProd\/PDBCreateForm"
},
{
"rel": "canonical",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/services\/CRMProd\/PDBCreateForm"
},
{
"rel": "PDB",
"href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/tenants\/sprite\/services\/CRMProd\/PDB"
}
]
}

2 エンティティ

次の各項では、RESTリソースが動作するデータ・モデルについて説明します。これらのデータ・モデルは、RESTリソースでやりとりされる情報を記述したものです。

この項でのこれらのデータ・モデルの説明には、各データ・フィールドに適用される制約の説明が含まれます。

データ・フィールドの制約

コンフィデンシャル

この値が暗号化され、GETメソッドによって返されないことを指定します。更新するために、POSTで指定することは可能です。

不変

このフィールドの内容は、作成中に1回書込み可能であり、その後は変更できません。

Null以外

このフィールドに値を指定する必要があることを指定します。

読取り専用

この値は、GETによって読取り可能ですが、POST中は無視されることを指定します。

AssociatePartitions

AssociatePartitionsエンティティには、相互に関連付ける2つのパーティションの名前および任意のプロパティが含まれます。

AssociatePartitionsエンティティのプロパティは、次のとおりです。

partition1Name

関連付ける一方のパーティションの名前。

タイプ: string

partition1RuntimeName

関連付ける一方のパーティションのランタイム名。

タイプ: string

partition2Name

関連付ける他方のパーティションの名前。

タイプ: string

partition2RuntimeName

関連付ける他方のパーティションのランタイム名。

タイプ: string

properties

任意のプロパティ。jdbcSystemResourceプロパティおよびjdbcSystemResourceOverrideプロパティが含まれる場合があります。

タイプ: 配列

Deprovision

Deprovisionエンティティは、テナント・リソース(パーティション)、PDBおよびサービスの論理コンテナを表します。

Deprovisionエンティティのプロパティは、次のとおりです。

orchestration

オーケストレーションから環境を作成します。

タイプ: オーケストレーション

制約: 不変

DissociatePartitions

DissociatePartitionsエンティティには、関連付けを解除する2つのパーティションの名前および任意のプロパティが含まれます。

DissociatePartitionsエンティティのプロパティは、次のとおりです。

partition1Name

関連付けを解除する一方のパーティションの名前。

タイプ: string

partition1RuntimeName

関連付けを解除する一方のパーティションのランタイム名。

タイプ: string

partition2Name

関連付けを解除する他方のパーティションの名前。

タイプ: string

partition2RuntimeName

関連付けを解除する他方のパーティションのランタイム名。

タイプ: string

properties

任意のプロパティ。jdbcSystemResourceプロパティおよびjdbcSystemResourceOverrideプロパティが含まれる場合があります。

タイプ: 配列

Environment

Environmentエンティティには環境名が含まれ、テナント・リソース(パーティション)、PDBおよびサービスの論理コンテナを表します。

Environmentエンティティのプロパティは、次のとおりです。

name

環境の名前

タイプ: string

制約: 不変

orchestration

オーケストレーションから環境を作成します。

タイプ: オーケストレーション

制約: 不変

EnvironmentPartition

EnvironmentPartitionエンティティには、名前およびランタイム名が含まれ、環境に追加された論理パーティションを表します。

EnvironmentPartitionエンティティのプロパティは、次のとおりです。

name

パーティションの名前。

タイプ: string

制約: 不変

runtimeName

パーティションが存在するランタイムの名前。

タイプ: string

制約: 不変

MigratePartition

MigratePartitionエンティティには、ランタイム名、フェーズおよび任意のプロパティが含まれます。

MigratePartitionエンティティのプロパティは、次のとおりです。

phase

フェーズ。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

制約: 不変

runtimeName

パーティションが存在するランタイムの名前。

タイプ: string

制約: 不変

Orchestration

Orchestrationエンティティには、環境を作成するための名前および引数が含まれます。

Orchestrationエンティティのプロパティは、次のとおりです。

args

任意のプロパティ。ランタイムへの接続に必要なユーザー名およびパスワードが含まれる場合があります。

タイプ: 配列

name

環境の名前

タイプ: string

制約: 不変

PDB

PDBエンティティには、名前、ID、ステータスおよび作成日が含まれます。

PDBエンティティのプロパティは、次のとおりです。

creationDate

PDBの作成日。

タイプ: string

制約: 読取り専用

id

PDBのID。

タイプ: string

制約: 不変

name

PDBの名前。

タイプ: string

制約: 不変

status

PDBのステータス。(未使用。将来使用するために予約済)

タイプ: string

制約: 不変

Property

Propertyエンティティは名前付きプロパティを保持し、値には、文字列、機密文字列またはプロパティのリストを指定できます。

Propertyエンティティのプロパティは、次のとおりです。

confidentialValue

プロパティの機密文字列値。

タイプ: string

properties

プロパティのプロパティ値。

タイプ: 配列

制約: 不変

values

プロパティの文字列値。

タイプ: 配列

QuiescePartition

QuiescePartitionエンティティには、静止処理の任意のプロパティが含まれます。

QuiescePartitionエンティティのプロパティは、次のとおりです。

phase

フェーズ。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

QuiesceRuntime

QuiesceRuntimeエンティティには、静止処理のフェーズおよび任意のプロパティが含まれます。

QuiesceRuntimeエンティティのプロパティは、次のとおりです。

phase

フェーズ。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

RegisterPlugin

RegisterPluginエンティティには、サーバー・ファイル・システムにおけるJavaアーカイブの名前および相対パスが含まれます。

RegisterPluginエンティティのプロパティは、次のとおりです。

name

プラグインの名前。

タイプ: string

制約: 不変

path

プラグインが含まれるjarファイルの、サーバーに対して相対的なパス名。

タイプ: string

RestartPartition

RestartPartitionエンティティには、パーティションを再起動するための任意のプロパティが含まれます。

RestartPartitionエンティティのプロパティは、次のとおりです。

phase

フェーズ。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

Runtime

Runtimeエンティティには、物理ランタイムの名前、タイプ、ホストおよびポートが含まれます。また、任意のプロパティを含めることもできます。

Runtimeエンティティのプロパティは、次のとおりです。

hostName

ランタイムのホスト名。

タイプ: string

制約: 不変

name

ランタイムの名前。

タイプ: string

制約: 不変

port

ランタイムのポート。

タイプ: string

制約: 不変

properties

任意のプロパティ。ランタイムへの接続に必要なユーザー名およびパスワードが含まれる場合があります。

タイプ: 配列

制約: 不変

protocol

ランタイムのプロトコル。

タイプ: string

制約: 不変

type

ランタイムのタイプ。

タイプ: string

制約: 不変

RuntimePartition

RuntimePartitionsエンティティには、物理ランタイムのパーティションの名前およびIDが含まれます。また、任意のプロパティを含めることもできます。

RuntimePartitionエンティティのプロパティは、次のとおりです。

id

パーティションのID。

タイプ: string

制約: 読取り専用

name

パーティションの名前。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

type

パーティションのタイプ。(未使用。将来使用するために予約済)

タイプ: string

制約: 読取り専用

ScaleRuntime

ScaleRuntimeエンティティには、スケール変更処理の係数および任意のプロパティが含まれます。

ScaleRuntimeエンティティのプロパティは、次のとおりです。

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

scaleFactor

スケール係数の数値。

タイプ: string

制約: 不変

Service

Serviceエンティティには、環境の名前、タイプおよび環境への参照が含まれます。

Serviceエンティティのプロパティは、次のとおりです。

environmentRef

サービスの環境名。

タイプ: string

制約: 不変

identityDomain

サービスのアイデンティティ・ドメイン。

タイプ: string

制約: 不変

name

サービスの名前。

タイプ: string

制約: 不変

topLevelDir

サービスの最上位レベルのディレクトリ。

タイプ: string

twoTask

サービスの2つのタスク。

タイプ: string

type

サービスのタイプ。

タイプ: string

制約: 不変

uuid

サービスの汎用一意識別子。

タイプ: string

制約: 不変

StartPartition

StartPartitionエンティティには、処理を開始するための任意のプロパティが含まれます。

StartPartitionエンティティのプロパティは、次のとおりです。

phase

フェーズ。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

StartRuntime

StartRuntimeエンティティには、起動処理のフェーズおよび任意のプロパティが含まれます。

StartRuntimeエンティティのプロパティは、次のとおりです。

phase

フェーズ。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

Task

Taskエンティティには、タスクのステータスが含まれます。

Taskエンティティのプロパティは、次のとおりです。

error

タスク・エラー(ある場合)。

タイプ: string

制約: 読取り専用

progress

タスクの進捗。

タイプ: string

制約: 読取り専用

status

タスク・ステータス。

タイプ: string

制約: 読取り専用

Tenant

Tenantエンティティには、テナントの最上位レベルのディレクトリ、IDおよび名前が含まれます。

Tenantエンティティのプロパティは、次のとおりです。

id

テナントのID。

タイプ: string

制約: 不変

name

テナントの名前。

タイプ: string

制約: 不変

topLevelDir

テナントのパーティションにおける最上位レベルのディレクトリ。

タイプ: string

uuid

テナントの汎用一意識別子。

タイプ: string

制約: 不変

Version

Versionエンティティでは、ライフサイクル・リソースのバージョンが記述されます。

Versionエンティティのプロパティは、次のとおりです。

isLatest

これがデフォルト・バージョンの場合True。

タイプ: ブール

制約: 読取り専用

lifecycle

タイプ: string

state

このバージョンのライフサイクル: activeまたはdeprecated

タイプ: string

制約: 読取り専用

version

このバージョンの名前。

タイプ: string

制約: 読取り専用