オンデマンド・バックアップの開始
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/backups
スケジュールされた自動バックアップ、バックアップの内容、バックアップが格納されている場所の詳細は、「バックアップとリストアについて」 (「Oracle Java Cloud Serviceの管理」)を参照してください。
リクエスト
- application/json
- identityDomainId: string
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID。
- serviceId: string
Oracle Java Cloud Serviceインスタンスの名前。
- Authorization: string
Oracle Identity Cloud Serviceから取得したコロンまたはOAuthアクセス・トークンで区切られた、Base64でエンコードされたユーザー名とパスワード。 「認証」を参照してください。
- X-ID-TENANT-NAME: string
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID。
object
- databaseIncluded(optional): boolean
このオンデマンド・バックアップ操作の一部としてデータベース・バックアップが含まれているかどうかを指定するフラグ。 値のデフォルトは
false
で、データベースのバックアップが実行されないことを示します。 値をtrue
に設定した場合、データベース・バックアップが実行されます。 ただし、関連付けられたデータベース・デプロイメント用のデータベース・ファイルは、実際にはバックアップに含まれません。データベース・デプロイメントが単一インスタンス・データベースまたはOracle Real Application Clusters (RAC)データベースのどちらをホストしているかによって、RMANタグまたはタイムスタンプのみが含められます。Java Cloud Serviceインスタンスには
backupDestination
がBOTH
に設定され、backupDestination
がNONE
に設定されているデータベース・デプロイメントにインスタンスが関連付けられている場合、関連付けられたデータベースのバックアップをJava Cloud Serviceインスタンスのオンデマンド・バックアップの一部として含めることはできません。ノート: 必要なインフラストラクチャ・スキーマの次のデータベース・サービスに関連付けられているJava Cloud Serviceインスタンスでは、この属性を
true
にできません:- Oracle Autonomous Transaction Processing
- Oracle Cloud Infrastructure Database (DBシステム)
- Oracle Database Exadata Cloud Service
- full(optional): boolean
オンデマンド・バックアップのタイプを指定するフラグ。 有効なオプションは
true
のみで、false
はサポートされません。 全体バックアップには、すべてのサービス・インスタンス構成データが含まれます。 - keepForever(optional): boolean
バックアップを無期限に保存するかどうかを指定するフラグ。 この属性は、非推奨の
expirationDate
を置き換えます。バックアップは、サービス・インスタンスのバックアップ構成で定義されているデフォルトの保存期間で保持されます。「バックアップ構成の表示」を参照してください。
バックアップを無制限に保持、または手動で削除するまで保持する場合は、この値を
true
に設定します。 サービス・インスタンスのバックアップのデフォルト保存期間の終了時にバックアップを削除するには、この値をfalse
に設定します。ノート:関連付けられたデータベース・デプロイメントがOracle Real Application Clusters (RAC)データベースをホストしている場合、
keepForever
値がtrue
に設定されているときは、オンデマンド・バックアップ操作の一部としてデータベースのバックアップを実行できません。 - notes(optional): string
バックアップに関する追加情報を提供する、自由形式のテキスト。
レスポンス
- application/json
202レスポンス
Location
ヘッダーは、「ジョブIDによる操作のステータスの表示」で説明されているように、ジョブ・ステータスの表示に使用できるURIを返します。
object
- job_id(optional): string
操作のジョブID。
- operationName(optional): string
実行される操作。 たとえば、
start-backup
、backup-config-update
などです。 - target_uri(optional): string
リソースのURI。
例
次の例では、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 @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
に設定されているのと同じ動作ですが、非推奨です)
リクエスト本文の例
JSON形式のリクエスト本文の例を次に示します。
{
"keepForever":true,
"full":true,
"notes":"On-demand full backup request."
}
レスポンス・ヘッダーの例
次にレスポンス・ヘッダーの例を示します。 Location
ヘッダーは、ジョブ・ステータスの表示に使用できるURIを返します。 「ジョブIDによる操作のステータスの表示」を参照してください。
HTTP/1.1 202 Accepted
Date: Sat, 22 Apr 2017 19:47:28 GMT
Location: https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/1882094
Content-Type: application/json
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{
"operationName":"start-backup",
"target_uri":"https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/ExampleIdentityDomain\/ExampleInstance\/backups\/1449345407188",
"job_id":"1882094"
}