Fails over AutonomousDatabase to a Standby.
POST {{baseUrl}}/autonomousDatabases/:autonomousDatabaseId/actions/failover?peerDbId=<string>
Initiates a failover of the specified Autonomous Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled.
This API should be called in the remote region where the peer database resides.
Below parameter is optional:
- peerDbId
Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database.
If this parameter is not provided, the failover will happen in the same region.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
peerDbId | string | The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
if-match | string | For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match | |
| parameter to the value of the etag from a previous GET or POST response for that resource. The resource | |||
| will be updated or deleted only if the etag you provide matches the resource's current etag value. | |||
opc-retry-token | string | A token that uniquely identifies a request so it can be retried in case of a timeout or | |
| server error without risk of executing that same action again. Retry tokens expire after 24 | |||
| hours, but can be invalidated before then due to conflicting operations (for example, if a resource | |||
| has been deleted and purged from the system, then a retry of the original creation request | |||
| may be rejected). | |||
opc-request-id | string | Unique identifier for the request. | |
Accept | string |
RESPONSES
status: OK
{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","lifecycleState":"RESTORE_IN_PROGRESS","dbName":"\u003cstring\u003e","cpuCoreCount":"\u003cinteger\u003e","dataStorageSizeInTBs":"\u003cinteger\u003e","actualUsedDataStorageSizeInTBs":"\u003cdouble\u003e","allocatedStorageSizeInTBs":"\u003cdouble\u003e","apexDetails":{"apexVersion":"\u003cstring\u003e","ordsVersion":"\u003cstring\u003e"},"arePrimaryWhitelistedIpsUsed":"\u003cboolean\u003e","autoRefreshFrequencyInSeconds":"\u003cinteger\u003e","autoRefreshPointLagInSeconds":"\u003cinteger\u003e","autonomousContainerDatabaseId":"\u003cstring\u003e","autonomousMaintenanceScheduleType":"REGULAR","availableUpgradeVersions":["\u003cstring\u003e"],"backupConfig":{"manualBackupBucketName":"\u003cstring\u003e","manualBackupType":"OBJECT_STORE"},"characterSet":"\u003cstring\u003e","computeCount":"\u003cfloat\u003e","computeModel":"OCPU","connectionStrings":{"allConnectionStrings":{"culpa899":"\u003cstring\u003e","pariatur_0":"\u003cstring\u003e","non66_":"\u003cstring\u003e","reprehenderit3da":"\u003cstring\u003e"},"dedicated":"\u003cstring\u003e","high":"\u003cstring\u003e","low":"\u003cstring\u003e","medium":"\u003cstring\u003e","profiles":[{"displayName":"\u003cstring\u003e","value":"\u003cstring\u003e","protocol":"TCPS","hostFormat":"FQDN","sessionMode":"REDIRECT","syntaxFormat":"EZCONNECT","consumerGroup":"TP","isRegional":"\u003cboolean\u003e","tlsAuthentication":"MUTUAL"}]},"connectionUrls":{"apexUrl":"\u003cstring\u003e","databaseTransformsUrl":"\u003cstring\u003e","graphStudioUrl":"\u003cstring\u003e","machineLearningNotebookUrl":"\u003cstring\u003e","machineLearningUserManagementUrl":"\u003cstring\u003e","mongoDbUrl":"\u003cstring\u003e","ordsUrl":"\u003cstring\u003e","sqlDevWebUrl":"\u003cstring\u003e"},"customerContacts":[{"email":"\u003cstring\u003e"}],"dataSafeStatus":"REGISTERED","dataStorageSizeInGBs":"\u003cinteger\u003e","databaseEdition":"ENTERPRISE_EDITION","dataguardRegionType":"PRIMARY_DG_REGION","dbToolsDetails":[{"name":"DATABASE_ACTIONS","isEnabled":false}],"dbVersion":"\u003cstring\u003e","dbWorkload":"DW","definedTags":{"irurec":{"ea_fa":{}}},"disasterRecoveryRegionType":"REMOTE","displayName":"\u003cstring\u003e","failedDataRecoveryInSeconds":"\u003cinteger\u003e","freeformTags":{"amet7b":"\u003cstring\u003e","adipisicing_99a":"\u003cstring\u003e"},"inMemoryAreaInGBs":"\u003cinteger\u003e","inMemoryPercentage":"\u003cinteger\u003e","infrastructureType":"CLOUD_AT_CUSTOMER","isAccessControlEnabled":"\u003cboolean\u003e","isAutoScalingEnabled":"\u003cboolean\u003e","isAutoScalingForStorageEnabled":"\u003cboolean\u003e","isDataGuardEnabled":"\u003cboolean\u003e","isDedicated":"\u003cboolean\u003e","isDevTier":false,"isFreeTier":false,"isLocalDataGuardEnabled":"\u003cboolean\u003e","isMtlsConnectionRequired":"\u003cboolean\u003e","isPreview":"\u003cboolean\u003e","isReconnectCloneEnabled":"\u003cboolean\u003e","isRefreshableClone":"\u003cboolean\u003e","isRemoteDataGuardEnabled":"\u003cboolean\u003e","keyHistoryEntry":[{"id":"\u003cstring\u003e","timeActivated":"\u003cdateTime\u003e","vaultId":"\u003cstring\u003e"}],"keyStoreId":"\u003cstring\u003e","keyStoreWalletName":"\u003cstring\u003e","kmsKeyId":"\u003cstring\u003e","kmsKeyLifecycleDetails":"\u003cstring\u003e","licenseModel":"BRING_YOUR_OWN_LICENSE","lifecycleDetails":"\u003cstring\u003e","localAdgAutoFailoverMaxDataLossLimit":"\u003cinteger\u003e","localDisasterRecoveryType":"\u003cstring\u003e","localStandbyDb":{"lagTimeInSeconds":"\u003cinteger\u003e","lifecycleDetails":"\u003cstring\u003e","lifecycleState":"SCALE_IN_PROGRESS","timeDataGuardRoleChanged":"\u003cdateTime\u003e","timeDisasterRecoveryRoleChanged":"\u003cdateTime\u003e"},"longTermBackupSchedule":{"isDisabled":false,"repeatCadence":"ONE_TIME","retentionPeriodInDays":"\u003cinteger\u003e","timeOfBackup":"\u003cdateTime\u003e"},"memoryPerOracleComputeUnitInGBs":"\u003cinteger\u003e","ncharacterSet":"\u003cstring\u003e","netServicesArchitecture":"DEDICATED","nextLongTermBackupTimeStamp":"\u003cdateTime\u003e","nsgIds":["\u003cstring\u003e"],"ocpuCount":"\u003cfloat\u003e","openMode":"READ_WRITE","operationsInsightsStatus":"FAILED_ENABLING","peerDbIds":["\u003cstring\u003e"],"permissionLevel":"UNRESTRICTED","privateEndpoint":"\u003cstring\u003e","privateEndpointIp":"\u003cstring\u003e","privateEndpointLabel":"\u003cstring\u003e","provisionableCpus":["\u003cfloat\u003e"],"refreshableMode":"MANUAL","refreshableStatus":"REFRESHING","remoteDisasterRecoveryConfiguration":{"disasterRecoveryType":"BACKUP_BASED","isReplicateAutomaticBackups":"\u003cboolean\u003e","isSnapshotStandby":"\u003cboolean\u003e","timeSnapshotStandbyEnabledTill":"\u003cdateTime\u003e"},"resourcePoolLeaderId":"\u003cstring\u003e","resourcePoolSummary":{"isDisabled":"\u003cboolean\u003e","poolSize":"\u003cinteger\u003e"},"role":"PRIMARY","scheduledOperations":[{"dayOfWeek":{"name":"FRIDAY"},"scheduledStartTime":"\u003cstring\u003e","scheduledStopTime":"\u003cstring\u003e"}],"serviceConsoleUrl":"\u003cstring\u003e","sourceId":"\u003cstring\u003e","sqlWebDeveloperUrl":"\u003cstring\u003e","standbyDb":{"lagTimeInSeconds":"\u003cinteger\u003e","lifecycleDetails":"\u003cstring\u003e","lifecycleState":"STARTING","timeDataGuardRoleChanged":"\u003cdateTime\u003e","timeDisasterRecoveryRoleChanged":"\u003cdateTime\u003e"},"standbyWhitelistedIps":["\u003cstring\u003e"],"subnetId":"\u003cstring\u003e","supportedRegionsToCloneTo":["\u003cstring\u003e"],"systemTags":{"aliquae":{"id__4":{},"exercitation_13":{},"proident_e":{}}},"timeCreated":"\u003cdateTime\u003e","timeDataGuardRoleChanged":"\u003cdateTime\u003e","timeDeletionOfFreeAutonomousDatabase":"\u003cdateTime\u003e","timeDisasterRecoveryRoleChanged":"\u003cdateTime\u003e","timeLocalDataGuardEnabled":"\u003cdateTime\u003e","timeMaintenanceBegin":"\u003cdateTime\u003e","timeMaintenanceEnd":"\u003cdateTime\u003e","timeOfAutoRefreshStart":"\u003cdateTime\u003e","timeOfJoiningResourcePool":"\u003cdateTime\u003e","timeOfLastFailover":"\u003cdateTime\u003e","timeOfLastRefresh":"\u003cdateTime\u003e","timeOfLastRefreshPoint":"\u003cdateTime\u003e","timeOfLastSwitchover":"\u003cdateTime\u003e","timeOfNextRefresh":"\u003cdateTime\u003e","timeReclamationOfFreeAutonomousDatabase":"\u003cdateTime\u003e","timeUntilReconnectCloneEnabled":"\u003cdateTime\u003e","usedDataStorageSizeInGBs":"\u003cinteger\u003e","usedDataStorageSizeInTBs":"\u003cinteger\u003e","vaultId":"\u003cstring\u003e","whitelistedIps":["\u003cstring\u003e"]}