プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle WebLogic Server RESTfulライフサイクル・リファレンス
12c (12.2.1.3.0)
E91993-01
  目次へ移動
目次
前
前 		 次
次		  

1 リソース

このドキュメントでは、Oracle WebLogic Server RESTfulライフ・サイクル管理リソースについて説明します。

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

/lifecycle

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

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

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": false,
        "lifecycle": "deprecated"
    },
    {
        "links": [
            {
                "rel": "canonical",
                "href": "http:\/\/localhost:7001\/management\/lifecycle\/12.2.1.3.0"
            },
            {
                "rel": "self",
                "href": "http:\/\/localhost:7001\/management\/lifecycle\/12.2.1.3.0"
            }
        ],
        "version": "12.2.1.3.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.3.0"
        }
    ]
}

/lifecycle/{version}

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

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

GET

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

ロール

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

レスポンス本文

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

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

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

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

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

  • uri=/lifecycle/{version}/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

レスポンスの例

HTTP/1.1 200 OK

Response Body:
{
    "version": "12.2.1.3.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"
        }
     ]
}

/lifecycle/{version}/environmentCreateForm

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

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

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

このリソースの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メソッドは、環境を作成します。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入されたEnvironmentエンティティが含まれている必要があります。

レスポンス本文

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

レスポンス・コード

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

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メソッドは、2つの環境パーティションを相互に関連付けます。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入されたAssociatePartitionsエンティティが含まれている必要があります。

レスポンス本文

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

レスポンス・コード

このメソッドは、標準の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メソッドは、指定した環境内のパーティションをプロビジョニング解除および関連付け解除します。指定した環境はその後削除されます。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入されたDeprovisionエンティティが含まれている必要があります。

レスポンス本文

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

レスポンス・コード

このメソッドは、標準の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メソッドは、2つのパーティションの関連付けを解除します。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入されたDissociatePartitionsエンティティが含まれている必要があります。

レスポンス本文

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

レスポンス・コード

このメソッドは、標準の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メソッドは、パーティション用の空のフォームを返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、環境にパーティションを追加する際に指定する必要があるフィールドに関する情報を含む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

このリソースの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で識別される環境にパーティションを追加します。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入されたEnvironmentPartitionエンティティが含まれている必要があります。

レスポンス本文

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

レスポンス・コード

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

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}/runtimeCreateForm

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

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

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

このリソースの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メソッドは、ランタイムを登録します。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入されたRuntimeエンティティが含まれている必要があります。

レスポンス本文

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

レスポンス・コード

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

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で識別されるランタイムを更新します。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入されたRuntimeエンティティが含まれている必要があります。

レスポンス本文

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

レスポンス・コード

このメソッドは、標準の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メソッドは、パーティション用の空のフォームを返します。

ロール

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

レスポンス本文

返されるレスポンス本文には、パーティションの作成時に指定する必要があるフィールドに関する情報を含む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

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が渡されている場合、パーティションが登録されます。それ以外の場合は、作成されます。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入されたRuntimePartitionエンティティが含まれている必要があります。

レスポンス本文

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

レスポンス・コード

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

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で識別されるパーティションを更新します。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入されたRuntimePartitionエンティティが含まれている必要があります。

レスポンス本文

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

レスポンス・コード

このメソッドは、標準の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}/tenantCreateForm

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

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

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

このリソースの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メソッドは、テナントを登録します。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入されたTenantエンティティが含まれている必要があります。

レスポンス本文

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

レスポンス・コード

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

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で識別されるテナントを更新します。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入されたTenantエンティティが含まれている必要があります。

レスポンス本文

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

レスポンス・コード

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

ロール

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

レスポンス本文

返されるレスポンス本文には、テナントをサービスにオンボードする際に指定する必要があるフィールドに関する情報を含む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

このリソースの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メソッドは、テナントをサービスにオンボードします。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入されたServiceエンティティが含まれている必要があります。

レスポンス本文

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

レスポンス・コード

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

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で識別されるサービスを更新します。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入されたServiceエンティティが含まれている必要があります。

レスポンス本文

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

レスポンス・コード

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

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を追加します。

ロール

管理者

リクエスト本文

リクエスト本文には、完全に移入された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

ロール

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

レスポンス本文

返されるレスポンス本文には、サービスに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"
        }
    ]
}
  前
前 		 次
次
  目次へ移動
目次