Coherenceデータ層クラスタの追加
/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/clusters
サービス・インスタンスにすでにストレージ対応WebLogic Serverクラスタがある場合、ストレージ対応サーバーの別のクラスタを追加することはできません。
Coherenceデータ層クラスタに作成される管理対象Coherence Serverの初期セットは、サービス・インスタンスに宣言される容量単位の構成と、リクエスト本文で定義されるscalingUnitCountプロパティに基づきます。
注意: REST APIで使用されるスケーリング・ユニットという語は、容量単位と同じ意味です。
リクエスト
- application/vnd.com.oracle.oracloud.datagrid.Service+json
- identityDomainId
-
型:
string
必須:true
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
- serviceId
型:string
必須:true
Coherenceデータ層の追加先のOracle Java Cloud Service-Coherenceインスタンスの名前。
- X-ID-TENANT-NAME
-
型:
string
必須:true
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
- clusterName
-
型:
string
サービス・インスタンス用に追加するためのストレージ対応WebLogic Serverクラスタの名前。 クラスタ名:- 50文字を超えることはできません。
- 文字で始まる必要があります。
- アルファベット文字、下線(_)、またはダッシュ(-)のみ使用できます。
- それ以外の特殊文字を含むことはできません。
- WebLogic Server管理ドメイン内で一意である必要があります。
クラスタ名が空またはNULLの場合、名前はOracle Java Cloud Serviceインスタンス名の最初の8文字から、
first8charsOfServiceInstanceName_DGCluster
の形式を使用して生成されます。 例:ExampleI_DGCluster
- clusterType
-
型:
string
必須:true
Coherenceデータ層クラスタを追加するには、DG
に設定する必要があります。 - scalingUnit
-
型:
object
scalingUnit必須:true
カスタム(または高度な)容量単位の場合のみ必要です。容量単位定義の詳細をグループ化します。
Oracle Public Cloudでのカスタム容量単位のプロパティの定義に関するガイドラインは、『Oracle Cloud Oracle Java Cloud Serviceの使用』のOracle Java Cloud Service-Coherenceインスタンスのカスタム容量単位と高度な構成についての項を参照してください。 Oracle Cloud Machineの場合、OPCMでのOracle Java Cloud Serviceの使用のOracle Java Cloud Service-Coherenceインスタンスのカスタム容量単位と高度な構成に関する項を参照してください。
- scalingUnitCount
-
型:
string
必須:true
追加する容量単位の数。 この値に0(ゼロ)を指定することはできません。各容量単位はCoherenceに割り当てる固定量のプライマリ・キャッシュ記憶域を示し、VMコンピューティング・シェイプ、JVMの数、各JVMのヒープ・サイズに関する容量単位の事前定義プロパティに基づきます。
- scalingUnitName
-
型:
string
必須:true
デフォルトの容量単位の場合のみ必要です。有効な名前には次のものがあります:
BASIC
SMALL
MEDIUM
LARGE
それぞれのデフォルト容量単位は、VMのグループと事前定義されたコンピューティング・シェイプ(処理能力とRAM)、実行中のJVMまたは管理対象Coherence Serverで構成され、事前構成のプライマリ・キャッシュ・サイズを指定します。 Coherenceに割り当てるプライマリ・キャッシュ記憶域の量は、一般的にJVMヒープ・サイズを3つに分割するルールに基づき、プライマリ・キャッシュ記憶域、バックアップ記憶域およびスクラッチ領域にそれぞれ1/3ずつ使用されます。
Oracle Public Cloudでどのデフォルト構成を使用するかを決定するには、『Oracle Java Cloud Serviceの使用』のOracle Java Cloud Service-Coherenceインスタンスのデフォルト容量単位に関する項を参照してください。 Oracle Cloud Machineの場合、OPCMでのOracle Java Cloud Serviceの使用のOracle Java Cloud Service-Coherenceインスタンスのデフォルト容量単位に関する項を参照してください。
object
容量単位定義の詳細をグループ化します。
Oracle Public Cloudでのカスタム容量単位のプロパティの定義に関するガイドラインは、『Oracle Cloud Oracle Java Cloud Serviceの使用』のOracle Java Cloud Service-Coherenceインスタンスのカスタム容量単位と高度な構成についての項を参照してください。 Oracle Cloud Machineの場合、OPCMでのOracle Java Cloud Serviceの使用のOracle Java Cloud Service-Coherenceインスタンスのカスタム容量単位と高度な構成に関する項を参照してください。
- heapSize
-
型:
string
必須:true
カスタム(または高度な)容量単位の場合のみ必要です。容量単位でJVMごとに構成するヒープ・サイズ。
1GBから16GBまでの数値を使用します。 VM別にJVMの数を乗算したJVMヒープ・サイズは、VMのコンピューティング・シェイプに利用可能なRAMから1500 MB (操作用に予約)を差し引いた数を超えることはできません。
Coherenceに割り当てるプライマリ・キャッシュ記憶域の合計量は、一般的にJVMヒープ・サイズを3つに分割するルールに基づき、プライマリ・キャッシュ記憶域、バックアップ記憶域およびスクラッチ領域にそれぞれ1/3ずつ使用されます。
カスタム容量単位が単一のVMで構成される場合、Coherenceデータのバックアップ・コピーを格納する領域がないため、実際の使用可能なデータは、JVMヒープ・サイズの1/3以上になります。
- jvmCount
-
型:
integer
必須:true
カスタム(または高度な)容量単位の場合のみ必要です。各VMで起動するJVMの数。
1から8までの数値を使用します。
- shape
-
型:
string
必須:true
カスタム(または高度な)容量単位の場合のみ必要です。カスタム容量単位ですべてのVMに使用するコンピューティング・シェイプ。 たとえば、
oc3
などです。 シェイプでは、Oracle Compute Unit (OCPU)の数およびメモリー量(RAM)を定義します。有効なシェイプは次のとおりです。
- oc3: 1つのOCPU、7.5GBのメモリー
- oc4: 2つのOCPU、15GBのメモリー
- oc5: 4つのOCPU、30GBのメモリー
- oc6: 8つのOCPU、60GBのメモリー
- oc7: 16個のOCPU、120GBのメモリー
- oc1m: 1つのOCPU、15GBのメモリー
- oc2m: 2つのOCPU、30GBのメモリー
- oc3m: 4つのOCPU、60GBのメモリー
- oc4m: 8つのOCPU、120GBのメモリー
- oc5m: 16個のOCPU、240GBのメモリー
Oracle Public Cloudでのシェイプの詳細は、『Oracle Compute Cloud Serviceの使用 (for PaaS)』のマシン・イメージとシェイプに関する項を参照してください。
- vmCount
-
型:
integer
必須:true
カスタム(または高度な)容量単位の場合のみ必要です。カスタム容量単位ごとに構成するVMの数。 1から3までの数値を使用します。 3台のVMを使用するとCoherence高可用性が実現します。
レスポンス
- サービス・インスタンスの状態がRunning以外の場合。 Oracle Java Cloud Serviceは、実施する操作のジョブを作成する前に、サービス・インスタンスがRunning状態であることを確認します。 この場合、
Service is not in Running state, current state is [Current Operation State]. The service needs to be in a Running state for datagrid operations to be carried out
というメッセージが返されます - 2つ目のリクエストが受信された場合。
- プロビジョニングされたサービス・インスタンスのサービス・レベルは、Oracle Java Cloud Service-Virtual ImageまたはBASICです。 次のメッセージが返されます:
JAAS-SCALING-032: サービス[サービス・インスタンス名]をスケーリングできません。スケーリングをサポートする最小サービス・レベルは[PAAS]ですが、サービス・レベルは[BASIC]です
例
次の例では、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによってOracle Java Cloud Serviceインスタンスのデータ層クラスタの追加リクエストを開始する方法を示しています。
注意: この例のコマンドでは、URL構造https://rest_server_url/resource-pathが使用されています。ここで、rest_server_urlはアイデンティティ・ドメインまたはテナント名を問い合せるためのOracle Public CloudまたはOracle Cloud MachineのRESTサーバーです。 Oracle Public CloudまたはOracle Cloud Machineに使用する適切なURL構造の詳細は、リクエストの送信を参照してください。
cURLコマンド
curl -i -X POST -u username:userPassword1! -d @adddatagridcluster.json -H "Content-Type:application/vnd.com.oracle.oracloud.datagrid.Service+json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance/clusters
リクエスト本文の例(デフォルト容量単位)
次に、デフォルト容量単位定義を使用してCoherenceデータ層クラスタを追加する場合のJSON形式のリクエスト本文に関する例を示します。
{ "clusterType" : "DG", "scalingUnitCount" : "1", "clusterName" : "ExampleDGCluster", "scalingUnitName" : "SMALL" }
リクエスト本文の例(カスタムまたは高度な容量単位)
次に、カスタム容量単位定義を使用してCoherenceデータ層クラスタを追加する場合のJSON形式のリクエスト本文に関する例を示します。
{ "clusterType" : "DG", "scalingUnitCount" : "1", "clusterName" : "ExampleDGCluster", "scalingUnit" : { "shape" : "oc3", "vmCount" : "3", "heapSize" : "4G", "jvmCount" : "2" } }
レスポンス・ヘッダーの例
次にレスポンス・ヘッダーの例を示します。
Locationヘッダーは、データ層クラスタの追加リクエストのステータスにアクセスする際に使用できるRESTリソースを返します。 詳細は、「サービス・インスタンス・ライフサイクル操作のステータスの表示」を参照してください。
HTTP/1.1 202 Accepted Date: Tue, 06 Oct 2015 19:52:23 GMT Location: https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/status/scale/job/536 Content-Length: 0 Content-Type: application/vnd.com.oracle.oracloud.datagrid.Service+json Service-URI: https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance/clusters/ExampleDGCluster
レスポンス本文の例(ステータスの表示)
次に、データ層クラスタの追加リクエストのステータスを確認する場合のレスポンス本文の例を示します。
{ "service_name": "ExampleInstance", "version": "12cR3", "wlsVersion": "12.1.3.0.160419", "status": "Running", "error_status_desc": "", "compliance_status": "", "compliance_status_desc": "", "auto_update": "true", "description": "ExampleInstance", "identity_domain": "ExampleIdentityDomain", "creation_time": "Tue Oct 6 16:24:8 UTC 2015", "last_modified_time": "Tue Oct 6 16:24:6 UTC 2015", "created_by": "username", "service_uri": "https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/ExampleIdentityDomain\/ExampleInstance", "message": [ "Successfully created DataGrid option", " Successfully created cluster [ExampleDGCluster] for DataGrid option", " Successfully created managed servers in cluster [ExampleDGCluster]...", " Successfully created capacity unit(s)...", " Starting capacity unit...", " Successfully started capacity unit...", " Starting to transfer keys to the datagrid VMs", " Finished transferring keys to datagrid VMs", " Successfully transferred keys to [exampleinstance-wls-5]", " Successfully transferred keys to [exampleinstance-wls-3]", " Successfully transferred keys to [exampleinstance-wls-4]", " Checking managed servers...", " Successfully checked managed servers...", " Performing Service Reachability Check (SRC) of Datagrid Managed Servers.", " Successfully completed Service Reachability Check (SRC) of Datagrid Managed Servers.", " Successfully created capacity unit(s)...", " Successfully created capacity unit(s)...", " Configuration check for Host [exampleinstance-wls-3] containing WebLogic Managed Server(s) [[ExampleI_server_3_DG]] completed...", " Configuration check for Host [exampleinstance-wls-4] containing WebLogic Managed Server(s) [[ExampleI_server_4_DG]] completed...", " Configuration check for Host [exampleinstance-wls-5] containing WebLogic Managed Server(s) [[ExampleI_server_5_DG]] completed...", " Service Reachabilty Check (SRC) of WebLogic Administration Server completed...", " Service Reachabilty Check (SRC) of WebLogic Managed Server(s) [ExampleI_server_1, ExampleI_server_2, ExampleI_server_3_DG, ExampleI_server_4_DG, ExampleI_server_5_DG] completed..." ] }