バックアップのフリート構成

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/databases/actions/bulkConfigureBackup

指定の宛先メディアにバックアップするように複数のデータベースを構成します。このAPIでは、選択した宛先がリカバリ・アプライアンスの場合、リカバリ・アプライアンスでZDLRA管理パックを有効にする必要があります。

リクエスト

ヘッダー・パラメータ
サポートされているメディア・タイプ
リクエスト本文 - application/json ()
ルート・スキーマ: schema
型: object
バックアップの一括構成の詳細。
ソースの表示
ネストされたスキーマ: Discriminator: destinationMediaType
型: object
弁別子: destinationMediaType

弁別子の値

バックアップ構成の詳細が含まれます。
1つのスキーマに一致
ソースの表示
ネストされたスキーマ: ociMediaSettings
型: array
データベースのバックアップの送信先として構成されるOracle Cloud Infrastructureの設定の詳細。
ソースの表示
ネストされたスキーマ: recoveryApplianceMediaSettings
型: array
データベースのバックアップの送信先として構成されるリカバリ・アプライアンスの詳細。
ソースの表示
ネストされたスキーマ: Discriminator: type
型: object
弁別子: type

弁別子の値

デプロイメント・プロシージャのスケジュールを指定します。
1つのスキーマに一致
ソースの表示
ネストされたスキーマ: targetList
型: array
バックアップを送信するように構成されるデータベース・ターゲットの詳細が含まれます。
ソースの表示
ネストされたスキーマ: ConfigBackupDetailsOCI
型: object
Oracle Cloud Infrastructure用のバックアップの構成の詳細。
ソースの表示
ネストされたスキーマ: BulkConfigBackupDetailsRA
型: object
リカバリ・アプライアンス用のバックアップの一括構成の詳細。
ソースの表示
ネストされたスキーマ: advanced
型: object
拡張パラメータ。
ソースの表示
  • Enterprise Managerの構成デプロイメント・プロシージャで、一度に1つのデータベースを処理する必要があるか、パラレルに処理する必要があるかを指定します。
    例: true
  • installerArgs
    Oracle Cloudへのデータベース・バックアップを構成するためにOracle Cloud Infrastructureインストーラの起動時に指定する追加の引数。
  • Oracle Cloud InfrastructureバックアップのデータベースRMAN設定に設定するSBTチャネルの数。
    例: 1
  • データベース・ターゲット・ホストへのOracle Cloud Infrastructureバックアップ・モジュールのダウンロード時に使用されるプロキシ・ホスト。
  • データベース・ターゲット・ホストへのOracle Cloud Infrastructureバックアップ・モジュールのダウンロード時に使用されるプロキシ・ポート。
  • 指定の宛先メディアにバックアップするようにすでに構成されているデータベースをスキップするかどうかを指定します。
    例: true
ネストされたスキーマ: installerArgs
型: array
Oracle Cloudへのデータベース・バックアップを構成するためにOracle Cloud Infrastructureインストーラの起動時に指定する追加の引数。
ソースの表示
例:
[
    "-proxyHost abc",
    "-proxyPort 80"
]
ネストされたスキーマ: advanced
型: object
拡張パラメータ。
ソースの表示
  • Oracle Cloud InfrastructureバックアップのデータベースRMAN設定に設定するSBTチャネルの数。
    例: 1
ネストされたスキーマ: backupModuleParameters
型: object
バックアップ・モジュール関連のパラメータ。
ソースの表示
  • 最新のバックアップ・モジュールをソフトウェア・ライブラリにダウンロードする必要があるかどうかを指定します。
    例: false
  • 最新のバックアップ・モジュールをソフトウェア・ライブラリからプッシュして、データベースOracleホームまたはバックアップ・モジュールの場所(指定されている場合)にインストールする必要があるかどうかを指定します。
    例: false
  • バックアップ・モジュールのカスタムの場所。デフォルトは、$ORACLE_HOME/libです。
    例: $ORACLE_HOME/lib
ネストされたスキーマ: walletParameters
型: object
ウォレット関連のパラメータ。
ソースの表示
  • WALLET_ROOTデータベース初期化パラメータを設定するかどうかを指定します。
    例: false
  • SRVCTLコマンドを使用して、必要な環境変数(ORACLE_HOME、ORACLE_BASE、DB_UNIQUE_NAME、ORACLE_UNQNAME)をCluster Ready Services (CRS)で更新するかどうかを指定します。
    例: false
  • SQLNET.WALLET_LOCATIONを更新する必要があるかどうかを指定します。
    例: false
  • ウォレットの場所。
    例: $ORACLE_HOME/dbs/wallet
ネストされたスキーマ: items
型: object
ソースの表示
ネストされたスキーマ: items
型: object
ソースの表示
  • オーバーライド接続記述子。
    例: (DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=example01-vip.us.oracle.com)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=example02-vip.us.oracle.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=exapl)))
  • 指定可能な値: [ "TCP", "TCPS" ]
    リカバリ・アプライアンスにバックアップを送信するようデータベースを構成するために使用されるプロトコル。デフォルトはTCPS (リカバリ・アプライアンスがTLSのみモードまたはDUALモードで構成されている場合)。または、TCP (そうでない場合)。
    例: TCP
  • リカバリ・アプライアンス・ターゲット名。
    例: RA19000
  • リカバリ・アプライアンス・ターゲット・タイプ。
    例: oracle_dblra
  • リカバリ・アプライアンスのメディア設定索引。[1-16]は、使用可能な索引です。
    例: 1
  • 仮想プライベート・カタログ・ユーザー名。
    例: bkpUser1
ネストされたスキーマ: ScheduleImmediately
型: object
即時スケジュール。
ソースの表示
ネストされたスキーマ: ScheduleLater
型: object
後でスケジュール。
ソースの表示
  • デプロイメント・プロシージャの開始がスケジュールされている日付。yyyy/MM/dd HH:mm形式の文字列として指定されます。
    例: 2021/08/30 23:00
  • Javaタイムゾーン。
    例: America/New_York
  • スケジュールのタイプ。
    例: later
ネストされたスキーマ: Discriminator: repeatFrequency
型: object
弁別子: repeatFrequency

弁別子の値

繰返しスケジュール。
すべてに一致
繰返しスケジュール。
ソースの表示
1つのスキーマに一致
ソースの表示
ネストされたスキーマ: ScheduleRepeatingBase
型: object
繰返しスケジュール。
ソースの表示
  • ジョブの有効期限が切れる日付。yyyy/MM/dd HH:mm形式の文字列として指定されます。指定しない場合、繰返しは永久に続きます。
    例: 2021/08/30 23:00
  • 指定可能な値: [ "WEEKLY", "MONTHLY", "YEARLY", "INTERVAL" ]
    繰返し頻度タイプ。
  • デプロイメント・プロシージャの開始がスケジュールされている日付。yyyy/MM/dd HH:mm形式の文字列として指定されます。
    例: 2021/08/30 23:00
  • Javaタイムゾーン。
    例: America/New_York
  • スケジュールのタイプ。
    例: repeating
ネストされたスキーマ: ScheduleWeekly
型: object
繰返し頻度(週次)の値を繰り返します。
ソースの表示
ネストされたスキーマ: ScheduleMonthly
型: object
繰返し頻度(月次)の値を繰り返します。
ソースの表示
ネストされたスキーマ: ScheduleYearly
型: object
繰返し頻度(年次)の値を繰り返します。
ソースの表示
ネストされたスキーマ: ScheduleInterval
型: object
繰返し頻度(間隔)の値を繰り返します。
ソースの表示
ネストされたスキーマ: days
型: array
曜日。
ソースの表示
  • 指定可能な値: [ "1", "2", "3", "4", "5", "6", "7" ]
    曜日。日曜日は1、月曜日は2など。
例:
1,4
ネストされたスキーマ: days
型: array
月次の値を繰り返します。
ソースの表示
  • 日番号。int -1、1..5は、どの日番号かを表します。-1は最後の日を表します。
例:
1,30,31
ネストされたスキーマ: months
型: array
年次の値を繰り返します。
ソースの表示
  • 月番号。int 1、2、3..は、月(1月、2月、3月など)を表します。
例:
1,3
ネストされたスキーマ: items
型: object
ソースの表示
  • 代替オーバーライド接続記述子。
    例: (DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=example01-vip.us.oracle.com)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=example02-vip.us.oracle.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=exapl)))
  • 代替リカバリ・アプライアンスのメディア設定索引。
    例: 2
  • データベースへの接続に使用されるデータベース資格証明。
    例: NAMED:NC_DB1:SYSMAN
  • データベースのバックアップおよびリカバリ操作の実行に使用されるオペレーティング・システム資格証明であるホスト資格証明。
    例: NAMED:NC_VMUSER:SYSMAN
  • 最新のバックアップ・モジュールをソフトウェア・ライブラリからプッシュして、データベースOracleホームまたはバックアップ・モジュールの場所(指定されている場合)にインストールする必要があるかどうかを指定します。
    例: false
  • Oracle Cloud Infrastructureのメディア設定索引。
    例: 1
  • バックアップおよびリカバリの継続性のオーバーライド接続記述子。
    例: (DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=example01-vip.us.oracle.com)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=example02-vip.us.oracle.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=exapl)))
  • オーバーライド接続記述子。
    例: (DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=example01-vip.us.oracle.com)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=example02-vip.us.oracle.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=exapl)))
  • バックアップのデータベースRMAN設定に設定するSBTチャネルの数。
    例: 1
  • 指定可能な値: [ "TCP", "TCPS" ]
    リカバリ・アプライアンスにバックアップを送信するようデータベースを構成するために使用されるプロトコル。デフォルトはTCPS (リカバリ・アプライアンスがTLSのみモードまたはDUALモードで構成されている場合)。または、TCP (そうでない場合)。
    例: TCP
  • 共通仮想プライベート・カタログ・ユーザー名。
    例: bkpUser1
  • リカバリ・アプライアンスのメディア設定索引。
    例: 1
  • データベース・ターゲット名。
    例: DB19000
  • データベース・ターゲット・タイプ。
    例: oracle_database

先頭に戻る

レスポンス

サポートされているメディア・タイプ

202レスポンス

発行されたデプロイメント・プロシージャの実行の詳細。
ヘッダー
  • 発行されたデプロイメント・プロシージャの実行の詳細。
本文()
ルート・スキーマ: BulkConfigureBackupDatabase
型: object
発行された操作のステータス。
ソースの表示

400レスポンス

不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません
本文()
ルート・スキーマ: ErrorResponse
型: object
エラー発生時に返送されるレスポンス
ソースの表示
  • エラーのステータス・コード。
    例: IllegalArgument
  • 説明的なエラー・メッセージ
    例: argument given is not supported

401レスポンス

未認可。ユーザーにはリクエストされた操作を実行する権限がありません
本文()
ルート・スキーマ: ErrorResponse
型: object
エラー発生時に返送されるレスポンス
ソースの表示
  • エラーのステータス・コード。
    例: IllegalArgument
  • 説明的なエラー・メッセージ
    例: argument given is not supported

403レスポンス

禁止。ユーザーは、リクエストされた操作の実行を禁止されています
本文()
ルート・スキーマ: ErrorResponse
型: object
エラー発生時に返送されるレスポンス
ソースの表示
  • エラーのステータス・コード。
    例: IllegalArgument
  • 説明的なエラー・メッセージ
    例: argument given is not supported

404レスポンス

見つかりません。リクエストされたREST API URLが見つかりません。
本文()
ルート・スキーマ: ErrorResponse
型: object
エラー発生時に返送されるレスポンス
ソースの表示
  • エラーのステータス・コード。
    例: IllegalArgument
  • 説明的なエラー・メッセージ
    例: argument given is not supported

500レスポンス

内部サーバー・エラー。REST APIの実行中に例外が発生しました。
本文()
ルート・スキーマ: ErrorResponse
型: object
エラー発生時に返送されるレスポンス
ソースの表示
  • エラーのステータス・コード。
    例: IllegalArgument
  • 説明的なエラー・メッセージ
    例: argument given is not supported

503レスポンス

サービスが使用できません。サーバーはリクエストを処理できません。
本文()
ルート・スキーマ: ErrorResponse
型: object
エラー発生時に返送されるレスポンス
ソースの表示
  • エラーのステータス・コード。
    例: IllegalArgument
  • 説明的なエラー・メッセージ
    例: argument given is not supported
先頭に戻る