バックアップのフリート構成
post
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/databases/actions/bulkConfigureBackup
指定の宛先メディアにバックアップするように複数のデータベースを構成します。このAPIでは、選択した宛先がリカバリ・アプライアンスの場合、リカバリ・アプライアンスでZDLRA管理パックを有効にする必要があります。
リクエスト
ヘッダー・パラメータ
- ORCL-EM-DBTARGET-AUTHORIZATION(必須):
データベースへの接続に使用されるデータベース資格証明。
- ORCL-EM-HOSTTARGET-AUTHORIZATION(必須):
データベースのバックアップおよびリカバリ操作の実行に使用されるオペレーティング・システム資格証明であるホスト資格証明。
- ORCL-EM-OCITARGET-AUTHORIZATION(必須):
Oracle Cloud Infrastructure資格証明。
- ORCL-EM-RTUTARGET-AUTHORIZATION:
REDOトランスポート・ユーザーのパスワード用の名前付き資格証明。
- ORCL-EM-TDEWALLETTARGET-AUTHORIZATION:
パスワード保護されたTDEウォレット用の名前付き資格証明。
- ORCL-EM-WALLETTARGET-AUTHORIZATION:
パスワード保護されたバックアップ・ウォレット用の名前付き資格証明。
- ORCL_EM_PROXYTARGET_AUTHORIZATION:
プロキシ・ターゲット認可用の名前付き資格証明。
サポートされているメディア・タイプ
- application/json
ルート・スキーマ: schema
型:
object
バックアップの一括構成の詳細。
ソースの表示
-
backupConfiguration: object Discriminator: destinationMediaType
弁別子:
{ "propertyName":"destinationMediaType", "mapping":{ "OCI":"#/components/schemas/ConfigBackupDetailsOCI", "RA":"#/components/schemas/BulkConfigBackupDetailsRA" } }
バックアップ構成の詳細が含まれます。 -
ociMediaSettings: array ociMediaSettings
データベースのバックアップの送信先として構成されるOracle Cloud Infrastructureの設定の詳細。
-
recoveryApplianceMediaSettings: array recoveryApplianceMediaSettings
データベースのバックアップの送信先として構成されるリカバリ・アプライアンスの詳細。
-
schedule: Discriminator: type
弁別子:
{ "propertyName":"type", "mapping":{ "immediately":"#/components/schemas/ScheduleImmediately", "later":"#/components/schemas/ScheduleLater", "repeating":"#/components/schemas/ScheduleRepeating" } }
デプロイメント・プロシージャのスケジュールを指定します。 -
targetList: array targetList
バックアップを送信するように構成されるデータベース・ターゲットの詳細が含まれます。
ネストされたスキーマ: Discriminator: destinationMediaType
型:
object
弁別子: destinationMediaType
弁別子の値
バックアップ構成の詳細が含まれます。
1つのスキーマに一致
ソースの表示
- OCI - object ConfigBackupDetailsOCI
Oracle Cloud Infrastructure用のバックアップの構成の詳細。
- RA - object BulkConfigBackupDetailsRA
リカバリ・アプライアンス用のバックアップの一括構成の詳細。
ネストされたスキーマ: ociMediaSettings
型:
array
データベースのバックアップの送信先として構成されるOracle Cloud Infrastructureの設定の詳細。
ソースの表示
ネストされたスキーマ: recoveryApplianceMediaSettings
型:
array
データベースのバックアップの送信先として構成されるリカバリ・アプライアンスの詳細。
ソースの表示
ネストされたスキーマ: Discriminator: type
型:
object
弁別子: type
弁別子の値
デプロイメント・プロシージャのスケジュールを指定します。
1つのスキーマに一致
ソースの表示
- immediately - object ScheduleImmediately
即時スケジュール。
- later - object ScheduleLater
後でスケジュール。
- object Discriminator: repeatFrequency
弁別子:
{ "propertyName":"repeatFrequency", "mapping":{ "WEEKLY":"#/components/schemas/ScheduleWeekly", "MONTHLY":"#/components/schemas/ScheduleMonthly", "YEARLY":"#/components/schemas/ScheduleYearly", "INTERVAL":"#/components/schemas/ScheduleInterval" } }
繰返しスケジュール。
ネストされたスキーマ: ConfigBackupDetailsOCI
型:
object
Oracle Cloud Infrastructure用のバックアップの構成の詳細。
ソースの表示
-
advanced: object advanced
拡張パラメータ。
-
destinationMediaType(必須): string
宛先メディア・タイプ。例:
OCI
ネストされたスキーマ: BulkConfigBackupDetailsRA
型:
object
リカバリ・アプライアンス用のバックアップの一括構成の詳細。
ソースの表示
-
advanced: object advanced
拡張パラメータ。
-
backupConfig: string
指定可能な値:
[ "NO_DG", "ALL_DG", "CUSTOM_DG", "GOLD", "GOLD_WITH_REP" ]
バックアップ構成。例:ALL_DG
-
backupModuleParameters: object backupModuleParameters
バックアップ・モジュール関連のパラメータ。
-
destinationMediaType(必須): string
宛先メディア・タイプ。例:
RA
-
isBRContinuity: boolean
データベースをバックアップおよびリカバリの継続性で構成する必要があるかどうかを指定します。例:
false
-
isDatabaseRestartPermitted: boolean
構成プロシージャで必要な場合にデータベースの再起動を許可するかどうかを指定します。例:
false
-
isForceRestartDB: boolean
構成プロシージャ中にデータベースを確実に再起動する必要があるかどうかを指定します。例:
false
-
isShipRedo: boolean
REDOログを送信する必要があるかどうかを指定します。例:
true
-
isSkipControlfileAutobackup: boolean
制御ファイルのバックアップをスキップするかどうかを指定します。例:
true
-
isUpdateSnapshotControlfileLoc: boolean
スナップショット制御ファイルを更新するかどうかを指定します。例:
false
-
protocol: string
指定可能な値:
[ "TCP", "TCPS" ]
リカバリ・アプライアンスにバックアップを送信するようデータベースを構成するために使用されるプロトコル。デフォルトはTCPS (リカバリ・アプライアンスがTLSのみモードまたはDUALモードで構成されている場合)。または、TCP (そうでない場合)。例:TCP
-
walletParameters: object walletParameters
ウォレット関連のパラメータ。
ネストされたスキーマ: advanced
型:
object
拡張パラメータ。
ソースの表示
-
forceSerialExecution: boolean
Enterprise Managerの構成デプロイメント・プロシージャで、一度に1つのデータベースを処理する必要があるか、パラレルに処理する必要があるかを指定します。例:
true
-
installerArgs: array installerArgs
Oracle Cloudへのデータベース・バックアップを構成するためにOracle Cloud Infrastructureインストーラの起動時に指定する追加の引数。
-
parallelism: number
Oracle Cloud InfrastructureバックアップのデータベースRMAN設定に設定するSBTチャネルの数。例:
1
-
proxyHost: string
データベース・ターゲット・ホストへのOracle Cloud Infrastructureバックアップ・モジュールのダウンロード時に使用されるプロキシ・ホスト。
-
proxyPort: integer
データベース・ターゲット・ホストへのOracle Cloud Infrastructureバックアップ・モジュールのダウンロード時に使用されるプロキシ・ポート。
-
skipConfiguredDbs: boolean
指定の宛先メディアにバックアップするようにすでに構成されているデータベースをスキップするかどうかを指定します。例:
true
ネストされたスキーマ: installerArgs
型:
array
Oracle Cloudへのデータベース・バックアップを構成するためにOracle Cloud Infrastructureインストーラの起動時に指定する追加の引数。
ソースの表示
- 配列: string
例:
-proxyHost abc
例:
[
"-proxyHost abc",
"-proxyPort 80"
]
ネストされたスキーマ: advanced
型:
object
拡張パラメータ。
ソースの表示
-
parallelism: number
Oracle Cloud InfrastructureバックアップのデータベースRMAN設定に設定するSBTチャネルの数。例:
1
ネストされたスキーマ: backupModuleParameters
型:
object
バックアップ・モジュール関連のパラメータ。
ソースの表示
-
isDownloadBackupModule: boolean
最新のバックアップ・モジュールをソフトウェア・ライブラリにダウンロードする必要があるかどうかを指定します。例:
false
-
isForceInstallBackupModule: boolean
最新のバックアップ・モジュールをソフトウェア・ライブラリからプッシュして、データベースOracleホームまたはバックアップ・モジュールの場所(指定されている場合)にインストールする必要があるかどうかを指定します。例:
false
-
moduleLocation: string
バックアップ・モジュールのカスタムの場所。デフォルトは、$ORACLE_HOME/libです。例:
$ORACLE_HOME/lib
ネストされたスキーマ: walletParameters
型:
object
ウォレット関連のパラメータ。
ソースの表示
-
isSetWalletRoot: boolean
WALLET_ROOTデータベース初期化パラメータを設定するかどうかを指定します。例:
false
-
isUpdateCRSEnv: boolean
SRVCTLコマンドを使用して、必要な環境変数(ORACLE_HOME、ORACLE_BASE、DB_UNIQUE_NAME、ORACLE_UNQNAME)をCluster Ready Services (CRS)で更新するかどうかを指定します。例:
false
-
isUpdateSQLNet: boolean
SQLNET.WALLET_LOCATIONを更新する必要があるかどうかを指定します。例:
false
-
walletLocation: string
ウォレットの場所。例:
$ORACLE_HOME/dbs/wallet
ネストされたスキーマ: items
型:
ソースの表示
object
-
compartmentOCID: string
コンテナOCID。例:
ocid1.compartment.oc1..aaaaaaaa7dlb5auhlhvhe3e6xz2hhjy64hujbwriad76q45xu2fkg6yu6fpq
-
isOCIBucketImmutable: boolean
指定されたバケットが不変バケットかどうかを指定します。例:
true
-
ociBucket: string
バケット。例:
Backup1
-
ociEndPoint: string
APIエンドポイント。例:
https://objectstorage.us-ashburn-1.oraclecloud.com
-
settingsId: number
索引。例:
1
-
tempMetadataOCIBucket: string
指定されたociBucketが不変バケットの場合に、バックアップ中に更新または削除する必要があるオブジェクトの格納に使用される一時的なメタデータ・バケット。例:
tempBucket1
ネストされたスキーマ: items
型:
ソースの表示
object
-
overrideConnDesc: string
オーバーライド接続記述子。例:
(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)))
-
protocol: string
指定可能な値:
[ "TCP", "TCPS" ]
リカバリ・アプライアンスにバックアップを送信するようデータベースを構成するために使用されるプロトコル。デフォルトはTCPS (リカバリ・アプライアンスがTLSのみモードまたはDUALモードで構成されている場合)。または、TCP (そうでない場合)。例:TCP
-
raTargetName: string
リカバリ・アプライアンス・ターゲット名。例:
RA19000
-
raTargetType: string
リカバリ・アプライアンス・ターゲット・タイプ。例:
oracle_dblra
-
settingsId: number
リカバリ・アプライアンスのメディア設定索引。[1-16]は、使用可能な索引です。例:
1
-
vpcUserName: string
仮想プライベート・カタログ・ユーザー名。例:
bkpUser1
ネストされたスキーマ: ScheduleImmediately
型:
object
即時スケジュール。
ソースの表示
-
type(必須): string
スケジュールのタイプ。例:
immediately
ネストされたスキーマ: ScheduleLater
型:
object
後でスケジュール。
ソースの表示
-
startTime:
date-time
デプロイメント・プロシージャの開始がスケジュールされている日付。yyyy/MM/dd HH:mm形式の文字列として指定されます。例:2021/08/30 23:00
-
timeZone: string
Javaタイムゾーン。例:
America/New_York
-
type(必須): string
スケジュールのタイプ。例:
later
ネストされたスキーマ: Discriminator: repeatFrequency
型:
object
弁別子: repeatFrequency
弁別子の値
繰返しスケジュール。
すべてに一致
繰返しスケジュール。
ソースの表示
- object ScheduleRepeatingBase
繰返しスケジュール。
1つのスキーマに一致
ソースの表示
- WEEKLY - object ScheduleWeekly
繰返し頻度(週次)の値を繰り返します。
- MONTHLY - object ScheduleMonthly
繰返し頻度(月次)の値を繰り返します。
- YEARLY - object ScheduleYearly
繰返し頻度(年次)の値を繰り返します。
- INTERVAL - object ScheduleInterval
繰返し頻度(間隔)の値を繰り返します。
ネストされたスキーマ: ScheduleRepeatingBase
型:
object
繰返しスケジュール。
ソースの表示
-
endtime:
date-time
ジョブの有効期限が切れる日付。yyyy/MM/dd HH:mm形式の文字列として指定されます。指定しない場合、繰返しは永久に続きます。例:2021/08/30 23:00
-
repeatFrequency(必須): string
指定可能な値:
[ "WEEKLY", "MONTHLY", "YEARLY", "INTERVAL" ]
繰返し頻度タイプ。 -
startTime(必須):
date-time
デプロイメント・プロシージャの開始がスケジュールされている日付。yyyy/MM/dd HH:mm形式の文字列として指定されます。例:2021/08/30 23:00
-
timeZone: string
Javaタイムゾーン。例:
America/New_York
-
type(必須): string
スケジュールのタイプ。例:
repeating
ネストされたスキーマ: ScheduleYearly
型:
object
繰返し頻度(年次)の値を繰り返します。
ソースの表示
-
months(必須): array months
年次の値を繰り返します。
ネストされたスキーマ: ScheduleInterval
型:
object
繰返し頻度(間隔)の値を繰り返します。
ソースの表示
-
repeatEvery(必須): string
N値ごとに繰り返します - m(分)、h(時間)、d(日)、w(週)。例:
10m, 3h, 5d, 2w
ネストされたスキーマ: days
型:
array
曜日。
ソースの表示
- 配列: integer
指定可能な値:
[ "1", "2", "3", "4", "5", "6", "7" ]
曜日。日曜日は1、月曜日は2など。
例:
1,4
ネストされたスキーマ: days
型:
array
月次の値を繰り返します。
ソースの表示
- 配列: integer
日番号。int -1、1..5は、どの日番号かを表します。-1は最後の日を表します。
例:
1,30,31
ネストされたスキーマ: months
型:
array
年次の値を繰り返します。
ソースの表示
- 配列: integer
月番号。int 1、2、3..は、月(1月、2月、3月など)を表します。
例:
1,3
ネストされたスキーマ: items
型:
ソースの表示
object
-
alternateOverrideConnDesc: string
代替オーバーライド接続記述子。例:
(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)))
-
alternateRecoveryApplianceSettingsId: number
代替リカバリ・アプライアンスのメディア設定索引。例:
2
-
databaseCredentials: string
データベースへの接続に使用されるデータベース資格証明。例:
NAMED:NC_DB1:SYSMAN
-
hostCredentials: string
データベースのバックアップおよびリカバリ操作の実行に使用されるオペレーティング・システム資格証明であるホスト資格証明。例:
NAMED:NC_VMUSER:SYSMAN
-
isForceInstallBackupModule: boolean
最新のバックアップ・モジュールをソフトウェア・ライブラリからプッシュして、データベースOracleホームまたはバックアップ・モジュールの場所(指定されている場合)にインストールする必要があるかどうかを指定します。例:
false
-
ociMediaSettingsId: string
Oracle Cloud Infrastructureのメディア設定索引。例:
1
-
overallOverrideConnDesc: string
バックアップおよびリカバリの継続性のオーバーライド接続記述子。例:
(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)))
-
overrideConnDesc: string
オーバーライド接続記述子。例:
(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)))
-
parallelism: number
バックアップのデータベースRMAN設定に設定するSBTチャネルの数。例:
1
-
protocol: string
指定可能な値:
[ "TCP", "TCPS" ]
リカバリ・アプライアンスにバックアップを送信するようデータベースを構成するために使用されるプロトコル。デフォルトはTCPS (リカバリ・アプライアンスがTLSのみモードまたはDUALモードで構成されている場合)。または、TCP (そうでない場合)。例:TCP
-
raCommonVpcUserName: string
共通仮想プライベート・カタログ・ユーザー名。例:
bkpUser1
-
recoveryApplianceSettingsId: number
リカバリ・アプライアンスのメディア設定索引。例:
1
-
targetName: string
データベース・ターゲット名。例:
DB19000
-
targetType: string
データベース・ターゲット・タイプ。例:
oracle_database
例
先頭に戻る
レスポンス
サポートされているメディア・タイプ
- application/json
202レスポンス
発行されたデプロイメント・プロシージャの実行の詳細。
ヘッダー
- Content-Location:
発行されたデプロイメント・プロシージャの実行の詳細。
ルート・スキーマ: BulkConfigureBackupDatabase
型:
object
発行された操作のステータス。
ソースの表示
-
executionId(必須): string
デプロイメント・プロシージャの実行ID。例:
DE8676BE8CD73086E053DE0D4B64D288
-
location: string
発行されたデプロイメント・プロシージャのステータスを検証するURI。例:
/em/api/deploymentProcedureInstances/DE8676BE8CD73086E053DE0D4B64D288
-
procedureId(必須): string
デプロイメント・プロシージャの発行ID。例:
DE8676BE8CD73086E053DE0D4B64D288
-
submissionBy(必須): string
デプロイメント・プロシージャを発行したユーザー。例:
SYSMAN
-
submissionName(必須): string
発行されたデプロイメント・プロシージャの名前。例:
BACKUP_RA_CONFIG_121222220321
400レスポンス
不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません
ルート・スキーマ: ErrorResponse
型:
object
エラー発生時に返送されるレスポンス
ソースの表示
-
code: string
エラーのステータス・コード。例:
IllegalArgument
-
message: string
説明的なエラー・メッセージ例:
argument given is not supported
401レスポンス
未認可。ユーザーにはリクエストされた操作を実行する権限がありません
ルート・スキーマ: ErrorResponse
型:
object
エラー発生時に返送されるレスポンス
ソースの表示
-
code: string
エラーのステータス・コード。例:
IllegalArgument
-
message: string
説明的なエラー・メッセージ例:
argument given is not supported
403レスポンス
禁止。ユーザーは、リクエストされた操作の実行を禁止されています
ルート・スキーマ: ErrorResponse
型:
object
エラー発生時に返送されるレスポンス
ソースの表示
-
code: string
エラーのステータス・コード。例:
IllegalArgument
-
message: string
説明的なエラー・メッセージ例:
argument given is not supported
404レスポンス
見つかりません。リクエストされたREST API URLが見つかりません。
ルート・スキーマ: ErrorResponse
型:
object
エラー発生時に返送されるレスポンス
ソースの表示
-
code: string
エラーのステータス・コード。例:
IllegalArgument
-
message: string
説明的なエラー・メッセージ例:
argument given is not supported
500レスポンス
内部サーバー・エラー。REST APIの実行中に例外が発生しました。
ルート・スキーマ: ErrorResponse
型:
object
エラー発生時に返送されるレスポンス
ソースの表示
-
code: string
エラーのステータス・コード。例:
IllegalArgument
-
message: string
説明的なエラー・メッセージ例:
argument given is not supported
503レスポンス
サービスが使用できません。サーバーはリクエストを処理できません。
ルート・スキーマ: ErrorResponse
型:
object
エラー発生時に返送されるレスポンス
ソースの表示
-
code: string
エラーのステータス・コード。例:
IllegalArgument
-
message: string
説明的なエラー・メッセージ例:
argument given is not supported