機械翻訳について
  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インスタンスのバックアップ構成を更新します。 具体的には、次の詳細を更新できます。
  • 完全バックアップと増分バックアップのスケジュール
  • 増分バックアップとオンデマンド全体バックアップのデフォルト保存時間。スケジュールされている全体バックアップは、関連する増分バックアップがある場合、その最新のものが使用可能でなくなるまで保存されることに注意してください
  • バックアップの格納に使用されたコンテナの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の場合)。

本文パラメータ
リクエスト本文では、バックアップ構成更新リクエストの詳細を定義します。 更新する属性のみを指定してください。
ルート・スキーマ: backupconfig-postrequest
リクエスト本文では、バックアップ構成更新リクエストの詳細を定義します。 必須の属性はありませんが、backupsパラメータを指定して、指定されたサービス・インスタンスのバックアップ・サービスを使用可能または使用不可にする必要があります。
ネストされたスキーマ: fullBackupSchedule
型: array
次の全体バックアップのスケジュール。

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

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

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

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

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

ネストされたスキーマ: backupschedule
fullBackupScheduleおよびincrementalBackupScheduleの属性。

レスポンス

サポートされているメディア・タイプ
  • application/json
200レスポンス
OK その他のHTTPステータス・コードの詳細は、ステータス・コードを参照してください。
本文
レスポンス本文には、バックアップ構成の情報が含まれます。 バックアップ構成に対する特定の変更がリクエストされ、正常に完了すると、レスポンス本文に更新された構成が表示されます。 正常に完了しなかった場合には、レスポンス本文にサービス・インスタンスの既存のバックアップ構成が表示されます。
ルート・スキーマ: backupconfig-response
レスポンス本文には、バックアップ構成の情報が含まれます。 バックアップ構成に対する特定の変更がリクエストされ、正常に完了すると、レスポンス本文に更新された構成が表示されます。 正常に完了しなかった場合には、レスポンス本文にサービス・インスタンスの既存のバックアップ構成が表示されます。
ネストされたスキーマ: fullBackupSchedule
型: array
次の全体バックアップのスケジュール。
ネストされたスキーマ: incrementalBackupSchedule
型: array
次の増分バックアップのスケジュール。
ネストされたスキーマ: backupschedule
fullBackupScheduleおよびincrementalBackupScheduleの属性。
400 Response
Bad Request. バックアップ・サービスが無効になっているサービス・インスタンスのバックアップ構成を更新しようとするときに返されます。

例

次の例では、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",