バックアップ構成の更新
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backupconfig
- 完全バックアップと増分バックアップのスケジュール
- 増分バックアップとオンデマンド全体バックアップのデフォルト保存時間。スケジュールされている全体バックアップは、関連する増分バックアップがある場合、その最新のものが使用可能でなくなるまで保存されることに注意してください
- バックアップの格納に使用されたコンテナのStorage Cloud ServiceのURIとユーザー名(Oracle Public Cloud)
- バックアップの格納に使用するリモート・ストレージのNFS URI (Oracle Cloud Machine)
スケジュールされた全体バックアップまたは増分バックアップを無効にするには、fullBackupSchedule
値またはincrementalBackupSchedule
値をそれぞれnull
に設定します。 例: {"fullBackupSchedule": null}
。
サービス・インスタンスのバックアップ・サービスを無効にして再有効化するには、backups
パラメータを使用します。 無効にすると、オンデマンド・バックアップとスケジュールされた自動バックアップの両方を実行できません。
Oracle Public Cloudでのスケジュールされた自動バックアップ、バックアップの内容およびバックアップが格納される場所の詳細は、『Oracle Java Cloud Serviceの使用』のOracle Java Cloud Serviceインスタンスのバックアップおよびリストアに関する項を参照してください。 Oracle Cloud Machineの場合、OPCMでのOracle Java Cloud Serviceの使用のOracle Java Cloud Serviceインスタンスのバックアップおよびリストアに関する項を参照してください。
注意: 従来のパス/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backupconfigは推奨されていませんが、近いうちに引き続きサポートされます。 ただし、今後非推奨のURL構造がサポートされなくなった場合に、中断を最小限に抑えるために、新しいパスを使用するようにアプリケーションを移行することをお勧めします。
リクエスト
- application/json
- 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インスタンスの名前。
- X-ID-TENANT-NAME
-
型:
string
必須:true
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
backups
パラメータを指定して、指定されたサービス・インスタンスのバックアップ・サービスを使用可能または使用不可にする必要があります。 - backups
-
型:
string
指定されたOracle Java Cloud Serviceインスタンスに設定するバックアップ・サービスの状態。 有効な値は、DISABLE
、ENABLE
またはUNCHANGED
(デフォルト)です。バックアップ・サービスが無効になると、オンデマンドおよびスケジュールされた自動バックアップも無効になります。 バックアップ・サービスが無効な場合、サービス・インスタンスでは次の操作も許可されなくなります。
- バックアップ構成の更新
- 既存バックアップからのリストア
- パッチの適用
- パッチのロールバック
- cloudStorageContainer
-
型:
string
サービス・インスタンスのバックアップが格納される場所。Oracle Public Cloudでは、これは既存のOracle Storage Cloud ServiceコンテナのURIです。
storageservicename-storageidentitydomain/containername
という形式を使用しますストレージ・コンテナを変更する場合、以前のストレージ・コンテナの既存のバックアップは保存期間が経過するまでそこに残り、サービスのリストアに使用できます。
ストレージ・コンテナおよびストレージ・ユーザー資格証明(
cloudStorageUser
およびcloudStoragePwd
)を変更する場合、古いコンテナの既存のバックアップを少なくとも1つ使用できないと、古いコンテナには新しい資格証明を使用してアクセスできないため、ストレージ・コンテナは新しいURIに更新されません。Oracle Cloud Machineでは、これはリモート・ストレージのNFS URIです。
ip-address:export-path
という形式を使用しますNFSリモート・ストレージ・ディスクにサービス・インスタンスのバックアップ・アーカイブが含まれている場合、この値は変更できません。
- cloudStoragePwd
-
型:
string
指定したコンテナにアクセスするためのユーザー名のパスワード。 この属性は、Oracle Public Cloudでのみ使用できます。 - cloudStorageUser
-
型:
string
指定したコンテナへのアクセスに使用される、Oracle Storage Cloud Serviceユーザー名。 この属性は、Oracle Public Cloudでのみ使用できます。 - defaultRetention
-
型:
string
増分バックアップとオンデマンドの全体バックアップを保持する日数。 この値のデフォルトは30
です。 スケジュール済の全体バックアップは、それに関連する最新の増分バックアップがあれば、それが使用できなくなるまで保持されます。デフォルトの保存値の変更は、新しいバックアップおよび既存のバックアップに影響します。 これは、値を小さい数値に変更した場合、更新された保存ポリシーに合致する既存のバックアップが次のスケジュールされた保守サイクルで削除されることを意味します。
バックアップを無期限で保存するか、手動で削除するまで保存する場合は、デフォルトの保存値に
null
を設定します。 - fullBackupSchedule
-
型:
array
fullBackupSchedule次の全体バックアップのスケジュール。デフォルトでは、全体バックアップは毎週開始され、インスタンスが作成されてから12時間後、直近の5分間隔に丸められて始まります。
注意: この属性を
null
に設定すると全体バックアップを一時的に無効にできますが、これは推奨されません。 - incrementalBackupSchedule
-
型:
array
incrementalBackupSchedule次の増分バックアップのスケジュール。デフォルトでは、全体バックアップが開始される日を除き、増分バックアップが毎日開始されます。
注意: この属性を
null
に設定すると増分バックアップを一時的に無効にできますが、これは推奨されません。
array
デフォルトでは、全体バックアップは毎週開始され、インスタンスが作成されてから12時間後、直近の5分間隔に丸められて始まります。
注意: この属性をnull
に設定すると全体バックアップを一時的に無効にできますが、これは推奨されません。
-
型:
object
backupschedulefullBackupSchedule
およびincrementalBackupSchedule
の属性。
array
デフォルトでは、全体バックアップが開始される日を除き、増分バックアップが毎日開始されます。
注意: この属性をnull
に設定すると増分バックアップを一時的に無効にできますが、これは推奨されません。
-
型:
object
backupschedulefullBackupSchedule
およびincrementalBackupSchedule
の属性。
fullBackupSchedule
およびincrementalBackupSchedule
の属性。- dayOfMonth
-
型:
string
月の日付。 この値は構成できません。 これはその月のすべての日にデフォルト設定されます(*)。 - dayOfWeek
-
型:
string
曜日。 有効な値はMon、Tue、Wed、Thu、Fri、Sat、Sunです。全体バックアップの場合、1つの値(曜日)のみが使用可能です。 増分バックアップの場合、1つ以上の値(曜日)が使用可能です。 増分バックアップに値が指定されていない場合、デフォルト値は全体バックアップを開始した曜日を除くすべての曜日として計算されます。 - hour
-
型:
string
時間。 有効な値は0から23です。 - minute
-
型:
string
分。 有効な値は0から59です。 - month
-
型:
string
Month この値は構成できません。 すべての月にデフォルト設定されます(*)。 - second
-
型:
string
Seconds この値は構成できません。 デフォルトは0です。 - year
-
型:
string
Year この値は構成できません。 すべての年にデフォルト設定されます(*)。
レスポンス
- application/json
- backupDestination
-
型:
string
バックアップのロケーション(PAAS
サービスレベルのインスタンスのみ)。Oracle Public CloudとOracle Cloud Machineの違いに注意してください。
Oracle Public Cloudでは、この構成可能な値のデフォルトは
BOTH
(これはDiskとOracle Storage Cloud Service Containerを意味します)。Oracle Cloud Machineでは、この構成不可能な値はデフォルトでDisk and NFSリモート・ストレージになります。
- cloudStorageContainer
-
型:
string
サービス・インスタンスのバックアップが格納される場所。Oracle Public Cloudの場合、これはOracle Storage Cloud ServiceコンテナのURIです。
Oracle Cloud Machineでは、これはリモート・ストレージのNFS URIです。
- cloudStorageUser
-
型:
string
指定したOracle Storage Cloud Serviceコンテナにアクセスするユーザー名。 この属性は、Oracle Public Cloudでのみ使用できます。 - defaultRetention
-
型:
string
増分バックアップとオンデマンドの全体バックアップを保持する日数。null
に設定されている場合、バックアップは無制限に、または手動で削除するまで保持されます。スケジュール済の全体バックアップは、それに関連する最新の増分バックアップがあれば、それが使用できなくなるまで保持されます。
- extendedRestoreTypes
-
型:
string
唯一の値はNONE
です。 これは、バックアップの復元はバックアップIDを使用した場合にのみサポートされることを意味します。 - fullBackupSchedule
-
型:
array
fullBackupSchedule次の全体バックアップのスケジュール。 - incrementalBackupSchedule
-
型:
array
incrementalBackupSchedule次の増分バックアップのスケジュール。 - lastBackupDate
-
型:
string
前回のバックアップが完了した日時。注意: バックアップがない場合、この属性は省略されます。
- lastSuccessfulCleanupDate
-
型:
string
前回のクリーン・アップ・ジョブが正常に完了した日時。 クリーン・アップ・ジョブは1日のスケジュール済バックアップが完了すると実行されます。 クリーン・アップ・ジョブは古いレコードをパージし、期限切れになったバックアップを削除、または期限切れになった(その日に削除される予定の)ローカル・コピーを削除します。 - nextFullBackupDate
-
型:
string
次の全体バックアップのスケジュール日時。Oracle Public Cloudでは、サービス・インスタンスのバックアップ・サービスが無効な状態の場合、この属性は使用できません。
- nextIncrementalBackupDate
-
型:
string
次の増分バックアップのスケジュール日時。Oracle Public Cloudでは、サービス・インスタンスのバックアップ・サービスが無効な状態の場合、この属性は使用できません。
- percentBackupVolumeUsed
-
型:
string
現在使用中のバックアップ・ボリュームの割合の合計。 - scheduledBackups
-
型:
string
スケジュールされたバックアップのタイプ。 唯一の値はALL
です。 これは、スケジュールされたフル・バックアップおよび増分バックアップの両方が有効にされることを意味します。 - state
-
型:
string
サービス・インスタンスのバックアップ・サービスの状態です。 たとえば、ENABLED
またはDISABLED
です。 - totalBackupVolumeUsed
-
型:
string
現在使用中のバックアップ・ボリュームの合計量(GB)。 - totalBackupVolumeUsedInBytes
-
型:
string
現在使用中のバックアップ・ボリュームの合計量(バイト単位)。 - totalCloudStorageContainerUsed
-
型:
string
Oracle Public Cloudの場合、現在使用中のStorage Cloud Serviceコンテナ領域の合計量(GB)。Oracle Cloud Machineの場合、現在使用中のNFSリモート・ストレージ・ディスクの総量(GB単位)。
- totalCloudStorageContainerUsedInBytes
-
型:
string
Oracle Public Cloudの場合、現在使用中のStorage Cloud Serviceコンテナ領域の合計量(バイト)。Oracle Cloud Machineの場合、現在使用中のNFSリモート・ストレージ・ディスクの総量(バイト単位)。
array
-
型:
object
backupschedulefullBackupSchedule
およびincrementalBackupSchedule
の属性。
array
-
型:
object
backupschedulefullBackupSchedule
およびincrementalBackupSchedule
の属性。
fullBackupSchedule
およびincrementalBackupSchedule
の属性。- dayOfMonth
-
型:
string
月の日付。 この値は構成できません。 これはその月のすべての日にデフォルト設定されます(*)。 - dayOfWeek
-
型:
string
曜日。 有効な値はMon、Tue、Wed、Thu、Fri、Sat、Sunです。全体バックアップの場合、1つの値(曜日)のみが使用可能です。 増分バックアップの場合、1つ以上の値(曜日)が使用可能です。 増分バックアップに値が指定されていない場合、デフォルト値は全体バックアップを開始した曜日を除くすべての曜日として計算されます。 - hour
-
型:
string
時間。 有効な値は0から23です。 - minute
-
型:
string
分。 有効な値は0から59です。 - month
-
型:
string
Month この値は構成できません。 すべての月にデフォルト設定されます(*)。 - second
-
型:
string
Seconds この値は構成できません。 デフォルトは0です。 - year
-
型:
string
Year この値は構成できません。 すべての年にデフォルト設定されます(*)。
例
次の例では、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 @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" }
バックアップ・サービスを再度有効にすると、リクエスト・ペイロードにバックアップ構成でサポートされている他のパラメータを含めることができます。
レスポンス本文の例
次の例は、(バックアップ・サービスが無効になっていないサービス・インスタンスの)バックアップ構成を更新するときに、Oracle Public CloudでJSON形式で返されるレスポンスを示しています。 新しい値が有効になります(太字で表示されています)。
{ "state":"ENABLED", "defaultRetention":"30 days", "fullBackupSchedule": { "second":"0", "minute":"0", "hour":"5", "dayOfMonth":"*", "month":"*", "dayOfWeek":"Sun", "year":"*" }, "incrementalBackupSchedule": { "second":"0", "minute":"0", "hour":"3", "dayOfMonth":"*", "month":"*", "dayOfWeek":"Mon,Tue,Wed,Thu,Fri,Sat", "year":"*" }, "scheduledBackups":"ALL", "extendedRestoreTypes":"NONE", "lastBackupDate":"Mon Jun 20 14:20:00 GMT 2016", "lastSuccessfulCleanupDate":"Mon Jun 20 14:37:29 GMT 2016", "nextFullBackupDate":"Sun Jun 26 05:00:00 GMT 2016", "nextIncrementalBackupDate":"Tue Jun 21 03:00:00 GMT 2016", "backupDestination":"BOTH", "cloudStorageContainer":"Storage-ExampleIdentityDomain\/mybackupcontainer", "cloudStorageUser":"username", "totalCloudStorageContainerUsed":"46.3MB", "totalCloudStorageContainerUsedInBytes":48513508, "totalBackupVolumeUsed":"46.3MB", "totalBackupVolumeUsedInBytes":48513508, "percentBackupVolumeUsed":0.022590864449739456 }
Oracle Cloud Machineでは、cloudStorageUserが表示されないことを除いて同様の出力が表示され、cloudStorageContainerの代わりに次のような出力が表示されます:
"cloudStorageContainer":"123.34.0.1:\/export\/XYZ\/abcd05\/mybackup",
次の例は、バックアップ・サービスを無効にするとOracle Public CloudでJSON形式で返されるレスポンスを示しています。 (太字で表示されている)stateの値のみが変更されます。
{ "state":"DISABLED", "defaultRetention":"30 days", "fullBackupSchedule": { "second":"0", "minute":"0", "hour":"5", "dayOfMonth":"*", "month":"*", "dayOfWeek":"Sun", "year":"*" }, "incrementalBackupSchedule": { "second":"0", "minute":"0", "hour":"3", "dayOfMonth":"*", "month":"*", "dayOfWeek":"Mon,Tue,Wed,Thu,Fri,Sat", "year":"*" }, "scheduledBackups":"ALL", "extendedRestoreTypes":"NONE", "lastBackupDate":"Mon Jun 20 14:20:00 GMT 2016", "lastSuccessfulCleanupDate":"Mon Jun 20 14:37:29 GMT 2016", "backupDestination":"BOTH", "cloudStorageContainer":"Storage-ExampleIdentityDomain\/mybackupcontainer", "cloudStorageUser":"username", "totalCloudStorageContainerUsed":"46.3MB", "totalCloudStorageContainerUsedInBytes":48513508, "totalBackupVolumeUsed":"46.3MB", "totalBackupVolumeUsedInBytes":48513508, "percentBackupVolumeUsed":0.022590864449739456 }
Oracle Cloud Machineでは、cloudStorageUserが表示されないことを除いて同様の出力が表示され、cloudStorageContainerの代わりに次のような出力が表示されます:
"cloudStorageContainer":"123.34.0.1:\/export\/XYZ\/abcd05\/mybackup",