バックアップの構成
post
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/databases/{databaseId}/actions/configureBackup
指定の宛先メディアへのデータベース・バックアップを構成します。
リクエスト
パス・パラメータ
- databaseId(必須): string
データベース・ターゲットGUID。例:
BD01EACD2378730AE053178145645588
ヘッダー・パラメータ
- 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/ConfigBackupDetailsOCIWithOCIMediaSettings", "RA":"#/components/schemas/ConfigBackupDetailsRA" } }
送信されたバックアップ構成の詳細が含まれます。
ネストされたスキーマ: Discriminator: destinationMediaType
型:
object
弁別子: destinationMediaType
弁別子の値
送信されたバックアップ構成の詳細が含まれます。
1つのスキーマに一致
ソースの表示
- OCI - object ConfigBackupDetailsOCIWithOCIMediaSettings
Oracle Cloud Infrastructure用のバックアップの構成の詳細。
- RA - object ConfigBackupDetailsRA
リカバリ・アプライアンス用のバックアップの構成の詳細。
ネストされたスキーマ: ConfigBackupDetailsOCIWithOCIMediaSettings
型:
object
Oracle Cloud Infrastructure用のバックアップの構成の詳細。
ソースの表示
-
advanced: object advanced
拡張パラメータ。
-
compartmentOCID(必須): string
コンテナOCID。例:
ocid1.compartment.oc1..aaaaaaaa7dlb5auhlhvhe3e6xz2hhjy64hujbwriad76q45xu2fkg6yu6fpq
-
destinationMediaType(必須): string
宛先メディア・タイプ。例:
OCI
-
isOCIBucketImmutable: boolean
指定されたバケットが不変バケットかどうかを指定します。例:
true
-
ociBucket(必須): string
バケット。例:
Backup1
-
ociEndPoint(必須): string
APIエンドポイント。例:
https://objectstorage.us-ashburn-1.oraclecloud.com
-
tempMetadataOCIBucket: string
指定されたociBucketが不変バケットの場合に、バックアップ中に更新または削除する必要があるオブジェクトの格納に使用される一時的なメタデータ・バケット。例:
tempBucket1
ネストされたスキーマ: ConfigBackupDetailsRA
型:
object
リカバリ・アプライアンス用のバックアップの構成の詳細。
ソースの表示
-
advanced: object advanced
拡張パラメータ。
-
backupConfig: string
指定可能な値:
[ "NO_DG", "ALL_DG" ]
バックアップ構成。例:ALL_DG
-
backupModuleParameters: object backupModuleParameters
バックアップ・モジュール関連のパラメータ。
-
destinationMediaType(必須): string
宛先メディア・タイプ。例:
RA
-
isDatabaseRestartPermitted: 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
例
先頭に戻る
レスポンス
サポートされているメディア・タイプ
- application/json
202レスポンス
発行されたデプロイメント・プロシージャの実行の詳細。
ヘッダー
- Content-Location:
発行されたデプロイメント・プロシージャの実行の詳細。
ルート・スキーマ: DatabaseBackupResponse
型:
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