Oracle Java Cloud Service REST API

Coherenceデータ層のスケーリング

put

/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/clusters/{clusterName}

リクエストされた容量単位の数および現在の容量単位の数に基づき、スケール・アウトまたはスケール・インのいずれかを行い、Oracle Java Cloud ServiceインスタンスのCoherenceデータ層クラスタまたはストレージ対応WebLogic Serverクラスタをスケーリングします。一度に1つの容量単位分のみスケール・アウトできることに注意してください。

サービス・インスタンスのCoherenceデータ層は、アプリケーション層に関係なくスケーリングされます。 Coherenceデータ層のスケーリングでは、特定の数の容量単位が追加または削除されます。

スケーリング操作で追加または削除するVMおよび管理対象サーバーの数は、Coherenceデータ層の作成時にサービスに宣言された容量単位定義によって事前に決められます。 Coherenceデータ層をスケーリングするときに容量単位定義を変更することはできません。

Oracle Public Cloudの場合、Coherenceデータ層のスケーリングの詳細は、『Oracle Cloud Oracle Java Cloud Serviceの使用』でOracle Java Cloud ServiceインスタンスのCoherenceデータ層をスケーリングする場合の考慮事項に関する項を参照してください。 Oracle Cloud Machineの場合、『OPCMでのOracle Java Cloud Serviceの使用』の「Oracle Java Cloud ServiceインスタンスのCoherenceデータ層をスケーリングするときの考慮事項」に関する項を参照してください。

注意: REST APIで使用されるスケーリング・ユニットという語は、容量単位と同じ意味です。

リクエスト

サポートされているメディア・タイプ

application/vnd.com.oracle.oracloud.datagrid.Service+json

パス・パラメータ

clusterName: 型: string

必須: true

スケーリングするサービス・インスタンス内のCoherenceデータ層クラスタの名前。
identityDomainId: 型: string

必須: true

Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。
Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
serviceId: 型: string

必須: true

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の場合)。

本文パラメータ

リクエスト本文では、Coherenceデータ層クラスタのスケール・リクエストの詳細を定義します。

ルート・スキーマ: datatier-putrequest

プロパティ

force: 型: boolean

スケール・イン操作中、容量単位の削除を強制するかどうかを指定するフラグ。この値のデフォルトはfalseです。スケーリング・プロセス中に失敗が発生した場合でも、スケール・イン操作で容量単位を削除する場合はtrueに設定します。
scalingUnitCount: 型: string

必須: true

Coherenceデータ層全体に対してリクエストされた容量単位の数。 0 (ゼロ)にはできません。
たとえば、現在の容量単位の数が1であり、JSONファイルの数を2と指定した場合、スケーリング操作によって容量単位を1つ追加するスケール・アウトが実行されます。現在の容量単位の数が2であり、JSONファイルの数を1と指定した場合、スケーリング操作によって容量単位を1つ削除するスケール・インが実行されます。一度に1つの容量単位分のみスケール・アウトできることに注意してください。
スケーリング操作時に追加または削除するVMと管理対象サーバーの数は、サービス・インスタンスに宣言されている容量単位の定義に基づいています。たとえば、容量単位定義で1台のVMとVMごとに1台の管理対象サーバーが管理される場合、スケーリング操作では、追加または削除する容量単位ごとに、1台のVMと1台の管理対象サーバーを追加または削除します。

レスポンス

サポートされているメディア・タイプ

application/json

202 Response

Accepted. 返される可能性のあるその他のHTTPステータス・コードの詳細は、「ステータス・コード」を参照してください。

400 Response

Bad Request. 次の場合に返されます。

サービス・インスタンスの状態が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つ目のリクエストが受信された場合。
リクエストされた容量単位の数が既存の数と同じ場合。この場合、The number of scaling units in the cluster is equal to the number of scaling units requested. No scaling operation will be carried out.というメッセージが返されます。
サービス・インスタンスのサービス・レベルは、Oracle Java Cloud Service-Virtual ImageまたはBASICです。次のメッセージが返されます: JAAS-SCALING-032: サービス[サービス・インスタンス名]をスケーリングできません。スケーリングをサポートする最小サービス・レベルは[PAAS]ですが、サービス・レベルは[BASIC]です

例

次の例では、cURLを使用してRESTリソースに対するPUTリクエストを発行することによってOracle Java Cloud ServiceインスタンスのCoherenceデータ層をスケーリングする方法を示しています。

注意: この例のコマンドでは、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 PUT -u username:userPassword1! -d @scaledgcluster.json -H "X-ID-TENANT-NAME:ExampleIdentityDomain" -H "Content-Type:application/vnd.com.oracle.oracloud.datagrid.Service+json" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/Example1Instance/clusters/Example1_DGCluster

リクエスト本文の例

JSON形式のリクエスト本文の例を次に示します。

{
  "scalingUnitCount" : "2"
}

次に、操作のスケーリング用としてforceパラメータ(オプション)を使用した例を示します。

{
  "scalingUnitCount" : "1",
  "force" : "true"
}

レスポンス・ヘッダーの例

次にレスポンス・ヘッダーの例を示します。

Locationヘッダーは、スケーリング・リクエストのステータスにアクセスする際に使用できるRESTリソースを返します。詳細は、「サービス・インスタンス・ライフサイクル操作のステータスの表示」を参照してください。

HTTP/1.1 202 Accepted
Date: Sat, 10 Oct 2015 21:06:04 GMT
Location: https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/status/scale/job/239610
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/Example1Instance/clusters/Example1_DGCluster
Retry-After: 60

レスポンス本文の例(スケール・アウト、ステータスの表示)

スケール・アウトを実行するスケーリング操作のステータスを確認する場合のレスポンス本文の例を次に示します。

{
  "service_name": "Example1Instance",
  "version": "12cR3",
  "wlsVersion": "12.1.3.0.160419",
  "status": "Running",
  "error_status_desc": "",
  "compliance_status": "",
  "compliance_status_desc": "",
  "auto_update": "true",
  "description": "Example description",
  "identity_domain": "ExampleIdentityDomain",
  "creation_time": "Fri Oct 9 0:4:44 UTC 2015",
  "last_modified_time": "Sat Oct 10 21:33:32 UTC 2015",
  "created_by": "username",
  "service_uri": "https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/ExampleIdentityDomain\/Example1Instance",
  "message": [
    "Successfully scaled out cluster [Example1_DGCluster]",
    "Successfully scaled out cluster [Example1_DGCluster]",
    "    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 [example1instance-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 [example1instance-wls-4] containing WebLogic Managed Server(s) [[Example1_server_4_DG]] completed...",
    "        Service Reachabilty Check (SRC) of WebLogic Administration Server completed...",
    "        Service Reachabilty Check (SRC) of WebLogic Managed Server(s) [Example1_server_1, Example1_server_2, Example1_server_3_DG, Example1_server_4_DG] completed..."
  ]
}

レスポンス本文の例(スケール・イン、ステータスの表示)

次に、スケール・インを実行するスケーリング操作のステータスを確認する場合のレスポンス本文の例を示します。

{
  "service_name": "Example1Instance",
  "version": "12cR3",
  "wlsVersion": "12.1.3.0.160419",
  "status": "Running",
  "error_status_desc": "",
  "compliance_status": "",
  "compliance_status_desc": "",
  "auto_update": "true",
  "description": "Example description",
  "identity_domain": "ExampleIdentityDomain",
  "creation_time": "Fri Oct 9 0:4:44 UTC 2015",
  "last_modified_time": "Sat Oct 10 21:33:32 UTC 2015",
  "created_by": "username",
  "service_uri": "https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/ExampleIdentityDomain\/Example1Instance",
  "message": [
    "Successfully scaled in cluster [1].",
    "    Deleting capacity unit(s) containing [1] virtual machines...",
    "    Started shutting down and removing managed servers from Admin.",
    "    Started shutting down and removing managed servers from Admin.",
    "    Completed removing managed servers from Admin.",
    "    Stopping and removing resources for capacity unit(s) containing [1] virtual machines...",
    "    Successfully deleted capacity unit(s) and [1] virtual machines",
    "Successfully scaled in cluster [Example1_DGCluster]."
  ]
}