機械翻訳について
  1. Oracle Java Cloud ServiceのREST API
  2. タスク
  3. バックアップとリストア

バックアップ構成の更新

post

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

Oracle Java Cloud Serviceインスタンスのバックアップ構成を更新します。 具体的には、次の詳細を更新できます。
  • 完全バックアップと増分バックアップのスケジュール
  • 増分バックアップとオンデマンド全体バックアップのデフォルト保存時間。スケジュールされている全体バックアップは、関連する増分バックアップがある場合、その最新のものが使用可能でなくなるまで保存されることに注意してください
  • バックアップの格納に使用されるオブジェクト・ストレージ・コンテナまたはバケットのURIとユーザー名

スケジュールされた全体バックアップまたは増分バックアップを無効にするには、fullBackupSchedule値またはincrementalBackupSchedule値をそれぞれnullに設定します。 たとえば: {"fullBackupSchedule": null}。

サービス・インスタンスのバックアップ・サービスを無効化および再有効化するには、backupsパラメータを使用します。 無効にした場合、オンデマンド・バックアップは実行できず、スケジュール済バックアップは実行されません。 バックアップ・サービスを再有効化すると、スケジュールされたバックアップは次回のスケジュール時間に再開されます。 つまり、保存されていないスケジュール済バックアップは実行されません。

サービス・インスタンスの作成時に通知電子メール・アドレスを指定した場合、Oracle Java Cloud Serviceはバックアップを自動的に無効化し、同じエラーが連続して3回スケジュールされたバックアップで失敗すると通知します。 電子メールを指定しなかった場合、Oracle Java Cloud Serviceは、スケジュール済バックアップの連続的な失敗の7回後、バックアップを自動的に無効にします。 バックアップ構成の更新時に、障害の原因を修正し、backupsパラメータを使用してバックアップを再度有効にします。

スケジュールされた自動バックアップ、バックアップの内容、バックアップが格納されている場所の詳細は、「バックアップとリストアについて」 (「Oracle Java Cloud Serviceの管理」)を参照してください。

リクエスト

サポートされているメディア・タイプ
パス・パラメータ
ヘッダー・パラメータ
  • Oracle Identity Cloud Serviceから取得したコロンまたはOAuthアクセス・トークンで区切られた、Base64でエンコードされたユーザー名とパスワード。 「認証」を参照してください。
  • Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID。
本文()
リクエスト本文では、バックアップ構成更新リクエストの詳細を定義します。 更新する属性のみを指定してください。
ルート・スキーマ: backupconfig-postrequest
型: object
リクエスト本文では、バックアップ構成更新リクエストの詳細を定義します。 必要な属性はありませんが、backupsパラメータを指定して、指定したサービス・インスタンスのバックアップ・サービスを無効化または再有効化する必要があります。
ソースを表示
  • 指定したOracle Java Cloud Serviceインスタンスに設定するバックアップ・サービスの状態。 有効な値は、DISABLE、ENABLEまたはUNCHANGED (デフォルト)です。

    バックアップ・サービスが無効になっている場合、オンデマンド・バックアップとスケジュール済バックアップの両方が無効になります。 バックアップ・サービスが無効な場合、サービス・インスタンスでは次の操作も許可されなくなります。

    • バックアップ構成を更新します(再有効化する場合を除く)
    • 既存バックアップからのリストア
    • パッチの適用
    • パッチのロールバック

    バックアップ・サービスが無効化されている場合、スケジュール済バックアップは実行されません。 バックアップ・サービスの再有効化時には、スケジュールされたバックアップが次回のスケジュール時に再開されます。 つまり、保存されていないスケジュール済バックアップは実行されません。

  • サービス・インスタンスのバックアップが格納される場所。

    これは、既存のオブジェクト・ストレージ・コンテナまたはバケットのURIです。

    Oracle Cloud Infrastructure ClassicおよびOracle Cloud at Customerで、次のいずれかの形式を使用してコンテナを指定します:

    • Storage-<identitydomainid>/<containername>
    • <storageservicename>-<identitydomainid>/<containername>
    • <restEndPointURL>/<containerName>
    コンテナ名の指定に使用する形式は、Oracle Cloud Infrastructure Object Storage ClassicアカウントのURLによって異なります。 アカウントのURLを識別するには、「Oracle Cloud Infrastructure Object Storage Classicの使用」の「クラウド・アカウントのRESTエンドポイントURLの検索」を参照してください。

    Oracle Cloud Infrastructureで、次の形式を使用してオブジェクト・ストレージ・バケットを指定します:

    https://swiftobjectstorage.<region>.oraclecloud.com/v1/<namespace>/<bucket>

    ネームスペースを確認するには、Oracle Cloud Infrastructure webコンソールにサインインし、テナンシ名をクリックして、「オブジェクト・ストレージ名前空間」フィールドを探します。

    例:

    https://swiftobjectstorage.us-phoenix-1.oraclecloud.com/v1/acme/mybucket

    また、すべてのクラウド・デプロイメントで次の点に注意してください:

    • オブジェクト・ストレージ・コンテナまたはバケット名を変更した場合、以前のコンテナまたはバケット内の既存のバックアップはそこに残り、リテンション期間が経過するまでサービスのリストアに使用できます。
    • 名前とオブジェクト・ストレージ・ユーザーの資格証明(cloudStorageUserとcloudStoragePassword)を変更しようとすると、古いコンテナまたはバケット内の既存のバックアップを少なくとも1つ使用できないと、URIは新しい値に更新されません(古いコンテナまたは新しい資格証明ではバケットにアクセスできません)。

  • オブジェクト・ストレージ・ユーザーのパスワード。

    Oracle Cloud Infrastructure ClassicおよびOracle Cloud at Customerでは、これは、cloudStorageContainerで指定されたコンテナへの読取りおよび書込みアクセス権を持つOracle Cloud Infrastructure Object Storage Classicユーザーのパスワードです。

    Oracle Cloud Infrastructure Classicのサービス・インスタンスがOracle Identity Cloud Serviceを使用している場合、現在のクラウド・ユーザーがOracle Cloud Infrastructure Object Storage Classicを使用する資格がある場合、この属性は不要です。

    Oracle Cloud Infrastructureでは、これはcloudStorageUserで指定されたユーザーに対してOracle Cloud Infrastructureで生成された認証トークンです。

  • オブジェクト・ストレージ・ユーザーのユーザー名。

    Oracle Cloud Infrastructure ClassicおよびOracle Cloud at Customerでは、cloudStorageContainerで指定されたコンテナへの読取りおよび書込みアクセス権を持つOracle Cloud Infrastructure Object Storage Classicユーザーのユーザー名です。

    Oracle Cloud Infrastructure Classicのサービス・インスタンスがOracle Identity Cloud Serviceを使用している場合、現在のクラウド・ユーザーがOracle Cloud Infrastructure Object Storage Classicを使用する資格がある場合、この属性は不要です。

    Oracle Cloud Infrastructureでは、これはOracle Cloud Infrastructure Object Storageユーザーのユーザー名です。

  • 増分バックアップとオンデマンドの全体バックアップを保持する日数。 この値のデフォルトは30です。 スケジュール済の全体バックアップは、それに関連する最新の増分バックアップがあれば、それが使用できなくなるまで保持されます。

    デフォルトの保存値の変更は、新しいバックアップおよび既存のバックアップに影響します。 つまり、値を小さい数値に変更すると、更新された保存方針を満たす既存のバックアップは、次のバックアップまたは次にスケジュールされているメンテナンス・サイクルで削除されます。

  • スケジュールされたOracle Java Cloud Serviceインスタンスのバックアップに、関連付けられたデータベース・デプロイメントのバックアップを含めるかどうかを指定するフラグ。

    値(false)は、関連付けられているデータベース・デプロイメントのバックアップが調整され、有効になっていることを意味します。 trueという値は、このサービス・インスタンスのスケジュール済バックアップ中に、調整されたデータベース・デプロイメントのバックアップが実行されない(無効になっている)ことを意味します。

    Oracle Java Cloud ServiceインスタンスにbackupDestinationがBOTHに設定されていて、インスタンスがbackupDestinationに設定されているデータベース・デプロイメントに関連付けられている場合、スケジュール済のNONEインスタンスのバックアップには、関連データベースのバックアップが含まれていません。

    ノート: この属性は、必要なインフラストラクチャ・スキーマがOracle Database Exadata Cloud Serviceを使用するOracle Java Cloud Serviceインスタンスには適用できません。 属性は、サービス・インスタンス・バックアップ構成で指定されている場合は無視されます。 この属性は、Oracle Autonomous Transaction Processingデータベースを使用するサービス・インスタンス、またはOracle Cloud Infrastructure Database (DBシステム)を使用してインフラストラクチャ・スキーマをホストするサービス・インスタンスにも適用できません。 このようなサービス・インスタンスには、調整済のバックアップを使用できません。

  • fullBackupSchedule
    次の全体バックアップのスケジュール。

    デフォルトでは、全体バックアップは毎週開始され、インスタンスが作成されてから12時間後、直近の5分間隔に丸められて始まります。

    ノート: この属性をnullに設定すると全体バックアップを一時的に無効にできますが、これは推奨されません。

  • incrementalBackupSchedule
    次の増分バックアップのスケジュール。

    デフォルトでは、全体バックアップが開始される日を除き、増分バックアップが毎日開始されます。

    ノート: この属性をnullに設定すると増分バックアップを一時的に無効にできますが、これは推奨されません。

  • 専用のストレージ・ボリュームにバックアップのコピーを保持する日数。 デフォルトは7日です。

    ローカルの保存値は、デフォルトの保存値より大きくできません(defaultRetentionで指定)。

    完全にスケジュールされたバックアップのコピーは、最後に関連する増分バックアップのローカル・コピーが使用できなくなるまで保持されます(存在する場合)。

    ローカルの保存値を変更すると、新しいバックアップ・コピーや既存のコピーにも影響します。 つまり、この値を小さい数値に変更すると、更新された保存方針を満たす既存のバックアップ・コピーは、次のバックアップまたは次にスケジュールされているメンテナンス・サイクルで削除されます。

ネストされたスキーマ: fullBackupSchedule
型: array
次の全体バックアップのスケジュール。

デフォルトでは、全体バックアップは毎週開始され、インスタンスが作成されてから12時間後、直近の5分間隔に丸められて始まります。

ノート: この属性をnullに設定すると全体バックアップを一時的に無効にできますが、これは推奨されません。

ソースを表示
ネストされたスキーマ: incrementalBackupSchedule
型: array
次の増分バックアップのスケジュール。

デフォルトでは、全体バックアップが開始される日を除き、増分バックアップが毎日開始されます。

ノート: この属性をnullに設定すると増分バックアップを一時的に無効にできますが、これは推奨されません。

ソースを表示
ネストされたスキーマ: backupschedule
型: object
fullBackupScheduleおよびincrementalBackupScheduleの属性。
ソースを表示
  • 月の日付。 この値は構成できません。 これはその月のすべての日にデフォルト設定されます(*)。
  • 曜日。 有効な値はMon、Tue、Wed、Thu、Fri、Sat、Sunです。全体バックアップの場合、1つの値(曜日)のみが使用可能です。 増分バックアップの場合、1つ以上の値(曜日)が使用可能です。 増分バックアップに値が指定されていない場合、デフォルト値は全体バックアップを開始した曜日を除くすべての曜日として計算されます。
  • 時間。 有効な値は0から23です。
  • 分。 有効な値は0から59です。
  • 月。 この値は構成できません。 すべての月にデフォルト設定されます(*)。
  • 秒。 この値は構成できません。 デフォルトは0です。
  • 年。 この値は構成できません。 すべての年にデフォルト設定されます(*)。
先頭に戻る

レスポンス

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

202レスポンス

Accepted. Locationヘッダーは、「ジョブIDによる操作のステータスの表示」で説明されているように、ジョブ・ステータスの表示に使用できるURIを返します。
本文()
ルート・スキーマ : postrequest-response
型: object
レスポンス本文には、操作に関する情報が含まれます。
ソースを表示

400レスポンス

Bad Request サービス・インスタンスのバックアップ・サービスが無効になっているときに、バックアップ構成を更新しようとするときに返されます。
先頭に戻る

例

次の例では、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによってOracle Java Cloud Serviceインスタンスのバックアップ構成を更新する方法を示しています。

ノート: この例のコマンドは、URL構造https://rest_server_url/resource-pathを使用します。rest_server_urlは、アイデンティティ・ドメイン(またはクラウド・アカウント)と接続するRESTサーバーです。 「リクエストの送信」を参照してください。

cURLコマンド

curl -i -X POST -u username:password -d @backupconfig.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/backupconfig

リクエスト本文の例

自動バックアップ・スケジュールを変更するJSON形式のリクエスト・ドキュメントの例を次に示します。 変更するパラメータのみを含めます。 

{
   "fullBackupSchedule":
   {
      "hour":"5",
      "dayOfWeek":"Sun"
   },
   "incrementalBackupSchedule":
   {
      "hour":"3"
   }
}

ノート: 指定したサービス・インスタンスのバックアップ・サービスがDISABLED状態の場合は、バックアップ構成を変更できません。

指定したサービス・インスタンスのバックアップ・サービスを無効にするJSON形式のリクエスト・ドキュメントの例を次に示します。

バックアップ・サービスを無効にしているため、リクエスト・ペイロードにはバックアップ構成でサポートされている他のパラメータを含めないでください。

{
    "backups": "DISABLE"
}

指定したサービス・インスタンスのバックアップ・サービスを有効にするJSON形式のリクエスト・ドキュメントの例を次に示します。

{
    "backups": "ENABLE",
	"cloudStorageUser":"<username for jcs backup>",
	"cloudStoragePassword":"<Auth token to access OCI object storage bucket>"
}

リクエスト・ペイロードには、バックアップ・サービスを再度有効にするときにバックアップ構成でサポートされている他のパラメータを含めることができます。 たとえば、Oracle Java Cloud Serviceでサービス・インスタンス上のバックアップが連続した失敗後に自動的に無効になった場合、失敗の原因も修正します。

レスポンス・ヘッダーと本文の例

次に、レスポンスの例を示します。 Locationヘッダーは、ジョブ・ステータスの表示に使用できるURIを返します。 「ジョブIDによる操作のステータスの表示」を参照してください。 

HTTP/1.1 202 Accepted
Date: Sat, 22 Apr 2017 19:38:50 GMT
Location: https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/1882092
Content-Type: application/json
...
{
    "operationName":"backup-config-update",
    "target_uri":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/services\/jaas\/instances\/ExampleInstance\/backupconfig",
    "job_id":"1882092"
}
先頭に戻る