サービス・バックアップの取得
get
/api/v1.1/instances/{identityId}/{serviceId}/backups/{backupId}
サービス・インスタンスの既存のバックアップを取得します。
リクエスト
パス・パラメータ
- backupId
-
タイプ:
string
必須:true
取得するバックアップのIDです。
問合せのパラメータ
- includeLinkedDetails
-
タイプ:
boolean
trueに設定すると、リンクされた詳細が含まれます。false
レスポンス
サポートされるメディア・タイプ
- application/json
200レスポンス
承認済
本文
ルート・スキーマ: ViewTheBackupResponse。
タイプ:
object
タイトル:
ViewTheBackupResponse.
レスポンス本文には、バックアップに関する情報が含まれます
- backupCompleteDate
-
タイプ:
string
タイトル:BackupCompleteDate schema.
バックアップが完了した日時。 - backupId
-
タイプ:
string
タイトル:BackupId schema.
バックアップID。 - backupStartDate
-
タイプ:
string
タイトル:BackupStartDate schema.
バックアップが開始した日時。 - dbTag
-
タイプ:
string
タイトル:DbTag schema.
この属性はデータベースがバックアップに含まれていた場合にのみ含まれます。
Oracle Cloud Database Serviceデータベース・ファイルのID。 このIDは、データベースをリストアする必要がある場合に使用できます。 Oracle Cloud Database Serviceのリストアの詳細は、『Oracle Database Cloud - Database as a Serviceの使用』で特定のバックアップからのリストアに関する項を参照してください。 - expirationDate
-
タイプ:
null
タイトル:ExpirationDate schema.
バックアップが記憶域から自動的に削除される日時。 NULLに設定されている場合、バックアップは無期限に、または手動で削除されるまで保存されます。 - forceScaleInRequiredForRestore
-
タイプ:
string
タイトル:forceScaleInRequiredForRestore
現在のOracle SOA Cloud Serviceインスタンスで、このバックアップに含まれていない管理対象サーバーが構成されていることを示すメッセージ。 この値は、次の詳細を示すエラー・メッセージに設定されています:
「JAAS-BR-105: バックアップの一部でない管理対象サーバーの構成データをリストアできません。 影響する管理対象サーバーは次のとおりです: [managedserver_x, managedserver_y]。 インスタンスをスケール・インしてこれらの管理対象サーバー・ノードを削除し、インスタンスを再度リストアしてください。」
このバックアップを使用してOracle SOA Cloud Serverインスタンスをリストアする前に、次の手順のいずれかを実行します。
サービス・インスタンスをスケール・インして、前述のエラー・メッセージに記載されている管理対象サーバーを削除します。
Oracle SOA Cloud Serviceインスタンスを自動的にスケール・インするには、このバックアップを使用してリストアする際に、'forceScaleIn'属性をtrueに設定します(サービス・インスタンスのリストアを参照) - full
-
タイプ:
boolean
タイトル:Full schema.
これが全体バックアップ(true)か、増分バックアップ(false)かを指定するブール・フラグ。
全体バックアップには、すべてのサービス・インスタンス・ファイル(ランタイム・アーティファクトと、まれに変更されるかまったく変更しないファイル)が含まれます。
増分バックアップには、サービス・インスタンス内の各管理対象VMのランタイム・アーティファクトのみが含まれます。 - href
-
タイプ:
string
タイトル:Href schema.
バックアップ・リソースのURI。 - initiatedBy
-
タイプ:
string
タイトル:InitiatedBy schema.
この操作を開始したユーザー・アカウント。 - jobHistory
-
タイプ:
array
JobHistory schema.タイトル:JobHistory schema.
ジョブ履歴の詳細をグループ化します。 - local
-
タイプ:
boolean
タイトル:Local schema.
バックアップをディスクにローカルに(true)格納するか、Oracle Storage Cloud Serviceに(false)格納するかを指定するブール・フラグ。 - size
-
タイプ:
string
タイトル:Size schema.
バックアップのサイズ(MB単位)。 例:
- '1011.4MB' (バックアップが完了している場合)
- 'Unknown' (バックアップが進行中の場合)
ネスト・スキーマ: JobHistory schema。
ネスト・スキーマ: 1 schema.
タイプ:
object
タイトル:
1 schema.
バックアップ操作のジョブID。
- completeDate
-
タイプ:
string
タイトル:CompleteDate schema.
操作が完了した日時。 - jobId
-
タイプ:
string
タイトル:JobId schema.
バックアップ操作のジョブID。 - operation
-
タイプ:
string
タイトル:Operation schema.
実行された実行中の操作のタイプ。 たとえば、バックアップ、削除、ダウンロード、アップロードなどです。 - startDate
-
タイプ:
string
タイトル:StartDate schema.
操作が開始された日時。 - status
-
タイプ:
string
タイトル:Status schema.
バックアップの状態。 有効な値は次のとおりです。- '完了'
- '失敗'
- '削除済'
- 'バックアップ中'
- 'アップロード中'
- 'ダウンロード中'
- '削除中'
- statusDetails
-
タイプ:
string
タイトル:StatusDetails schema.
システム・メッセージの履歴。 各メッセージは、省略記号で区切られています。
例
次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによってOracle SOA Cloud Serviceインスタンスのバックアップについて詳細情報を表示する方法を示しています。 詳細は、「cURLの使用」を参照してください。
Oracle SOA Cloud Serviceインスタンスのオンデマンド・バックアップの開始に関する項も参照してください。
cURLコマンド
curl -i -X GET -u joe@example.com:Welcome1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance/backups/1390442367140
注意:: この例では、アメリカ合衆国でのURL接頭辞(soacs)を使用しています。 世界の他の地域のURL接頭辞の詳細は、「リクエストの送信」を参照してください。
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。
HTTP/1.1 200 OK Date: Thu, 04 Feb 2015 16:23:56 GMT Transfer-Encoding: chunked Content-Type: application/json
レスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{ "backupId":"1418313410612", "jobId":"18758", "backupStartDate":"Wed Feb 04 15:56:50 GMT 2015", "backupCompleteDate":"Wed Feb 04 16:04:10 GMT 2015", "expirationDate":null, "initiatedBy":"scheduled", "full":true, "local":true, "localCopy":true, "size":"1650.3MB", "sizeInBytes":1730501782, "dbTag":"TAG20150923T192248", "status":"Completed", "href":"https:\/\/api-host\/paas\/service\/soa\/api\/instances\/ExampleIdentityDomain\/ExampleInstance\/backups\/1418313410612", "jobHistory":[ { "operation":"upload", "jobId":"18767", "status":"In Progress", "startDate":"Wed Feb 04 16:19:12 GMT 2014" }, { "operation":"backup", "jobId":"18758", "status":"Completed", "startDate":"Wed Feb 04 15:56:50 GMT 2015", "completeDate":"Wed Feb 04 16:02:10 GMT 2015", "statusDetails":"Backup health check passed... Locked the WebLogic Server domain configuration... Started the backup of binary data for WebLogic Server administration server on host exampleinstance-1... Completed the backup of binary data for WebLogic Server administration server on host exampleinstance-1... Started the backup of configuration data for WebLogic Server managed servers on these hosts: exampleinstance-2 exampleinstance-1 ... Completed the backup of configuration data for WebLogic Server managed servers on these hosts: exampleinstance-2 exampleinstance-1... Started the backup of Oracle Traffic Director on host exampleinstance-lb-1... Completed the backup of Oracle TrafficDirector on host exampleinstance-lb-1... Unlocked the WebLogic Server domain configuration..." } ], "notes":"Automated backup" }