Oracle Enterprise ManagerのREST API

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

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

バックアップを送信するように構成されるデータベース・ターゲットの詳細が含まれます。

{
    "type":"object",
    "description":"Bulk Config Backup Details.",
    "properties":{
        "recoveryApplianceMediaSettings":{
            "type":"array",
            "description":"Details of Recovery Appliances to which the databases will be configured to send backups.",
            "items":{
                "type":"object",
                "properties":{
                    "settingsId":{
                        "type":"number",
                        "description":"Recovery Appliance media settings index. [1-16] are the allowed indexes.",
                        "example":"1"
                    },
                    "raTargetName":{
                        "type":"string",
                        "description":"Recovery Appliance target name.",
                        "example":"RA19000"
                    },
                    "raTargetType":{
                        "type":"string",
                        "description":"Recovery Appliance target type.",
                        "example":"oracle_dblra"
                    },
                    "protocol":{
                        "type":"string",
                        "description":"Protocol that will be used to configure databases to send backups to Recovery Appliance. Default is TCPS, if the Recovery Appliance is configured in either the TLS only mode or DUAL mode. If not, TCP.",
                        "enum":[
                            "TCP",
                            "TCPS"
                        ],
                        "example":"TCP"
                    },
                    "vpcUserName":{
                        "type":"string",
                        "description":"Virtual private catalog user name.",
                        "example":"bkpUser1"
                    },
                    "overrideConnDesc":{
                        "type":"string",
                        "description":"Override connect descriptor.",
                        "example":"(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)))"
                    }
                }
            }
        },
        "ociMediaSettings":{
            "type":"array",
            "description":"Details of Oracle Cloud Infrastructure settings to which the databases will be configured to send backups.",
            "items":{
                "type":"object",
                "properties":{
                    "settingsId":{
                        "type":"number",
                        "description":"Index.",
                        "example":"1"
                    },
                    "ociEndPoint":{
                        "type":"string",
                        "description":"API EndPoint.",
                        "example":"https://objectstorage.us-ashburn-1.oraclecloud.com"
                    },
                    "ociBucket":{
                        "type":"string",
                        "description":"Bucket.",
                        "example":"Backup1"
                    },
                    "tempMetadataOCIBucket":{
                        "type":"string",
                        "description":"Temporary metadata bucket that will be used to store objects that needs to be updated or deleted during backup if the ociBucket specified is an immutable bucket.",
                        "example":"tempBucket1"
                    },
                    "isOCIBucketImmutable":{
                        "type":"boolean",
                        "description":"Specifies if the bucket specified is an immutable bucket.",
                        "example":true
                    },
                    "compartmentOCID":{
                        "type":"string",
                        "description":"Container OCID.",
                        "example":"ocid1.compartment.oc1..aaaaaaaa7dlb5auhlhvhe3e6xz2hhjy64hujbwriad76q45xu2fkg6yu6fpq"
                    }
                }
            }
        },
        "targetList":{
            "type":"array",
            "description":"Contains details of database targets that will be configured to send backups.",
            "items":{
                "type":"object",
                "properties":{
                    "targetName":{
                        "type":"string",
                        "description":"Database target name.",
                        "example":"DB19000"
                    },
                    "targetType":{
                        "type":"string",
                        "description":"Database target type.",
                        "example":"oracle_database"
                    },
                    "databaseCredentials":{
                        "type":"string",
                        "description":"Database credentials used to connect to the database.",
                        "example":"NAMED:NC_DB1:SYSMAN"
                    },
                    "hostCredentials":{
                        "type":"string",
                        "description":"Host credentials that are operating system credentials used to perform database backup and recovery operations.",
                        "example":"NAMED:NC_VMUSER:SYSMAN"
                    },
                    "parallelism":{
                        "type":"number",
                        "description":"Number of SBT channels to set in database RMAN settings for the backup.",
                        "example":"1"
                    },
                    "protocol":{
                        "type":"string",
                        "description":"Protocol that will be used to configure databases to send backups to Recovery Appliance. Default is TCPS, if the Recovery Appliance is configured in either the TLS only mode or DUAL mode. If not, TCP.",
                        "enum":[
                            "TCP",
                            "TCPS"
                        ],
                        "example":"TCP"
                    },
                    "isForceInstallBackupModule":{
                        "type":"boolean",
                        "description":"Specifies if the latest backup module has to be pushed from the Software Library and installed in the database Oracle home or backup module location if specified.",
                        "example":false
                    },
                    "recoveryApplianceSettingsId":{
                        "type":"number",
                        "description":"Recovery Appliance media settings index.",
                        "example":"1"
                    },
                    "alternateRecoveryApplianceSettingsId":{
                        "type":"number",
                        "description":"Alternate Recovery Appliance media settings index.",
                        "example":"2"
                    },
                    "raCommonVpcUserName":{
                        "type":"string",
                        "description":"Common virtual private catalog user name.",
                        "example":"bkpUser1"
                    },
                    "overrideConnDesc":{
                        "type":"string",
                        "description":"Override connect descriptor.",
                        "example":"(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)))"
                    },
                    "alternateOverrideConnDesc":{
                        "type":"string",
                        "description":"Alternate override connect descriptor.",
                        "example":"(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)))"
                    },
                    "overallOverrideConnDesc":{
                        "type":"string",
                        "description":"Backup and Recovery Continuity override connect descriptor.",
                        "example":"(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)))"
                    },
                    "ociMediaSettingsId":{
                        "type":"string",
                        "description":"Oracle Cloud Infrastructure media settings index.",
                        "example":"1"
                    }
                }
            }
        },
        "backupConfiguration":{
            "type":"object",
            "description":"Contains details of the backup configuration.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/ConfigBackupDetailsOCI"
                },
                {
                    "$ref":"#/components/schemas/BulkConfigBackupDetailsRA"
                }
            ],
            "discriminator":{
                "propertyName":"destinationMediaType",
                "mapping":{
                    "OCI":"#/components/schemas/ConfigBackupDetailsOCI",
                    "RA":"#/components/schemas/BulkConfigBackupDetailsRA"
                }
            }
        },
        "schedule":{
            "description":"Specifies schedule of the deployment procedure.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/ScheduleImmediately"
                },
                {
                    "$ref":"#/components/schemas/ScheduleLater"
                },
                {
                    "$ref":"#/components/schemas/ScheduleRepeating"
                }
            ],
            "discriminator":{
                "propertyName":"type",
                "mapping":{
                    "immediately":"#/components/schemas/ScheduleImmediately",
                    "later":"#/components/schemas/ScheduleLater",
                    "repeating":"#/components/schemas/ScheduleRepeating"
                }
            }
        }
    }
}

ネストされたスキーマ: Discriminator: destinationMediaType

型: object

弁別子: destinationMediaType

弁別子の値

{
    "type":"object",
    "description":"Contains details of the backup configuration.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ConfigBackupDetailsOCI"
        },
        {
            "$ref":"#/components/schemas/BulkConfigBackupDetailsRA"
        }
    ],
    "discriminator":{
        "propertyName":"destinationMediaType",
        "mapping":{
            "OCI":"#/components/schemas/ConfigBackupDetailsOCI",
            "RA":"#/components/schemas/BulkConfigBackupDetailsRA"
        }
    }
}

バックアップ構成の詳細が含まれます。

1つのスキーマに一致

ソースの表示

OCI - object ConfigBackupDetailsOCI

Oracle Cloud Infrastructure用のバックアップの構成の詳細。
RA - object BulkConfigBackupDetailsRA

リカバリ・アプライアンス用のバックアップの一括構成の詳細。

{
    "type":"object",
    "description":"Contains details of the backup configuration.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ConfigBackupDetailsOCI"
        },
        {
            "$ref":"#/components/schemas/BulkConfigBackupDetailsRA"
        }
    ],
    "discriminator":{
        "propertyName":"destinationMediaType",
        "mapping":{
            "OCI":"#/components/schemas/ConfigBackupDetailsOCI",
            "RA":"#/components/schemas/BulkConfigBackupDetailsRA"
        }
    }
}

ネストされたスキーマ: ociMediaSettings

型: array

データベースのバックアップの送信先として構成されるOracle Cloud Infrastructureの設定の詳細。

ソースの表示

配列: object items

{
    "type":"array",
    "description":"Details of Oracle Cloud Infrastructure settings to which the databases will be configured to send backups.",
    "items":{
        "type":"object",
        "properties":{
            "settingsId":{
                "type":"number",
                "description":"Index.",
                "example":"1"
            },
            "ociEndPoint":{
                "type":"string",
                "description":"API EndPoint.",
                "example":"https://objectstorage.us-ashburn-1.oraclecloud.com"
            },
            "ociBucket":{
                "type":"string",
                "description":"Bucket.",
                "example":"Backup1"
            },
            "tempMetadataOCIBucket":{
                "type":"string",
                "description":"Temporary metadata bucket that will be used to store objects that needs to be updated or deleted during backup if the ociBucket specified is an immutable bucket.",
                "example":"tempBucket1"
            },
            "isOCIBucketImmutable":{
                "type":"boolean",
                "description":"Specifies if the bucket specified is an immutable bucket.",
                "example":true
            },
            "compartmentOCID":{
                "type":"string",
                "description":"Container OCID.",
                "example":"ocid1.compartment.oc1..aaaaaaaa7dlb5auhlhvhe3e6xz2hhjy64hujbwriad76q45xu2fkg6yu6fpq"
            }
        }
    }
}

ネストされたスキーマ: recoveryApplianceMediaSettings

型: array

データベースのバックアップの送信先として構成されるリカバリ・アプライアンスの詳細。

ソースの表示

配列: object items

{
    "type":"array",
    "description":"Details of Recovery Appliances to which the databases will be configured to send backups.",
    "items":{
        "type":"object",
        "properties":{
            "settingsId":{
                "type":"number",
                "description":"Recovery Appliance media settings index. [1-16] are the allowed indexes.",
                "example":"1"
            },
            "raTargetName":{
                "type":"string",
                "description":"Recovery Appliance target name.",
                "example":"RA19000"
            },
            "raTargetType":{
                "type":"string",
                "description":"Recovery Appliance target type.",
                "example":"oracle_dblra"
            },
            "protocol":{
                "type":"string",
                "description":"Protocol that will be used to configure databases to send backups to Recovery Appliance. Default is TCPS, if the Recovery Appliance is configured in either the TLS only mode or DUAL mode. If not, TCP.",
                "enum":[
                    "TCP",
                    "TCPS"
                ],
                "example":"TCP"
            },
            "vpcUserName":{
                "type":"string",
                "description":"Virtual private catalog user name.",
                "example":"bkpUser1"
            },
            "overrideConnDesc":{
                "type":"string",
                "description":"Override connect descriptor.",
                "example":"(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)))"
            }
        }
    }
}

ネストされたスキーマ: Discriminator: type

型: object

弁別子: type

{
    "description":"Specifies schedule of the deployment procedure.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleImmediately"
        },
        {
            "$ref":"#/components/schemas/ScheduleLater"
        },
        {
            "$ref":"#/components/schemas/ScheduleRepeating"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "immediately":"#/components/schemas/ScheduleImmediately",
            "later":"#/components/schemas/ScheduleLater",
            "repeating":"#/components/schemas/ScheduleRepeating"
        }
    }
}

デプロイメント・プロシージャのスケジュールを指定します。

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" } }

繰返しスケジュール。

{
    "description":"Specifies schedule of the deployment procedure.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleImmediately"
        },
        {
            "$ref":"#/components/schemas/ScheduleLater"
        },
        {
            "$ref":"#/components/schemas/ScheduleRepeating"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "immediately":"#/components/schemas/ScheduleImmediately",
            "later":"#/components/schemas/ScheduleLater",
            "repeating":"#/components/schemas/ScheduleRepeating"
        }
    }
}

ネストされたスキーマ: targetList

型: array

バックアップを送信するように構成されるデータベース・ターゲットの詳細が含まれます。

ソースの表示

配列: object items

{
    "type":"array",
    "description":"Contains details of database targets that will be configured to send backups.",
    "items":{
        "type":"object",
        "properties":{
            "targetName":{
                "type":"string",
                "description":"Database target name.",
                "example":"DB19000"
            },
            "targetType":{
                "type":"string",
                "description":"Database target type.",
                "example":"oracle_database"
            },
            "databaseCredentials":{
                "type":"string",
                "description":"Database credentials used to connect to the database.",
                "example":"NAMED:NC_DB1:SYSMAN"
            },
            "hostCredentials":{
                "type":"string",
                "description":"Host credentials that are operating system credentials used to perform database backup and recovery operations.",
                "example":"NAMED:NC_VMUSER:SYSMAN"
            },
            "parallelism":{
                "type":"number",
                "description":"Number of SBT channels to set in database RMAN settings for the backup.",
                "example":"1"
            },
            "protocol":{
                "type":"string",
                "description":"Protocol that will be used to configure databases to send backups to Recovery Appliance. Default is TCPS, if the Recovery Appliance is configured in either the TLS only mode or DUAL mode. If not, TCP.",
                "enum":[
                    "TCP",
                    "TCPS"
                ],
                "example":"TCP"
            },
            "isForceInstallBackupModule":{
                "type":"boolean",
                "description":"Specifies if the latest backup module has to be pushed from the Software Library and installed in the database Oracle home or backup module location if specified.",
                "example":false
            },
            "recoveryApplianceSettingsId":{
                "type":"number",
                "description":"Recovery Appliance media settings index.",
                "example":"1"
            },
            "alternateRecoveryApplianceSettingsId":{
                "type":"number",
                "description":"Alternate Recovery Appliance media settings index.",
                "example":"2"
            },
            "raCommonVpcUserName":{
                "type":"string",
                "description":"Common virtual private catalog user name.",
                "example":"bkpUser1"
            },
            "overrideConnDesc":{
                "type":"string",
                "description":"Override connect descriptor.",
                "example":"(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)))"
            },
            "alternateOverrideConnDesc":{
                "type":"string",
                "description":"Alternate override connect descriptor.",
                "example":"(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)))"
            },
            "overallOverrideConnDesc":{
                "type":"string",
                "description":"Backup and Recovery Continuity override connect descriptor.",
                "example":"(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)))"
            },
            "ociMediaSettingsId":{
                "type":"string",
                "description":"Oracle Cloud Infrastructure media settings index.",
                "example":"1"
            }
        }
    }
}

ネストされたスキーマ: ConfigBackupDetailsOCI

型: object

Oracle Cloud Infrastructure用のバックアップの構成の詳細。

ソースの表示

advanced: object advanced

拡張パラメータ。
destinationMediaType(必須): string

宛先メディア・タイプ。

例: OCI

{
    "description":"Configure Backup Details for Oracle Cloud Infrastructure.",
    "type":"object",
    "required":[
        "destinationMediaType"
    ],
    "properties":{
        "destinationMediaType":{
            "type":"string",
            "description":"Destination media type.",
            "example":"OCI"
        },
        "advanced":{
            "type":"object",
            "description":"Advanced parameters.",
            "properties":{
                "parallelism":{
                    "type":"number",
                    "description":"Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.",
                    "example":"1"
                },
                "installerArgs":{
                    "type":"array",
                    "description":"Additional arguments to be specified while invoking the Oracle Cloud Infrastructure installer to configure database backup to Oracle Cloud.",
                    "items":{
                        "type":"string",
                        "example":"-proxyHost abc"
                    },
                    "example":[
                        "-proxyHost abc",
                        "-proxyPort 80"
                    ]
                },
                "skipConfiguredDbs":{
                    "type":"boolean",
                    "description":"Specifies if databases that are already configured to backup to the specified destination media should be skipped.",
                    "example":true
                },
                "forceSerialExecution":{
                    "type":"boolean",
                    "description":"Specifies if the Enterprise Manager configuration deployment procedure has to process one database at a time or in parallel.",
                    "example":true
                },
                "proxyHost":{
                    "type":"string",
                    "description":"Proxy host used while downloading the Oracle Cloud Infrastructure backup module on the database target host."
                },
                "proxyPort":{
                    "type":"integer",
                    "description":"Proxy port used while downloading the Oracle Cloud Infrastructure backup module on the database target host."
                }
            }
        }
    }
}

ネストされたスキーマ: 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

ウォレット関連のパラメータ。

{
    "description":"Bulk Configure Backup Details for Recovery Appliance.",
    "type":"object",
    "required":[
        "destinationMediaType"
    ],
    "properties":{
        "destinationMediaType":{
            "type":"string",
            "description":"Destination media type.",
            "example":"RA"
        },
        "isShipRedo":{
            "type":"boolean",
            "description":"Specifies if redo logs need to be shipped.",
            "example":true
        },
        "isSkipControlfileAutobackup":{
            "type":"boolean",
            "description":"Specifies if control file backup should be skipped.",
            "example":true
        },
        "isUpdateSnapshotControlfileLoc":{
            "type":"boolean",
            "description":"Specifies if snapshot control file should be updated.",
            "example":false
        },
        "isDatabaseRestartPermitted":{
            "type":"boolean",
            "description":"Specifies if it is permitted to restart the database if required by the configuration procedure.",
            "example":false
        },
        "isForceRestartDB":{
            "type":"boolean",
            "description":"Specifies if the database has to be restarted for sure during the configuration procedure.",
            "example":false
        },
        "backupConfig":{
            "type":"string",
            "description":"Backup configuration.",
            "example":"ALL_DG",
            "enum":[
                "NO_DG",
                "ALL_DG",
                "CUSTOM_DG",
                "GOLD",
                "GOLD_WITH_REP"
            ]
        },
        "isBRContinuity":{
            "type":"boolean",
            "description":"Specifies if the database has to be configured with Backup and Recovery Continuity.",
            "example":false
        },
        "protocol":{
            "type":"string",
            "description":"Protocol that will be used to configure databases to send backups to Recovery Appliance. Default is TCPS, if the Recovery Appliance is configured in either the TLS only mode or DUAL mode. If not, TCP.",
            "enum":[
                "TCP",
                "TCPS"
            ],
            "example":"TCP"
        },
        "walletParameters":{
            "type":"object",
            "description":"Wallet related parameters.",
            "properties":{
                "walletLocation":{
                    "type":"string",
                    "description":"Wallet location.",
                    "example":"$ORACLE_HOME/dbs/wallet"
                },
                "isUpdateSQLNet":{
                    "type":"boolean",
                    "description":"Specifies if the SQLNET.WALLET_LOCATION has to be updated.",
                    "example":false
                },
                "isUpdateCRSEnv":{
                    "type":"boolean",
                    "description":"Specifies if the required environment variables (ORACLE_HOME, ORACLE_BASE, DB_UNIQUE_NAME, ORACLE_UNQNAME) should be updated in Cluster Ready Services (CRS) via the SRVCTL command.",
                    "example":false
                },
                "isSetWalletRoot":{
                    "type":"boolean",
                    "description":"Specifies if the WALLET_ROOT database initialization parameter has be set.",
                    "example":false
                }
            }
        },
        "backupModuleParameters":{
            "type":"object",
            "description":"Backup module related parameters.",
            "properties":{
                "isDownloadBackupModule":{
                    "type":"boolean",
                    "description":"Specifies if the latest backup module has to be downloaded into the Software Library.",
                    "example":false
                },
                "isForceInstallBackupModule":{
                    "type":"boolean",
                    "description":"Specifies if the latest backup module has to be pushed from the Software Library and installed in the database Oracle home or backup module location if specified.",
                    "example":false
                },
                "moduleLocation":{
                    "type":"string",
                    "description":"Cutom location of the backup module. Default is $ORACLE_HOME/lib.",
                    "example":"$ORACLE_HOME/lib"
                }
            }
        },
        "advanced":{
            "type":"object",
            "description":"Advanced parameters.",
            "properties":{
                "parallelism":{
                    "type":"number",
                    "description":"Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.",
                    "example":"1"
                }
            }
        }
    }
}

ネストされたスキーマ: 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

{
    "type":"object",
    "description":"Advanced parameters.",
    "properties":{
        "parallelism":{
            "type":"number",
            "description":"Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.",
            "example":"1"
        },
        "installerArgs":{
            "type":"array",
            "description":"Additional arguments to be specified while invoking the Oracle Cloud Infrastructure installer to configure database backup to Oracle Cloud.",
            "items":{
                "type":"string",
                "example":"-proxyHost abc"
            },
            "example":[
                "-proxyHost abc",
                "-proxyPort 80"
            ]
        },
        "skipConfiguredDbs":{
            "type":"boolean",
            "description":"Specifies if databases that are already configured to backup to the specified destination media should be skipped.",
            "example":true
        },
        "forceSerialExecution":{
            "type":"boolean",
            "description":"Specifies if the Enterprise Manager configuration deployment procedure has to process one database at a time or in parallel.",
            "example":true
        },
        "proxyHost":{
            "type":"string",
            "description":"Proxy host used while downloading the Oracle Cloud Infrastructure backup module on the database target host."
        },
        "proxyPort":{
            "type":"integer",
            "description":"Proxy port used while downloading the Oracle Cloud Infrastructure backup module on the database target host."
        }
    }
}

ネストされたスキーマ: installerArgs

型: array

Oracle Cloudへのデータベース・バックアップを構成するためにOracle Cloud Infrastructureインストーラの起動時に指定する追加の引数。

ソースの表示

配列: string

例: -proxyHost abc

{
    "type":"array",
    "description":"Additional arguments to be specified while invoking the Oracle Cloud Infrastructure installer to configure database backup to Oracle Cloud.",
    "items":{
        "type":"string",
        "example":"-proxyHost abc"
    },
    "example":[
        "-proxyHost abc",
        "-proxyPort 80"
    ]
}

例:

[
    "-proxyHost abc",
    "-proxyPort 80"
]

ネストされたスキーマ: advanced

型: object

拡張パラメータ。

ソースの表示

parallelism: number

Oracle Cloud InfrastructureバックアップのデータベースRMAN設定に設定するSBTチャネルの数。

例: 1

{
    "type":"object",
    "description":"Advanced parameters.",
    "properties":{
        "parallelism":{
            "type":"number",
            "description":"Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.",
            "example":"1"
        }
    }
}

ネストされたスキーマ: backupModuleParameters

型: object

バックアップ・モジュール関連のパラメータ。

ソースの表示

isDownloadBackupModule: boolean

最新のバックアップ・モジュールをソフトウェア・ライブラリにダウンロードする必要があるかどうかを指定します。

例: false
isForceInstallBackupModule: boolean

最新のバックアップ・モジュールをソフトウェア・ライブラリからプッシュして、データベースOracleホームまたはバックアップ・モジュールの場所(指定されている場合)にインストールする必要があるかどうかを指定します。

例: false
moduleLocation: string

バックアップ・モジュールのカスタムの場所。デフォルトは、$ORACLE_HOME/libです。

例: $ORACLE_HOME/lib

{
    "type":"object",
    "description":"Backup module related parameters.",
    "properties":{
        "isDownloadBackupModule":{
            "type":"boolean",
            "description":"Specifies if the latest backup module has to be downloaded into the Software Library.",
            "example":false
        },
        "isForceInstallBackupModule":{
            "type":"boolean",
            "description":"Specifies if the latest backup module has to be pushed from the Software Library and installed in the database Oracle home or backup module location if specified.",
            "example":false
        },
        "moduleLocation":{
            "type":"string",
            "description":"Cutom location of the backup module. Default is $ORACLE_HOME/lib.",
            "example":"$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

{
    "type":"object",
    "description":"Wallet related parameters.",
    "properties":{
        "walletLocation":{
            "type":"string",
            "description":"Wallet location.",
            "example":"$ORACLE_HOME/dbs/wallet"
        },
        "isUpdateSQLNet":{
            "type":"boolean",
            "description":"Specifies if the SQLNET.WALLET_LOCATION has to be updated.",
            "example":false
        },
        "isUpdateCRSEnv":{
            "type":"boolean",
            "description":"Specifies if the required environment variables (ORACLE_HOME, ORACLE_BASE, DB_UNIQUE_NAME, ORACLE_UNQNAME) should be updated in Cluster Ready Services (CRS) via the SRVCTL command.",
            "example":false
        },
        "isSetWalletRoot":{
            "type":"boolean",
            "description":"Specifies if the WALLET_ROOT database initialization parameter has be set.",
            "example":false
        }
    }
}

ネストされたスキーマ: 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

{
    "type":"object",
    "properties":{
        "settingsId":{
            "type":"number",
            "description":"Index.",
            "example":"1"
        },
        "ociEndPoint":{
            "type":"string",
            "description":"API EndPoint.",
            "example":"https://objectstorage.us-ashburn-1.oraclecloud.com"
        },
        "ociBucket":{
            "type":"string",
            "description":"Bucket.",
            "example":"Backup1"
        },
        "tempMetadataOCIBucket":{
            "type":"string",
            "description":"Temporary metadata bucket that will be used to store objects that needs to be updated or deleted during backup if the ociBucket specified is an immutable bucket.",
            "example":"tempBucket1"
        },
        "isOCIBucketImmutable":{
            "type":"boolean",
            "description":"Specifies if the bucket specified is an immutable bucket.",
            "example":true
        },
        "compartmentOCID":{
            "type":"string",
            "description":"Container OCID.",
            "example":"ocid1.compartment.oc1..aaaaaaaa7dlb5auhlhvhe3e6xz2hhjy64hujbwriad76q45xu2fkg6yu6fpq"
        }
    }
}

ネストされたスキーマ: 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

{
    "type":"object",
    "properties":{
        "settingsId":{
            "type":"number",
            "description":"Recovery Appliance media settings index. [1-16] are the allowed indexes.",
            "example":"1"
        },
        "raTargetName":{
            "type":"string",
            "description":"Recovery Appliance target name.",
            "example":"RA19000"
        },
        "raTargetType":{
            "type":"string",
            "description":"Recovery Appliance target type.",
            "example":"oracle_dblra"
        },
        "protocol":{
            "type":"string",
            "description":"Protocol that will be used to configure databases to send backups to Recovery Appliance. Default is TCPS, if the Recovery Appliance is configured in either the TLS only mode or DUAL mode. If not, TCP.",
            "enum":[
                "TCP",
                "TCPS"
            ],
            "example":"TCP"
        },
        "vpcUserName":{
            "type":"string",
            "description":"Virtual private catalog user name.",
            "example":"bkpUser1"
        },
        "overrideConnDesc":{
            "type":"string",
            "description":"Override connect descriptor.",
            "example":"(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)))"
        }
    }
}

ネストされたスキーマ: ScheduleImmediately

型: object

即時スケジュール。

ソースの表示

type(必須): string

スケジュールのタイプ。

例: immediately

{
    "type":"object",
    "description":"Schedule immediately.",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"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

{
    "type":"object",
    "description":"Schedule later.",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"later"
        },
        "startTime":{
            "$ref":"#/components/schemas/ScheduleStartTime"
        },
        "timeZone":{
            "$ref":"#/components/schemas/ScheduleTimeZone"
        }
    }
}

ネストされたスキーマ: Discriminator: repeatFrequency

型: object

弁別子: repeatFrequency

弁別子の値

WEEKLY
MONTHLY
YEARLY
INTERVAL

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

繰返しスケジュール。

すべてに一致

繰返しスケジュール。

ソースの表示

object ScheduleRepeatingBase

繰返しスケジュール。

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

1つのスキーマに一致

ソースの表示

WEEKLY - object ScheduleWeekly

繰返し頻度(週次)の値を繰り返します。
MONTHLY - object ScheduleMonthly

繰返し頻度(月次)の値を繰り返します。
YEARLY - object ScheduleYearly

繰返し頻度(年次)の値を繰り返します。
INTERVAL - object ScheduleInterval

繰返し頻度(間隔)の値を繰り返します。

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/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

{
    "type":"object",
    "description":"Repeating schedule.",
    "required":[
        "type",
        "startTime",
        "repeatFrequency"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"repeating"
        },
        "startTime":{
            "$ref":"#/components/schemas/ScheduleStartTime"
        },
        "timeZone":{
            "$ref":"#/components/schemas/ScheduleTimeZone"
        },
        "endtime":{
            "$ref":"#/components/schemas/ScheduleEndTime"
        },
        "repeatFrequency":{
            "$ref":"#/components/schemas/ScheduleRepeatFrequency"
        }
    }
}

ネストされたスキーマ: ScheduleWeekly

型: object

繰返し頻度(週次)の値を繰り返します。

ソースの表示

days(必須): array days

曜日。

{
    "description":"Repeat value for repeat frequency - weekly.",
    "required":[
        "days"
    ],
    "properties":{
        "days":{
            "description":"Days of the week.",
            "type":"array",
            "example":"1,4",
            "items":{
                "$ref":"#/components/schemas/DaysOfTheWeekEnum"
            }
        }
    }
}

ネストされたスキーマ: ScheduleMonthly

型: object

繰返し頻度(月次)の値を繰り返します。

ソースの表示

days(必須): array days

月次の値を繰り返します。

{
    "description":"Repeat value for repeat frequency - monthly.",
    "required":[
        "days"
    ],
    "properties":{
        "days":{
            "description":"Repeat value for monthly.",
            "type":"array",
            "example":"1,30,31",
            "items":{
                "type":"integer",
                "description":"Day number, int -1, 1..5 representing which day number. -1 represents LAST day."
            }
        }
    }
}

ネストされたスキーマ: ScheduleYearly

型: object

繰返し頻度(年次)の値を繰り返します。

ソースの表示

months(必須): array months

年次の値を繰り返します。

{
    "description":"Repeat value for repeat frequency - yearly.",
    "required":[
        "months"
    ],
    "properties":{
        "months":{
            "description":"Repeat value for yearly.",
            "type":"array",
            "example":"1,3",
            "items":{
                "type":"integer",
                "description":"Month number, int 1, 2, 3.. representing months Januaray, February, March etc."
            }
        }
    }
}

ネストされたスキーマ: ScheduleInterval

型: object

繰返し頻度(間隔)の値を繰り返します。

ソースの表示

repeatEvery(必須): string

N値ごとに繰り返します - m(分)、h(時間)、d(日)、w(週)。

例: 10m, 3h, 5d, 2w

{
    "description":"Repeat value for repeat frequency - interval.",
    "required":[
        "repeatEvery"
    ],
    "properties":{
        "repeatEvery":{
            "description":"Repeat every N value - m(minutes), h(hours), d(days), w(week).",
            "type":"string",
            "example":"10m, 3h, 5d, 2w"
        }
    }
}

ネストされたスキーマ: days

型: array

曜日。

ソースの表示

配列: integer

指定可能な値: [ "1", "2", "3", "4", "5", "6", "7" ]

曜日。日曜日は1、月曜日は2など。

{
    "description":"Days of the week.",
    "type":"array",
    "example":"1,4",
    "items":{
        "$ref":"#/components/schemas/DaysOfTheWeekEnum"
    }
}

例:

1,4

ネストされたスキーマ: days

型: array

月次の値を繰り返します。

ソースの表示

配列: integer

日番号。int -1、1..5は、どの日番号かを表します。-1は最後の日を表します。

{
    "description":"Repeat value for monthly.",
    "type":"array",
    "example":"1,30,31",
    "items":{
        "type":"integer",
        "description":"Day number, int -1, 1..5 representing which day number. -1 represents LAST day."
    }
}

例:

1,30,31

ネストされたスキーマ: months

型: array

年次の値を繰り返します。

ソースの表示

配列: integer

月番号。int 1、2、3..は、月(1月、2月、3月など)を表します。

{
    "description":"Repeat value for yearly.",
    "type":"array",
    "example":"1,3",
    "items":{
        "type":"integer",
        "description":"Month number, int 1, 2, 3.. representing months Januaray, February, March etc."
    }
}

例:

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

{
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Database target name.",
            "example":"DB19000"
        },
        "targetType":{
            "type":"string",
            "description":"Database target type.",
            "example":"oracle_database"
        },
        "databaseCredentials":{
            "type":"string",
            "description":"Database credentials used to connect to the database.",
            "example":"NAMED:NC_DB1:SYSMAN"
        },
        "hostCredentials":{
            "type":"string",
            "description":"Host credentials that are operating system credentials used to perform database backup and recovery operations.",
            "example":"NAMED:NC_VMUSER:SYSMAN"
        },
        "parallelism":{
            "type":"number",
            "description":"Number of SBT channels to set in database RMAN settings for the backup.",
            "example":"1"
        },
        "protocol":{
            "type":"string",
            "description":"Protocol that will be used to configure databases to send backups to Recovery Appliance. Default is TCPS, if the Recovery Appliance is configured in either the TLS only mode or DUAL mode. If not, TCP.",
            "enum":[
                "TCP",
                "TCPS"
            ],
            "example":"TCP"
        },
        "isForceInstallBackupModule":{
            "type":"boolean",
            "description":"Specifies if the latest backup module has to be pushed from the Software Library and installed in the database Oracle home or backup module location if specified.",
            "example":false
        },
        "recoveryApplianceSettingsId":{
            "type":"number",
            "description":"Recovery Appliance media settings index.",
            "example":"1"
        },
        "alternateRecoveryApplianceSettingsId":{
            "type":"number",
            "description":"Alternate Recovery Appliance media settings index.",
            "example":"2"
        },
        "raCommonVpcUserName":{
            "type":"string",
            "description":"Common virtual private catalog user name.",
            "example":"bkpUser1"
        },
        "overrideConnDesc":{
            "type":"string",
            "description":"Override connect descriptor.",
            "example":"(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)))"
        },
        "alternateOverrideConnDesc":{
            "type":"string",
            "description":"Alternate override connect descriptor.",
            "example":"(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)))"
        },
        "overallOverrideConnDesc":{
            "type":"string",
            "description":"Backup and Recovery Continuity override connect descriptor.",
            "example":"(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)))"
        },
        "ociMediaSettingsId":{
            "type":"string",
            "description":"Oracle Cloud Infrastructure media settings index.",
            "example":"1"
        }
    }
}

例

先頭に戻る

レスポンス

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

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

{
    "description":"Status of operation submitted.",
    "type":"object",
    "required":[
        "submissionName",
        "submissionBy",
        "executionId",
        "procedureId"
    ],
    "properties":{
        "submissionName":{
            "description":"Name of the deployment procedure submitted.",
            "type":"string",
            "example":"BACKUP_RA_CONFIG_121222220321"
        },
        "submissionBy":{
            "description":"User that submitted the deployment procedure.",
            "type":"string",
            "example":"SYSMAN"
        },
        "executionId":{
            "description":"Deployment procedure execution ID.",
            "type":"string",
            "example":"DE8676BE8CD73086E053DE0D4B64D288"
        },
        "procedureId":{
            "description":"Deployment procedure submission ID.",
            "type":"string",
            "example":"DE8676BE8CD73086E053DE0D4B64D288"
        },
        "location":{
            "description":"URI to verify the status of the deployment procedure submitted.",
            "type":"string",
            "example":"/em/api/deploymentProcedureInstances/DE8676BE8CD73086E053DE0D4B64D288"
        }
    }
}

400レスポンス

不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401レスポンス

未認可。ユーザーにはリクエストされた操作を実行する権限がありません

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

403レスポンス

禁止。ユーザーは、リクエストされた操作の実行を禁止されています

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

404レスポンス

見つかりません。リクエストされたREST API URLが見つかりません。

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500レスポンス

内部サーバー・エラー。REST APIの実行中に例外が発生しました。

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503レスポンス

サービスが使用できません。サーバーはリクエストを処理できません。

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

先頭に戻る