オンデマンド・バックアップの開始
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/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}/backupsは推奨されていませんが、近いうちに引き続きサポートされます。 ただし、今後非推奨の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の場合)。
- databaseIncluded
-
型:
boolean
このオンデマンド・バックアップ操作の一部としてデータベース・バックアップが含まれているかどうかを指定するフラグ。 この属性は、Oracle Public Cloudにのみ適用されます。 Oracle Cloud Machineでは、false
のみがサポートされます。Oracle Public Cloudでは、この値はデフォルトで
false
に設定され、データベース・バックアップが実行されないことを示します。 値をtrue
に設定した場合、データベース・バックアップが実行されます。 ただし、関連するDatabase Cloud Serviceデータベース・デプロイメントのデータベース・ファイルは実際にはバックアップに含まれておらず、Database Cloud Serviceデータベース・デプロイメントが単一インスタンスのデータベースをホスティングしているか、Oracle Real Application Clusters (RAC)データベースをホスティングしているかに応じてRMANタグまたはタイムスタンプのみが含まれています。注意: 関連するDatabase Cloud Serviceデータベース・デプロイメントがRACデータベースをホスティングしており、データベース・バックアップが含まれている場合、オンデマンド・バックアップの期限日は
null
にできません。 - expirationDate
-
型:
string
非推奨。 全体バックアップにnull
の期限日を設定するには、keepForever
をtrue
に設定します。 - full
-
型:
boolean
オンデマンド・バックアップのタイプを指定するフラグ。 有効なオプションはtrue
のみで、false
はサポートされません。 全体バックアップには、すべてのサービス・インスタンス構成データが含まれます。Oracle Public Cloudでは、2015年12月の更新以降、
true
のみがサポートされます。以前のリリースでは、全体または増分のオンデマンド・バックアップを開始するように指定できました。 - keepForever
-
型:
boolean
バックアップを無期限に保存するかどうかを指定するフラグ。 バックアップを無制限に保持、または手動で削除するまで保持する場合は、この値をtrue
に設定します。 (これは、expirationDate
をnull
に設定した場合と同じ動作になります。) サービス・インスタンスのバックアップのデフォルト保存期間の終了時にバックアップを削除するには、この値をfalse
に設定します。 (バックアップはサービス・インスタンスのバックアップ構成で定義されているデフォルトの保存期間の間保存されます。詳細はバックアップ構成の表示を参照してください。)注意:: Oracle Public Cloudでは、関連するOracle Database Cloud Serviceデータベース・デプロイメントがOracle Real Application Clusters (RAC)データベースをホスティングしている場合、
keepForever
の値がtrue
に設定されていると、データベース・バックアップをオンデマンド・バックアップ操作の一部として実行できません。 - notes
-
型:
string
バックアップに関する追加情報を提供する、自由形式のテキスト。
レスポンス
- application/json
- job_id
-
型:
string
バックアップ操作のジョブID。 - operationName
-
型:
string
実行される操作。start-backup
に設定します。 - target_uri
-
型:
string
バックアップ・リソースのURI。
例
次の例では、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 @backup.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/backups
注意: リクエストでは、keepForeverをtrueに設定してバックアップを無期限に、または手動で削除するまで保持します。 (これは、expirationDateが nullに設定されたのと同じ動作ですが、これは非推奨です)。
リクエスト本文の例(Oracle Public Cloud)
JSON形式のリクエスト本文の例を次に示します。
{ "databaseIncluded":true, "keepForever":true, "full":true, "notes":"On-demand full backup request." }
リクエスト本文の例(Oracle Cloud Machine)
JSON形式のリクエスト本文の例を次に示します。
{ "keepForever":true, "full":true, "notes":"On-demand full backup request." }
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。
HTTP/1.1 202 Accepted Date: Sat, 05 Dec 2015 19:56:47 GMT Transfer-Encoding: chunked Content-Type: application/json
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。 バックアップの表示、削除、アーカイブまたはダウンロードに使用できるバックアップURIに注意してください。
{ "operationName":"start-backup", "target_uri":"https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/ExampleIdentityDomain\/ExampleInstance\/backups\/1449345407188", "job_id":"8218" }