Oracle Java Cloud Service REST API

パッチの適用

put

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/{patchId}

Oracle Java Cloud Serviceインスタンスにパッチを適用します。サービス中断を最小限に抑えるために、一度に1ノードずつパッチを適用するローリング・パターンでパッチを適用します。

Oracle Coherenceが有効なサービス・インスタンスにパッチを適用する場合、デフォルトでは、パッチ適用プロセスによって管理対象Coherence Serverのローリング再起動が実行されます。データを維持するには、パッチを適用するノードをシャットダウンする前に、CoherenceメンバーのStatusHAの状態がNODE-SAFEであることを確認します。

リクエスト

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

application/json

パス・パラメータ

identityDomainId: 型: string

必須: true

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

必須: true

パッチID。使用可能なパッチのリストを取得することで、パッチIDは取得できます。
serviceId: 型: string

必須: true

Oracle Java Cloud Serviceインスタンスの名前。

ヘッダー・パラメータ

X-ID-TENANT-NAME: 型: string

必須: true

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

本文パラメータ

リクエストには、パッチ適用操作に関する情報が含まれます。必須の値はありません。

ルート・スキーマ: patch-request

プロパティ

additionalNote

型: string

パッチに関する追加情報を提供する、自由形式のテキスト。

dgStatusHaPolicy

型: string

注意: Oracle Coherence対応のサービス・インスタンスにのみ適用可能です。

StatusHAの確認がスクリプトでどのように処理されるかを決定します。有効な値は次のとおりです。

REQUIRE_STATUS_HA: StatusHAが特定の状態に達するまで待機します。指定された状態になる前に、指定されたタイムアウト値に達すると、パッチ適用が失敗します。これがデフォルト値です。
PREFER_STATUS_HA: StatusHAが特定の状態に達するまで待機します。指定された状態になる前に、指定されたタイムアウト値に達すると、パッチ適用は続行されますが、データが失われる可能性があります。
IGNORE_STATUS_HA: StatusHAを確認しません。

dgStatusHaState

型: string

注意: Oracle Coherence対応のサービス・インスタンスにのみ適用可能です。

Coherence分散サービスのターゲットのStatusHA状態。有効な値は次のとおりです。

NODE-SAFE (これがデフォルトです)
MACHINE-SAFE

dgStatusHaTimeoutSecs

型: integer

注意: Oracle Coherence対応のサービス・インスタンスにのみ適用可能です。

タイムアウトする前に、StatusHAが特定の状態に達するまで待機する秒数。この値のデフォルトは300秒です。

レスポンス

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

application/json

202 Response

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

本文

レスポンス本文には、操作に関する情報が含まれます。

ルート・スキーマ: patch-response

レスポンス本文には、操作に関する情報が含まれます。

プロパティ

details: 型: object details

操作の詳細をグループ化します。
status: 型: string

操作の状態初めて開始する際、ステータスはNewに設定されます。ステータスは次の値のどちらかに遷移します: CompletedおよびCannot Complete。

ネストされたスキーマ: details

タイプ: object

操作の詳細をグループ化します。

プロパティ

jobId: 型: string

パッチ操作またはパッチ事前チェック操作のジョブID。
message: 型: string

操作を説明するシステム・メッセージ。

例

次の例では、cURLを使用してRESTリソースに対するPUTリクエストを発行することによって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 PUT -u username:userPassword1! -d @patch.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/patches/Patch_jdk1.7.0_95

リクエスト本文の例

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

{
   "additionalNote": "Applying JDK patch"
}

Oracle Java Cloud Service-Coherencインスタンスにパッチを適用する際の(つまり、サービス・インスタンスでOracle Coherenceが有効になっている場合のみ)属性の使用例を次に示します。

{
   "dgStatusHaState":"NODE-SAFE",
   "dgStatusHaPolicy":"REQUIRE_STATUS_HA",
   "dgStatusHaTimeoutSecs":100,
   "additionalNote":"Applying JDK patch",
}

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

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

HTTP/1.1 100 Continue

HTTP/1.1 202 Accepted
Date: Wed, 18 May 2016 17:28:37 GMT
Location: https://rest_server_url/paas/service/jcs/api/v1.1/instancemgmt/ExampleIdentityDomain/services/JaaS/instances/ExampleInstance/patches/applied/job/4021824
Content-Type: application/json

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
   "details":
   {
      "jobId":"4021824",
      "message":"JCS-PATCHING-5068: Patching service with patch [Patch_jdk1.7.0_95] is submitted as an asynchronous job."
   },
   "status":"Completed"
}