サービス・インスタンスおよび個々のVMの停止と起動
REST APIを使用して、サービス・インスタンスおよび個々の仮想マシン(VM)のライフサイクル状態を制御できます。 具体的には、次のことができます。
Oracle Java Cloud ServiceインスタンスとそのすべてのVMの停止と起動
管理サーバーとそれに関連付けられたVMの再起動
ロード・バランサとそれに関連付けられたVMの停止、起動または再起動
管理対象サーバーとそれに関連付けられたVMの停止、起動または再起動
サービス・インスタンスおよび個別のVMの停止および起動を試みる前に、次の点を検討してください。
管理サーバーと同じVMに常駐する個別の管理対象サーバーを停止または起動することはできません。 この場合、再起動のみが許可されます。
Coherenceデータ層内の個々の管理対象サーバーは、停止、起動または再起動できません。 この場合、Oracle Java Cloud ServiceインスタンスとそのすべてのVMを停止および起動する必要があります。
停止または再起動されるVM上で実行されている処理中のジョブ(スケジュール済のcronジョブなど)はすべて強制終了され、Coherenceキャッシュ内のデータはすべて失われます(この機能が有効な場合)。
サービス・インスタンスが停止している場合、管理対象サーバーやロード・バランサは停止、起動または再起動できません。
Oracle Public Cloudの場合: 従量制サブスクリプションが毎時の請求頻度に基づいている場合、Oracle Java Cloud Serviceインスタンスが停止状態のときの時間に対しては請求されません。
注意: cURLコマンドの例では、URL構造https://rest_server_url/resource-pathが使用されています。ここで、rest_server_urlはアイデンティティ・ドメインまたはテナント名を問い合せるためのOracle Public CloudまたはOracle Cloud MachineのRESTサーバーです。 Oracle Public CloudまたはOracle Cloud Machineに使用する適切なURL構造の詳細は、リクエストの送信を参照してください。
サービス・インスタンスの停止と起動
サービス・インスタンスを停止および起動するには、次の手順で説明する各ステップを実行します。 restartライフサイクル状態の操作を使用してサービス・インスタンスを再起動することはできません。 サービス・インスタンスを再起動するには、stopライフサイクル状態のリクエストに続けて、startライフサイクル状態のリクエストを発行します。
サービス・インスタンスを停止する前に、完了する必要がある処理中のジョブがないことを確認します。 処理中のジョブは、サービス・インスタンスの停止時に強制終了されます。
サービス・インスタンスを停止するには、次のように、サービス・インスタンス停止ライフサイクル状態のリクエストの詳細を定義するJSONドキュメントstopinstance.jsonを最初に作成します。
{ "lifecycleState" : "stop", "lifecycleTimeout" : "30" }
オプションで、lifecycleTimeout属性を使用して、リクエストのタイムアウト値を分単位で指定できます。 指定されていない場合は、デフォルトで60分に設定されます。 リクエスト属性の詳細は、「サービス・インスタンスおよび個々のVMの停止と起動」を参照してください。
前の手順で作成したJSONドキュメントを渡して、サービス・インスタンスとそのすべてのVMを停止します。
curl -i -X POST -u username:userPassword1! -d @stopinstance.json -H "Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance
cURLコマンドラインで次のオプションを指定します。
出力にHTTPヘッダーを含める-iオプション。 このオプションは省略可能です。
リクエストのタイプ(POST)を指定する-Xオプション。
認証のためのOracle Java Cloud Serviceアカウントのユーザー名とパスワードを指定する-uオプション。
ローカル・マシン上でJSON形式のリクエスト・ドキュメント(stopinstance.json)を識別する-dオプション。
コンテンツ・タイプをapplication/vnd.com.oracle.oracloud.provisioning.Service+jsonとして識別し、アイデンティティ・ドメインIDまたはテナント名を識別するカスタム・ヘッダーX-ID-TENANT-NAMEを定義する-H。
次にレスポンス・ヘッダーの例を示します。
HTTP/1.1 202 Accepted Date: Wed, 22 Jun 2016 20:22:01 GMT Location: https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/status/control/job/810275 Content-Length: 0 Content-Type: application/json Service-URI: https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance
Locationヘッダーで返されるリソースURIを使用して、ライフサイクル状態のリクエストのステータスをチェックします。 詳細は、「サービス・インスタンス・ライフサイクル操作のステータスの表示」を参照してください。
curl -i -X GET -u username:userPassword1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/status/control/job/810275
cURLコマンドラインで次のオプションを指定します。
出力にHTTPヘッダーを含める-iオプション。 このオプションは省略可能です。
リクエストのタイプ(GET)を指定する-Xオプション。
認証のためのOracle Java Cloud Serviceアカウントのユーザー名とパスワードを指定する-uオプション。
アイデンティティ・ドメインIDまたはテナント名を識別するカスタム・ヘッダーX-ID-TENANT-NAMEを定義する-H。
次の例では、ステータス・メッセージを含めてレスポンス本文のコンテンツを示しています。 この例では、サービス・インスタンスの「Stopped」ステータスによって示されているように、操作が完了しました。
{ "service_name": "ExampleInstance", "version": "12cR3", "wlsVersion": "12.1.3.0.xxxxxx", "status": "Stopped", "error_status_desc": "", "compliance_status": "", "compliance_status_desc": "", "auto_update": "true", "description": "Example, Inc product distribution", "identity_domain": "ExampleIdentityDomain", "creation_time": "Mon Jun 6 19:37:41 UTC 2016", "last_modified_time": "Mon Jun 6 19:37:39 UTC 2016", "created_by": "username", "service_uri": "https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/ExampleIdentityDomain\/ExampleInstance", "message": [ "Stopping service [ExampleInstance]...", "Stopped service [ExampleInstance].", " Stopped all Compute resources..." ] }
サービス・インスタンスを起動するには、次のように、サービス・インスタンス起動ライフサイクル状態のリクエストの詳細を定義するJSONドキュメントstartinstance.jsonを最初に作成します。
{ "lifecycleState" : "start" }
リクエスト属性の詳細は、「サービス・インスタンスおよび個々のVMの停止と起動」を参照してください。
前のステップで作成したJSONドキュメントを渡して、サービス・インスタンスとそのすべてのVMを起動します。
curl -i -X POST -u username:userPassword1! -d @startinstance.json -H "Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance
cURLコマンドラインで次のオプションを指定します。
出力にHTTPヘッダーを含める-iオプション。 このオプションは省略可能です。
リクエストのタイプ(POST)を指定する-Xオプション。
認証のためのOracle Java Cloud Serviceアカウントのユーザー名とパスワードを指定する-uオプション。
ローカル・マシン上でJSON形式のリクエスト・ドキュメント(startinstance.json)を識別する-dオプション。
コンテンツ・タイプをapplication/vnd.com.oracle.oracloud.provisioning.Service+jsonとして識別し、アイデンティティ・ドメインIDまたはテナント名を識別するカスタム・ヘッダーX-ID-TENANT-NAMEを定義する-H。
次にレスポンス・ヘッダーの例を示します。
HTTP/1.1 202 Accepted Date: Wed, 22 Jun 2016 22:53:23 GMT Location: https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/status/control/job/810368 Content-Length: 0 Content-Type: application/json Service-URI: https://rest_server_ur;/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance
Locationヘッダーで返されるリソースURIを使用して、ライフサイクル状態のリクエストのステータスをチェックします。 詳細は、「サービス・インスタンス・ライフサイクル操作のステータスの表示」を参照してください。
curl -i -X GET -u username:userPassword1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/status/control/job/810368
cURLコマンドラインで次のオプションを指定します。
出力にHTTPヘッダーを含める-iオプション。 このオプションは省略可能です。
リクエストのタイプ(GET)を指定する-Xオプション。
認証のためのOracle Java Cloud Serviceアカウントのユーザー名とパスワードを指定する-uオプション。
アイデンティティ・ドメインIDまたはテナント名を識別するカスタム・ヘッダーX-ID-TENANT-NAMEを定義する-H。
次の例では、ステータス・メッセージを含めてレスポンス本文のコンテンツを示しています。 この例では、サービス・インスタンスの「Running」ステータスによって示されているように、操作が完了しました。
{ "service_name": "ExampleInstance", "version": "12cR3", "wlsVersion": "12.1.3.0.xxxxxx", "status": "Running", "error_status_desc": "", "compliance_status": "", "compliance_status_desc": "", "auto_update": "true", "description": "Example, Inc product distribution", "identity_domain": "ExampleIdentityDomain", "creation_time": "Mon Jun 6 19:37:41 UTC 2016", "last_modified_time": "Mon Jun 6 19:37:39 UTC 2016", "created_by": "username", "service_uri": "https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/ExampleIdentityDomain\/ExampleInstance", "message": [ "Starting service [ExampleInstance]...", "Started service [ExampleInstance].", " Started all Compute resources..." ] }
管理サーバーの再起動
管理サーバーを再起動するには、次の手順で説明する各ステップを実行します。 管理サーバーを再起動するには、必ずrestartライフサイクル状態の操作を使用する必要があります。 stopまたはstartライフサイクル状態の操作を使用して、管理サーバーのライフサイクル状態を制御することはできません。
管理サーバーを再起動する前に、管理サーバーに関連付けられたVM上で完了する必要がある処理中のジョブが実行されていないことを確認します。 処理中のジョブは、管理サーバーの停止時に強制終了されます。
次のように、管理サーバー再起動ライフサイクル状態のリクエストの詳細を定義するJSONドキュメントrestartadminserver.jsonを作成します。
{ "lifecycleState" : "restart", "serverName" : "ExampleI_server_1", "force" : true }
管理サーバーの名前を取得するには、すべての管理対象サーバーの表示を参照してください。
管理サーバーのライフサイクル状態を制御するには、lifecycleState はrestartにのみ設定できます。 serverNameには、管理サーバーまたは管理サーバーと同じVM上で実行されている管理対象サーバーの名前を指定できます。 同じVM上で他の管理対象サーバーが実行されている場合、ライフサイクル状態の操作を確実に処理するには、forceフラグをtrueに設定する必要があります。 リクエスト属性の詳細は、「サービス・インスタンスおよび個々のVMの停止と起動」を参照してください。
前のステップで作成したJSONドキュメントを渡して、管理サーバーとそれに関連付けられたVMを再起動します。
curl -i -X POST -u username:userPassword1! -d @restartadminserver.json -H "Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance
cURLコマンドラインで次のオプションを指定します。
出力にHTTPヘッダーを含める-iオプション。 このオプションは省略可能です。
リクエストのタイプ(POST)を指定する-Xオプション。
認証のためのOracle Java Cloud Serviceアカウントのユーザー名とパスワードを指定する-uオプション。
ローカル・マシン上でJSON形式のリクエスト・ドキュメント(restartadminserver.json)を識別する-dオプション。
コンテンツ・タイプをapplication/vnd.com.oracle.oracloud.provisioning.Service+jsonとして識別し、アイデンティティ・ドメインIDまたはテナント名を識別するカスタム・ヘッダーX-ID-TENANT-NAMEを定義する-H。
次にレスポンス・ヘッダーの例を示します。
HTTP/1.1 202 Accepted Date: Wed, 22 Jun 2016 23:42:29 GMT Location: https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/status/control/job/810398 Content-Length: 0 Content-Type: application/json Service-URI: https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance
Locationヘッダーで返されるリソースURIを使用して、ライフサイクル状態のリクエストのステータスをチェックします。 詳細は、「サービス・インスタンス・ライフサイクル操作のステータスの表示」を参照してください。
curl -i -X GET -u username:userPassword1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/status/control/job/810398
cURLコマンドラインで次のオプションを指定します。
出力にHTTPヘッダーを含める-iオプション。 このオプションは省略可能です。
リクエストのタイプ(GET)を指定する-Xオプション。
認証のためのOracle Java Cloud Serviceアカウントのユーザー名とパスワードを指定する-uオプション。
アイデンティティ・ドメインIDまたはテナント名を識別するカスタム・ヘッダーX-ID-TENANT-NAMEを定義する-H。
次の例では、ステータス・メッセージを含めてレスポンス本文のコンテンツを示しています。 この例では、サービス・インスタンスの「Maintenance」ステータスによって示されているように、操作がまだ完了していません。 操作が完了した場合、ステータスは「Running」です。
{ "service_name": "ExampleInstance", "version": "12cR3", "wlsVersion": "12.1.3.0.xxxxxx", "status": "Maintenance", "error_status_desc": "", "compliance_status": "", "compliance_status_desc": "", "auto_update": "true", "description": "Example, Inc product distribution", "identity_domain": "ExampleIdentityDomain", "creation_time": "Mon Jun 6 19:37:41 UTC 2016", "last_modified_time": "Mon Jun 6 19:37:39 UTC 2016", "created_by": "username", "service_uri": "https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/ExampleIdentityDomain\/ExampleInstance", "message": [ "Restarting service member [ExampleI_server_1] of service [ExampleInstance]...", " Stopping Virtual Machine wls\/vm-1..." ] }
管理対象サーバーの再起動
管理対象サーバーを再起動するには、次の手順で説明する各ステップを実行します。 管理対象サーバーのライフサイクル状態を制御するには、この手順で説明しているrestartライフサイクル状態の操作を使用する方法の他に、stopまたはstartライフサイクル状態の操作も使用できますが、それは該当する管理対象サーバーが管理サーバーと同じVM上に存在しない場合にかぎります。 詳細は、「サービス・インスタンスおよび個々のVMの停止と起動」を参照してください。
管理対象サーバーを再起動する前に、管理対象サーバーに関連付けられたVM上で完了する必要がある処理中のジョブが実行されていないことを確認します。 処理中のジョブは、管理対象サーバーの停止時に強制終了されます。
次のように、管理対象サーバー再起動ライフサイクル状態のリクエストの詳細を定義するJSONドキュメントrestartserver.jsonを作成します。
{ "lifecycleState" : "restart", "serverName" : "ExampleI_server_2", "force" : true }
管理対象サーバーの名前を取得するには、すべての管理対象サーバーの表示を参照してください。
serverNameを使用して、再起動する管理対象サーバーの名前を指定します。 オプションで、同じVM上で他の管理対象サーバーが実行されている場合、forceフラグをtrueに設定することにより、ライフサイクル状態の操作を確実に処理できます。 リクエスト属性の詳細は、「サービス・インスタンスおよび個々のVMの停止と起動」を参照してください。
前の手順で作成したJSONドキュメントを渡して、管理対象サーバーとそれに関連付けられたVMを再起動します。
curl -i -X POST -u username:userPassword1! -d @restartserver.json -H "Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance
cURLコマンドラインで次のオプションを指定します。
出力にHTTPヘッダーを含める-iオプション。 このオプションは省略可能です。
リクエストのタイプ(POST)を指定する-Xオプション。
認証のためのOracle Java Cloud Serviceアカウントのユーザー名とパスワードを指定する-uオプション。
ローカル・マシン上でJSON形式のリクエスト・ドキュメント(restartserver.json)を識別する-dオプション。
コンテンツ・タイプをapplication/vnd.com.oracle.oracloud.provisioning.Service+jsonとして識別し、アイデンティティ・ドメインIDまたはテナント名を識別するカスタム・ヘッダーX-ID-TENANT-NAMEを定義する-H。
次にレスポンス・ヘッダーの例を示します。
HTTP/1.1 202 Accepted Date: Thu, 23 Jun 2016 00:04:41 GMT Location: https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/status/control/job/811634 Content-Length: 0 Content-Type: application/json Service-URI: https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance
Locationヘッダーで返されるリソースURIを使用して、ライフサイクル状態のリクエストのステータスをチェックします。 詳細は、「サービス・インスタンス・ライフサイクル操作のステータスの表示」を参照してください。
curl -i -X GET -u username:userPassword1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/status/control/job/811634
cURLコマンドラインで次のオプションを指定します。
出力にHTTPヘッダーを含める-iオプション。 このオプションは省略可能です。
リクエストのタイプ(GET)を指定する-Xオプション。
認証のためのOracle Java Cloud Serviceアカウントのユーザー名とパスワードを指定する-uオプション。
アイデンティティ・ドメインIDまたはテナント名を識別するカスタム・ヘッダーX-ID-TENANT-NAMEを定義する-H。
次の例では、ステータス・メッセージを含めてレスポンス本文のコンテンツを示しています。 この例では、サービス・インスタンスの「Maintenance」ステータスによって示されているように、操作がまだ完了していません。 操作が完了した場合、ステータスは「Running」です。
{ "service_name": "ExampleInstance", "version": "12cR3", "wlsVersion": "12.1.3.0.xxxxxx", "status": "Maintenance", "error_status_desc": "", "compliance_status": "", "compliance_status_desc": "", "auto_update": "true", "description": "Example, Inc product distribution", "identity_domain": "ExampleIdentityDomain", "creation_time": "Mon Jun 6 19:37:41 UTC 2016", "last_modified_time": "Mon Jun 6 19:37:39 UTC 2016", "created_by": "username", "service_uri": "https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/ExampleIdentityDomain\/ExampleInstance", "message": [ "Restarting service member [ExampleI_server_2] of service [ExampleInstance]...", " Stopping Virtual Machine wls\/vm-2..." ] }
ロード・バランサの再起動
ロード・バランサを再起動するには、次の手順で説明する各ステップを実行します。 ロード・バランサのライフサイクル状態を制御するには、この手順で説明しているrestartライフサイクル状態の操作を使用する方法の他に、stopまたはstartライフサイクル状態の操作も使用できます。 詳細は、「サービス・インスタンスおよび個々のVMの停止と起動」を参照してください。
次のように、ロード・バランサ再起動ライフサイクル状態のリクエストの詳細を定義するJSONドキュメントrestartlb.jsonを作成します。
{ "lifecycleState" : "restart", "lbAdminHostName" : "ExampleInstance-lb-1" }
デフォルトでは、ロード・バランサのホスト名はserviceinstancename-lb-1です。ここで、serviceinstancenameはOracle Java Cloud Serviceインスタンスの名前です。
前のステップで作成したJSONドキュメントを渡して、ロード・バランサとそれに関連付けられたVMを再起動します。
curl -i -X POST -u username:userPassword1! -d @restartlb.json -H "Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance
cURLコマンドラインで次のオプションを指定します。
出力にHTTPヘッダーを含める-iオプション。 このオプションは省略可能です。
リクエストのタイプ(POST)を指定する-Xオプション。
認証のためのOracle Java Cloud Serviceアカウントのユーザー名とパスワードを指定する-uオプション。
ローカル・マシン上でJSON形式のリクエスト・ドキュメント(restartlb.json)を識別する-dオプション。
コンテンツ・タイプをapplication/vnd.com.oracle.oracloud.provisioning.Service+jsonとして識別し、アイデンティティ・ドメインIDまたはテナント名を識別するカスタム・ヘッダーX-ID-TENANT-NAMEを定義する-H。
次にレスポンス・ヘッダーの例を示します。
HTTP/1.1 202 Accepted Date: Thu, 23 Jun 2016 20:29:08 GMT Location: https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/status/control/job/812640 Content-Length: 0 Content-Type: application/json Service-URI: https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance
Locationヘッダーで返されるリソースURIを使用して、ライフサイクル状態のリクエストのステータスをチェックします。 詳細は、「サービス・インスタンス・ライフサイクル操作のステータスの表示」を参照してください。
curl -i -X GET -u username:userPassword1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/status/control/job/812640
cURLコマンドラインで次のオプションを指定します。
出力にHTTPヘッダーを含める-iオプション。 このオプションは省略可能です。
リクエストのタイプ(GET)を指定する-Xオプション。
認証のためのOracle Java Cloud Serviceアカウントのユーザー名とパスワードを指定する-uオプション。
アイデンティティ・ドメインIDまたはテナント名を識別するカスタム・ヘッダーX-ID-TENANT-NAMEを定義する-H。
次の例では、ステータス・メッセージを含めてレスポンス本文のコンテンツを示しています。 この例では、サービス・インスタンスの「Running」ステータスによって示されているように、操作が完了しました。
{ "service_name": "ExampleInstance", "version": "12cR3", "wlsVersion": "12.1.3.0.xxxxxx", "status": "Running", "error_status_desc": "", "compliance_status": "", "compliance_status_desc": "", "auto_update": "true", "description": "Example, Inc product distribution", "identity_domain": "ExampleIdentityDomain", "creation_time": "Mon Jun 6 19:37:41 UTC 2016", "last_modified_time": "Mon Jun 6 19:37:39 UTC 2016", "created_by": "username", "service_uri": "https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/ExampleIdentityDomain\/ExampleInstance", "message": [ "Restarting service member [ExampleInstance-lb-1] of service [ExampleInstance]...", "Restarted service member [ExampleInstance-lb-1] of service [ExampleInstance].", " Stopped service member [ExampleInstance-lb-1] of service [ExampleInstance].", " Stopped Virtual Machine lb\/vm-1...", " Started service member [ExampleInstance-lb-1] of service [ExampleInstance].", " Started Virtual Machine lb\/vm-1..." ] }