@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class DatabaseClient extends BaseSyncClient implements Database
Modifier and Type | Class and Description |
---|---|
static class |
DatabaseClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
String |
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.
|
protected ExecutorService |
executorService |
Optional<String> |
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.
|
static Service |
SERVICE
Service instance for Database.
|
Constructor and Description |
---|
DatabaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
DatabaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
DatabaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
DatabaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
DatabaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
DatabaseClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
DatabaseClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
DatabaseClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for Database.
protected final ExecutorService executorService
public final String clientCommonLibraryVersion
@Deprecated public DatabaseClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public DatabaseClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public DatabaseClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public DatabaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public DatabaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public DatabaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
@Deprecated public DatabaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
@Deprecated public DatabaseClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
- DatabaseClient.Builder.executorService
public static DatabaseClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
Database
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this Region, however, an
IllegalArgumentException will be raised.
public void setRegion(String regionId)
Database
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
public ActivateExadataInfrastructureResponse activateExadataInfrastructure(ActivateExadataInfrastructureRequest request)
Database
Activates the specified Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only.
activateExadataInfrastructure
in interface Database
request
- The request object containing the details to sendpublic AddStorageCapacityCloudExadataInfrastructureResponse addStorageCapacityCloudExadataInfrastructure(AddStorageCapacityCloudExadataInfrastructureRequest request)
Database
Makes the storage capacity from additional storage servers available for Cloud VM Cluster consumption. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
addStorageCapacityCloudExadataInfrastructure
in interface Database
request
- The request object containing the details to sendpublic AddStorageCapacityExadataInfrastructureResponse addStorageCapacityExadataInfrastructure(AddStorageCapacityExadataInfrastructureRequest request)
Database
Makes the storage capacity from additional storage servers available for VM Cluster consumption. Applies to Exadata Cloud@Customer instances only.
addStorageCapacityExadataInfrastructure
in interface Database
request
- The request object containing the details to sendpublic AddVirtualMachineToCloudVmClusterResponse addVirtualMachineToCloudVmCluster(AddVirtualMachineToCloudVmClusterRequest request)
Database
Add Virtual Machines to the Cloud VM cluster. Applies to Exadata Cloud instances only.
addVirtualMachineToCloudVmCluster
in interface Database
request
- The request object containing the details to sendpublic AddVirtualMachineToVmClusterResponse addVirtualMachineToVmCluster(AddVirtualMachineToVmClusterRequest request)
Database
Add Virtual Machines to the VM cluster. Applies to Exadata Cloud@Customer instances only.
addVirtualMachineToVmCluster
in interface Database
request
- The request object containing the details to sendpublic AutonomousDatabaseManualRefreshResponse autonomousDatabaseManualRefresh(AutonomousDatabaseManualRefreshRequest request)
Database
Initiates a data refresh for an Autonomous Database refreshable clone. Data is refreshed from the source database to the point of a specified timestamp.
autonomousDatabaseManualRefresh
in interface Database
request
- The request object containing the details to sendpublic CancelBackupResponse cancelBackup(CancelBackupRequest request)
Database
Cancel automatic/standalone full/incremental create backup workrequests specified by the backup Id.
cancelBackup
in interface Database
request
- The request object containing the details to sendpublic CancelExecutionWindowResponse cancelExecutionWindow(CancelExecutionWindowRequest request)
Database
Cancels the in progress maintenance activity under this execution window.
cancelExecutionWindow
in interface Database
request
- The request object containing the details to sendpublic CascadingDeleteSchedulingPlanResponse cascadingDeleteSchedulingPlan(CascadingDeleteSchedulingPlanRequest request)
Database
Delete the scheduling plan resource along with all the scheduled actions associated with this resource.
cascadingDeleteSchedulingPlan
in interface Database
request
- The request object containing the details to sendpublic ChangeAutonomousContainerDatabaseCompartmentResponse changeAutonomousContainerDatabaseCompartment(ChangeAutonomousContainerDatabaseCompartmentRequest request)
Database
Move the Autonomous Container Database and its dependent resources to the specified compartment. For more information about moving Autonomous Container Databases, see Moving Database Resources to a Different Compartment.
changeAutonomousContainerDatabaseCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeAutonomousDatabaseCompartmentResponse changeAutonomousDatabaseCompartment(ChangeAutonomousDatabaseCompartmentRequest request)
Database
Move the Autonomous Database and its dependent resources to the specified compartment. For more information about moving Autonomous Databases, see Moving Database Resources to a Different Compartment.
changeAutonomousDatabaseCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeAutonomousDatabaseSoftwareImageCompartmentResponse changeAutonomousDatabaseSoftwareImageCompartment(ChangeAutonomousDatabaseSoftwareImageCompartmentRequest request)
Database
Move the Autonomous Database Software Image and its dependent resources to the specified compartment.
changeAutonomousDatabaseSoftwareImageCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeAutonomousDatabaseSubscriptionResponse changeAutonomousDatabaseSubscription(ChangeAutonomousDatabaseSubscriptionRequest request)
Database
Associate an Autonomous Database with a different subscription.
changeAutonomousDatabaseSubscription
in interface Database
request
- The request object containing the details to sendpublic ChangeAutonomousExadataInfrastructureCompartmentResponse changeAutonomousExadataInfrastructureCompartment(ChangeAutonomousExadataInfrastructureCompartmentRequest request)
Database
Deprecated. Use the changeCloudExadataInfrastructureCompartment
operation to move an Exadata infrastructure
resource to a different compartment and changeCloudAutonomousVmClusterCompartment
operation to move an Autonomous Exadata VM cluster
to a different compartment. For more information, see Moving Database Resources to a
Different
Compartment.
changeAutonomousExadataInfrastructureCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeAutonomousVmClusterCompartmentResponse changeAutonomousVmClusterCompartment(ChangeAutonomousVmClusterCompartmentRequest request)
Database
Moves an Autonomous VM cluster and its dependent resources to another compartment. Applies to
Exadata Cloud@Customer only. For systems in the Oracle cloud, see changeAutonomousVmClusterCompartment
.
changeAutonomousVmClusterCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeBackupDestinationCompartmentResponse changeBackupDestinationCompartment(ChangeBackupDestinationCompartmentRequest request)
Database
Move the backup destination and its dependent resources to the specified compartment. For more information, see Moving Database Resources to a Different Compartment.
changeBackupDestinationCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeCloudAutonomousVmClusterCompartmentResponse changeCloudAutonomousVmClusterCompartment(ChangeCloudAutonomousVmClusterCompartmentRequest request)
Database
Moves an Autonomous Exadata VM cluster in the Oracle cloud and its dependent resources to
another compartment. For Exadata Cloud@Customer systems, see changeAutonomousVmClusterCompartment
.
changeCloudAutonomousVmClusterCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeCloudExadataInfrastructureCompartmentResponse changeCloudExadataInfrastructureCompartment(ChangeCloudExadataInfrastructureCompartmentRequest request)
Database
Moves a cloud Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.For more information about moving resources to a different compartment, see Moving Database Resources to a Different Compartment.
changeCloudExadataInfrastructureCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeCloudExadataInfrastructureSubscriptionResponse changeCloudExadataInfrastructureSubscription(ChangeCloudExadataInfrastructureSubscriptionRequest request)
Database
Associate a cloud Exadata infrastructure with a different subscription.
changeCloudExadataInfrastructureSubscription
in interface Database
request
- The request object containing the details to sendpublic ChangeCloudVmClusterCompartmentResponse changeCloudVmClusterCompartment(ChangeCloudVmClusterCompartmentRequest request)
Database
Moves a cloud VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
changeCloudVmClusterCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeCloudVmClusterSubscriptionResponse changeCloudVmClusterSubscription(ChangeCloudVmClusterSubscriptionRequest request)
Database
Associate a cloud VM cluster with a different subscription.
changeCloudVmClusterSubscription
in interface Database
request
- The request object containing the details to sendpublic ChangeDatabaseSoftwareImageCompartmentResponse changeDatabaseSoftwareImageCompartment(ChangeDatabaseSoftwareImageCompartmentRequest request)
Database
Move the Database Software Image and its dependent resources to the specified compartment. For more information about moving Databse Software Images, see Moving Database Resources to a Different Compartment.
changeDatabaseSoftwareImageCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeDataguardRoleResponse changeDataguardRole(ChangeDataguardRoleRequest request)
Database
Switch the Autonomous Container Database role between Standby and Snapshot Standby. For more information about changing Autonomous Container Databases Dataguard Role, see Convert Physical Standby to Snapshot Standby and Convert Snapshot Standby to Physical Standby.
changeDataguardRole
in interface Database
request
- The request object containing the details to sendpublic ChangeDbSystemCompartmentResponse changeDbSystemCompartment(ChangeDbSystemCompartmentRequest request)
Database
Moves the DB system and its dependent resources to the specified compartment. For more information about moving DB systems, see Moving Database Resources to a Different Compartment.
changeDbSystemCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeDisasterRecoveryConfigurationResponse changeDisasterRecoveryConfiguration(ChangeDisasterRecoveryConfigurationRequest request)
Database
This operation updates the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless database, and must be run on the standby side.
changeDisasterRecoveryConfiguration
in interface Database
request
- The request object containing the details to sendpublic ChangeExadataInfrastructureCompartmentResponse changeExadataInfrastructureCompartment(ChangeExadataInfrastructureCompartmentRequest request)
Database
Moves an Exadata infrastructure resource and its dependent resources to another compartment.
Applies to Exadata Cloud@Customer instances only. To move an Exadata Cloud Service
infrastructure resource to another compartment, use the changeCloudExadataInfrastructureCompartment
operation.
changeExadataInfrastructureCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeExadbVmClusterCompartmentResponse changeExadbVmClusterCompartment(ChangeExadbVmClusterCompartmentRequest request)
Database
Moves a Exadata VM cluster on Exascale Infrastructure and its dependent resources to another compartment. Applies to Exadata Database Service on Exascale Infrastructure only.
changeExadbVmClusterCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeExascaleDbStorageVaultCompartmentResponse changeExascaleDbStorageVaultCompartment(ChangeExascaleDbStorageVaultCompartmentRequest request)
Database
Moves a Exadata Database Storage Vault to another compartment.
changeExascaleDbStorageVaultCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeExternalContainerDatabaseCompartmentResponse changeExternalContainerDatabaseCompartment(ChangeExternalContainerDatabaseCompartmentRequest request)
Database
Move the createExternalContainerDatabaseDetails
and its dependent resources to the specified
compartment. For more information about moving external container databases, see Moving
Database Resources to a Different
Compartment.
changeExternalContainerDatabaseCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeExternalNonContainerDatabaseCompartmentResponse changeExternalNonContainerDatabaseCompartment(ChangeExternalNonContainerDatabaseCompartmentRequest request)
Database
Move the external non-container database and its dependent resources to the specified compartment. For more information about moving external non-container databases, see Moving Database Resources to a Different Compartment.
changeExternalNonContainerDatabaseCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeExternalPluggableDatabaseCompartmentResponse changeExternalPluggableDatabaseCompartment(ChangeExternalPluggableDatabaseCompartmentRequest request)
Database
Move the createExternalPluggableDatabaseDetails
and its dependent resources to the specified
compartment. For more information about moving external pluggable databases, see Moving
Database Resources to a Different
Compartment.
changeExternalPluggableDatabaseCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeKeyStoreCompartmentResponse changeKeyStoreCompartment(ChangeKeyStoreCompartmentRequest request)
Database
Move the key store resource to the specified compartment. For more information about moving key stores, see Moving Database Resources to a Different Compartment.
changeKeyStoreCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeKeyStoreTypeResponse changeKeyStoreType(ChangeKeyStoreTypeRequest request)
Database
Changes encryption key management type
changeKeyStoreType
in interface Database
request
- The request object containing the details to sendpublic ChangeOneoffPatchCompartmentResponse changeOneoffPatchCompartment(ChangeOneoffPatchCompartmentRequest request)
Database
Move the one-off patch to the specified compartment.
changeOneoffPatchCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeSchedulingPlanCompartmentResponse changeSchedulingPlanCompartment(ChangeSchedulingPlanCompartmentRequest request)
Database
Moves an scheduling plan resource to another compartment.
changeSchedulingPlanCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeSchedulingPolicyCompartmentResponse changeSchedulingPolicyCompartment(ChangeSchedulingPolicyCompartmentRequest request)
Database
Moves an scheduling policy resource to another compartment.
changeSchedulingPolicyCompartment
in interface Database
request
- The request object containing the details to sendpublic ChangeVmClusterCompartmentResponse changeVmClusterCompartment(ChangeVmClusterCompartmentRequest request)
Database
Moves a VM cluster and its dependent resources to another compartment. Applies to Exadata
Cloud@Customer instances only. To move a cloud VM cluster in an Exadata Cloud Service
instance to another compartment, use the changeCloudVmClusterCompartment
operation.
changeVmClusterCompartment
in interface Database
request
- The request object containing the details to sendpublic CheckExternalDatabaseConnectorConnectionStatusResponse checkExternalDatabaseConnectorConnectionStatus(CheckExternalDatabaseConnectorConnectionStatusRequest request)
Database
Check the status of the external database connection specified in this connector. This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.
checkExternalDatabaseConnectorConnectionStatus
in interface Database
request
- The request object containing the details to sendpublic CompleteExternalBackupJobResponse completeExternalBackupJob(CompleteExternalBackupJobRequest request)
Database
Changes the status of the standalone backup resource to ACTIVE
after the backup is created
from the on-premises database and placed in Oracle Cloud Infrastructure Object Storage.
*Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](https://docs.cloud.oracle.com/Content/Database/Tasks/mig-onprembackup.htm) for more information.
completeExternalBackupJob
in interface Database
request
- The request object containing the details to sendpublic ConfigureAutonomousDatabaseVaultKeyResponse configureAutonomousDatabaseVaultKey(ConfigureAutonomousDatabaseVaultKeyRequest request)
Database
Configures the Autonomous Database Vault service key.
configureAutonomousDatabaseVaultKey
in interface Database
request
- The request object containing the details to sendpublic ConfigureSaasAdminUserResponse configureSaasAdminUser(ConfigureSaasAdminUserRequest request)
Database
This operation updates SaaS administrative user configuration of the Autonomous Database.
configureSaasAdminUser
in interface Database
request
- The request object containing the details to sendpublic ConfirmKeyStoreDetailsAreCorrectResponse confirmKeyStoreDetailsAreCorrect(ConfirmKeyStoreDetailsAreCorrectRequest request)
Database
This is for user to confirm to DBaaS that the Oracle Key Valut (OKV) connection IPs, username and password are all correct. This operation will put the Key Store back into Active state. If details are incorrect, your OKV account may get locked after some unsuccessful attempts to connect.
confirmKeyStoreDetailsAreCorrect
in interface Database
request
- The request object containing the details to sendpublic ConvertToPdbResponse convertToPdb(ConvertToPdbRequest request)
Database
Converts a non-container database to a pluggable database.
convertToPdb
in interface Database
request
- The request object containing the details to sendpublic ConvertToRegularPluggableDatabaseResponse convertToRegularPluggableDatabase(ConvertToRegularPluggableDatabaseRequest request)
Database
Converts a Refreshable clone to Regular pluggable database (PDB). Pluggable Database will be
in READ_WRITE
openmode after conversion.
convertToRegularPluggableDatabase
in interface Database
request
- The request object containing the details to sendpublic CreateApplicationVipResponse createApplicationVip(CreateApplicationVipRequest request)
Database
Creates a new application virtual IP (VIP) address in the specified cloud VM cluster based on the request parameters you provide.
createApplicationVip
in interface Database
request
- The request object containing the details to sendpublic CreateAutonomousContainerDatabaseResponse createAutonomousContainerDatabase(CreateAutonomousContainerDatabaseRequest request)
Database
Creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure.
createAutonomousContainerDatabase
in interface Database
request
- The request object containing the details to sendpublic CreateAutonomousContainerDatabaseDataguardAssociationResponse createAutonomousContainerDatabaseDataguardAssociation(CreateAutonomousContainerDatabaseDataguardAssociationRequest request)
Database
Create a new Autonomous Data Guard association. An Autonomous Data Guard association represents the replication relationship between the specified Autonomous Container database and a peer Autonomous Container database. For more information, see Using Oracle Data Guard.
All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see [Resource Identifiers](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
createAutonomousContainerDatabaseDataguardAssociation
in interface Database
request
- The request object containing the details to sendpublic CreateAutonomousDatabaseResponse createAutonomousDatabase(CreateAutonomousDatabaseRequest request)
Database
Creates a new Autonomous Database.
createAutonomousDatabase
in interface Database
request
- The request object containing the details to sendpublic CreateAutonomousDatabaseBackupResponse createAutonomousDatabaseBackup(CreateAutonomousDatabaseBackupRequest request)
Database
Creates a new Autonomous Database backup for the specified database based on the provided request parameters.
createAutonomousDatabaseBackup
in interface Database
request
- The request object containing the details to sendpublic CreateAutonomousDatabaseSoftwareImageResponse createAutonomousDatabaseSoftwareImage(CreateAutonomousDatabaseSoftwareImageRequest request)
Database
create Autonomous Database Software Image in the specified compartment.
createAutonomousDatabaseSoftwareImage
in interface Database
request
- The request object containing the details to sendpublic CreateAutonomousVmClusterResponse createAutonomousVmCluster(CreateAutonomousVmClusterRequest request)
Database
Creates an Autonomous VM cluster for Exadata Cloud@Customer. To create an Autonomous VM
Cluster in the Oracle cloud, see createCloudAutonomousVmCluster
.
createAutonomousVmCluster
in interface Database
request
- The request object containing the details to sendpublic CreateBackupResponse createBackup(CreateBackupRequest request)
Database
Creates a new backup in the specified database based on the request parameters you provide. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
createBackup
in interface Database
request
- The request object containing the details to sendpublic CreateBackupDestinationResponse createBackupDestination(CreateBackupDestinationRequest request)
Database
Creates a backup destination in an Exadata Cloud@Customer system.
createBackupDestination
in interface Database
request
- The request object containing the details to sendpublic CreateCloudAutonomousVmClusterResponse createCloudAutonomousVmCluster(CreateCloudAutonomousVmClusterRequest request)
Database
Creates an Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer
systems, see createAutonomousVmCluster
.
createCloudAutonomousVmCluster
in interface Database
request
- The request object containing the details to sendpublic CreateCloudExadataInfrastructureResponse createCloudExadataInfrastructure(CreateCloudExadataInfrastructureRequest request)
Database
Creates a cloud Exadata infrastructure resource. This resource is used to create either an Exadata Cloud Service instance or an Autonomous Database on dedicated Exadata infrastructure.
createCloudExadataInfrastructure
in interface Database
request
- The request object containing the details to sendpublic CreateCloudVmClusterResponse createCloudVmCluster(CreateCloudVmClusterRequest request)
Database
Creates a cloud VM cluster.
createCloudVmCluster
in interface Database
request
- The request object containing the details to sendpublic CreateConsoleConnectionResponse createConsoleConnection(CreateConsoleConnectionRequest request)
Database
Creates a new console connection to the specified database node. After the console connection has been created and is available, you connect to the console using SSH.
createConsoleConnection
in interface Database
request
- The request object containing the details to sendpublic CreateConsoleHistoryResponse createConsoleHistory(CreateConsoleHistoryRequest request)
Database
Captures the most recent serial console data (up to a megabyte) for the specified database node.
createConsoleHistory
in interface Database
request
- The request object containing the details to sendpublic CreateDataGuardAssociationResponse createDataGuardAssociation(CreateDataGuardAssociationRequest request)
Database
Creates a new Data Guard association. A Data Guard association represents the replication relationship between the specified database and a peer database. For more information, see Using Oracle Data Guard.
All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see [Resource Identifiers](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
createDataGuardAssociation
in interface Database
request
- The request object containing the details to sendpublic CreateDatabaseResponse createDatabase(CreateDatabaseRequest request)
Database
Creates a new database in the specified Database Home. If the database version is provided, it must match the version of the Database Home. Applies to Exadata and Exadata Cloud@Customer systems.
createDatabase
in interface Database
request
- The request object containing the details to sendpublic CreateDatabaseSoftwareImageResponse createDatabaseSoftwareImage(CreateDatabaseSoftwareImageRequest request)
Database
create database software image in the specified compartment.
createDatabaseSoftwareImage
in interface Database
request
- The request object containing the details to sendpublic CreateDbHomeResponse createDbHome(CreateDbHomeRequest request)
Database
Creates a new Database Home in the specified database system based on the request parameters you provide. Applies to bare metal DB systems, Exadata systems, and Exadata Cloud@Customer systems.
createDbHome
in interface Database
request
- The request object containing the details to sendpublic CreateExadataInfrastructureResponse createExadataInfrastructure(CreateExadataInfrastructureRequest request)
Database
Creates an Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only.
To create an Exadata Cloud Service infrastructure resource, use the createCloudExadataInfrastructure
operation.
createExadataInfrastructure
in interface Database
request
- The request object containing the details to sendpublic CreateExadbVmClusterResponse createExadbVmCluster(CreateExadbVmClusterRequest request)
Database
Creates an Exadata VM cluster on Exascale Infrastructure
createExadbVmCluster
in interface Database
request
- The request object containing the details to sendpublic CreateExascaleDbStorageVaultResponse createExascaleDbStorageVault(CreateExascaleDbStorageVaultRequest request)
Database
Creates an Exadata Database Storage Vault
createExascaleDbStorageVault
in interface Database
request
- The request object containing the details to sendpublic CreateExecutionActionResponse createExecutionAction(CreateExecutionActionRequest request)
Database
Creates an execution action resource.
createExecutionAction
in interface Database
request
- The request object containing the details to sendpublic CreateExecutionWindowResponse createExecutionWindow(CreateExecutionWindowRequest request)
Database
Creates an execution window resource.
createExecutionWindow
in interface Database
request
- The request object containing the details to sendpublic CreateExternalBackupJobResponse createExternalBackupJob(CreateExternalBackupJobRequest request)
Database
Creates a new backup resource and returns the information the caller needs to back up an on-premises Oracle Database to Oracle Cloud Infrastructure.
*Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](https://docs.cloud.oracle.com/Content/Database/Tasks/mig-onprembackup.htm) for more information.
createExternalBackupJob
in interface Database
request
- The request object containing the details to sendpublic CreateExternalContainerDatabaseResponse createExternalContainerDatabase(CreateExternalContainerDatabaseRequest request)
Database
Creates a new external container database resource.
createExternalContainerDatabase
in interface Database
request
- The request object containing the details to sendpublic CreateExternalDatabaseConnectorResponse createExternalDatabaseConnector(CreateExternalDatabaseConnectorRequest request)
Database
Creates a new external database connector.
createExternalDatabaseConnector
in interface Database
request
- The request object containing the details to sendpublic CreateExternalNonContainerDatabaseResponse createExternalNonContainerDatabase(CreateExternalNonContainerDatabaseRequest request)
Database
Creates a new ExternalNonContainerDatabase resource
createExternalNonContainerDatabase
in interface Database
request
- The request object containing the details to sendpublic CreateExternalPluggableDatabaseResponse createExternalPluggableDatabase(CreateExternalPluggableDatabaseRequest request)
Database
Registers a new createExternalPluggableDatabaseDetails
resource.
createExternalPluggableDatabase
in interface Database
request
- The request object containing the details to sendpublic CreateKeyStoreResponse createKeyStore(CreateKeyStoreRequest request)
Database
Creates a Key Store.
createKeyStore
in interface Database
request
- The request object containing the details to sendpublic CreateMaintenanceRunResponse createMaintenanceRun(CreateMaintenanceRunRequest request)
Database
Creates a maintenance run with one of the following: 1. The latest available release update patch (RUP) for the Autonomous Container Database. 2. The latest available RUP and DST time-zone (TZ) file updates for the Autonomous Container Database. 3. The DST TZ file updates for the Autonomous Container Database.
createMaintenanceRun
in interface Database
request
- The request object containing the details to sendpublic CreateOneoffPatchResponse createOneoffPatch(CreateOneoffPatchRequest request)
Database
Creates one-off patch for specified database version to download.
createOneoffPatch
in interface Database
request
- The request object containing the details to sendpublic CreatePluggableDatabaseResponse createPluggableDatabase(CreatePluggableDatabaseRequest request)
Database
Creates and starts a pluggable database in the specified container database. Pluggable
Database can be created using different operations (e.g. LocalClone, RemoteClone, Relocate )
with this API. Use the startPluggableDatabase
and stopPluggableDatabase
APIs to start and stop the pluggable database.
createPluggableDatabase
in interface Database
request
- The request object containing the details to sendpublic CreateScheduledActionResponse createScheduledAction(CreateScheduledActionRequest request)
Database
Creates a Scheduled Action resource.
createScheduledAction
in interface Database
request
- The request object containing the details to sendpublic CreateSchedulingPlanResponse createSchedulingPlan(CreateSchedulingPlanRequest request)
Database
Creates a Scheduling Plan resource.
createSchedulingPlan
in interface Database
request
- The request object containing the details to sendpublic CreateSchedulingPolicyResponse createSchedulingPolicy(CreateSchedulingPolicyRequest request)
Database
Creates a Scheduling Policy resource.
createSchedulingPolicy
in interface Database
request
- The request object containing the details to sendpublic CreateSchedulingWindowResponse createSchedulingWindow(CreateSchedulingWindowRequest request)
Database
Creates a Scheduling Window resource.
createSchedulingWindow
in interface Database
request
- The request object containing the details to sendpublic CreateVmClusterResponse createVmCluster(CreateVmClusterRequest request)
Database
Creates an Exadata Cloud@Customer VM cluster.
createVmCluster
in interface Database
request
- The request object containing the details to sendpublic CreateVmClusterNetworkResponse createVmClusterNetwork(CreateVmClusterNetworkRequest request)
Database
Creates the VM cluster network. Applies to Exadata Cloud@Customer instances only. To create a
cloud VM cluster in an Exadata Cloud Service instance, use the createCloudVmCluster
operation.
createVmClusterNetwork
in interface Database
request
- The request object containing the details to sendpublic DbNodeActionResponse dbNodeAction(DbNodeActionRequest request)
Database
Performs one of the following power actions on the specified DB node: - start - power on - stop - power off - softreset - ACPI shutdown and power on - reset - power off and power on
*Note:** Stopping a node affects billing differently, depending on the type of DB system:
*Bare metal and Exadata systems* - The _stop_ state has no effect on the resources you
consume. Billing continues for DB nodes that you stop, and related resources continue to
apply against any relevant quotas. You must terminate the DB system (terminateDbSystem
) to remove its resources from
billing and quotas. *Virtual machine DB systems* - Stopping a node stops billing for all
OCPUs associated with that node, and billing resumes when you restart the node.
dbNodeAction
in interface Database
request
- The request object containing the details to sendpublic DeleteApplicationVipResponse deleteApplicationVip(DeleteApplicationVipRequest request)
Database
Deletes and deregisters the specified application virtual IP (VIP) address.
deleteApplicationVip
in interface Database
request
- The request object containing the details to sendpublic DeleteAutonomousDatabaseResponse deleteAutonomousDatabase(DeleteAutonomousDatabaseRequest request)
Database
Deletes the specified Autonomous Database.
deleteAutonomousDatabase
in interface Database
request
- The request object containing the details to sendpublic DeleteAutonomousDatabaseBackupResponse deleteAutonomousDatabaseBackup(DeleteAutonomousDatabaseBackupRequest request)
Database
Deletes a long-term backup. You cannot delete other backups using this API.
deleteAutonomousDatabaseBackup
in interface Database
request
- The request object containing the details to sendpublic DeleteAutonomousDatabaseSoftwareImageResponse deleteAutonomousDatabaseSoftwareImage(DeleteAutonomousDatabaseSoftwareImageRequest request)
Database
Delete an Autonomous Database Software Image
deleteAutonomousDatabaseSoftwareImage
in interface Database
request
- The request object containing the details to sendpublic DeleteAutonomousVmClusterResponse deleteAutonomousVmCluster(DeleteAutonomousVmClusterRequest request)
Database
Deletes the specified Autonomous VM cluster in an Exadata Cloud@Customer system. To delete an
Autonomous VM Cluster in the Oracle cloud, see deleteCloudAutonomousVmCluster
.
deleteAutonomousVmCluster
in interface Database
request
- The request object containing the details to sendpublic DeleteBackupResponse deleteBackup(DeleteBackupRequest request)
Database
Deletes a full backup. You cannot delete automatic backups using this API.
deleteBackup
in interface Database
request
- The request object containing the details to sendpublic DeleteBackupDestinationResponse deleteBackupDestination(DeleteBackupDestinationRequest request)
Database
Deletes a backup destination in an Exadata Cloud@Customer system.
deleteBackupDestination
in interface Database
request
- The request object containing the details to sendpublic DeleteCloudAutonomousVmClusterResponse deleteCloudAutonomousVmCluster(DeleteCloudAutonomousVmClusterRequest request)
Database
Deletes the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata
Cloud@Customer systems, see deleteAutonomousVmCluster
.
deleteCloudAutonomousVmCluster
in interface Database
request
- The request object containing the details to sendpublic DeleteCloudExadataInfrastructureResponse deleteCloudExadataInfrastructure(DeleteCloudExadataInfrastructureRequest request)
Database
Deletes the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
deleteCloudExadataInfrastructure
in interface Database
request
- The request object containing the details to sendpublic DeleteCloudVmClusterResponse deleteCloudVmCluster(DeleteCloudVmClusterRequest request)
Database
Deletes the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
deleteCloudVmCluster
in interface Database
request
- The request object containing the details to sendpublic DeleteConsoleConnectionResponse deleteConsoleConnection(DeleteConsoleConnectionRequest request)
Database
Deletes the specified database node console connection.
deleteConsoleConnection
in interface Database
request
- The request object containing the details to sendpublic DeleteConsoleHistoryResponse deleteConsoleHistory(DeleteConsoleHistoryRequest request)
Database
Deletes the specified database node console history.
deleteConsoleHistory
in interface Database
request
- The request object containing the details to sendpublic DeleteDatabaseResponse deleteDatabase(DeleteDatabaseRequest request)
Database
Deletes the specified database. Applies only to Exadata systems.
The data in this database is local to the Exadata system and will be lost when the database is deleted. Oracle recommends that you back up any data in the Exadata system prior to deleting it. You can use the `performFinalBackup` parameter to have the Exadata system database backed up before it is deleted.
deleteDatabase
in interface Database
request
- The request object containing the details to sendpublic DeleteDatabaseSoftwareImageResponse deleteDatabaseSoftwareImage(DeleteDatabaseSoftwareImageRequest request)
Database
Delete a database software image
deleteDatabaseSoftwareImage
in interface Database
request
- The request object containing the details to sendpublic DeleteDbHomeResponse deleteDbHome(DeleteDbHomeRequest request)
Database
Deletes a Database Home. Applies to bare metal DB systems, Exadata Cloud Service, and Exadata Cloud@Customer systems.
Oracle recommends that you use the `performFinalBackup` parameter to back up any data on a bare metal DB system before you delete a Database Home. On an Exadata Cloud@Customer system or an Exadata Cloud Service system, you can delete a Database Home only when there are no databases in it and therefore you cannot use the `performFinalBackup` parameter to back up data.
deleteDbHome
in interface Database
request
- The request object containing the details to sendpublic DeleteExadataInfrastructureResponse deleteExadataInfrastructure(DeleteExadataInfrastructureRequest request)
Database
Deletes the Exadata Cloud@Customer infrastructure.
deleteExadataInfrastructure
in interface Database
request
- The request object containing the details to sendpublic DeleteExadbVmClusterResponse deleteExadbVmCluster(DeleteExadbVmClusterRequest request)
Database
Deletes the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.
deleteExadbVmCluster
in interface Database
request
- The request object containing the details to sendpublic DeleteExascaleDbStorageVaultResponse deleteExascaleDbStorageVault(DeleteExascaleDbStorageVaultRequest request)
Database
Deletes the specified Exadata Database Storage Vault.
deleteExascaleDbStorageVault
in interface Database
request
- The request object containing the details to sendpublic DeleteExecutionActionResponse deleteExecutionAction(DeleteExecutionActionRequest request)
Database
Deletes the execution action.
deleteExecutionAction
in interface Database
request
- The request object containing the details to sendpublic DeleteExecutionWindowResponse deleteExecutionWindow(DeleteExecutionWindowRequest request)
Database
Deletes the execution window.
deleteExecutionWindow
in interface Database
request
- The request object containing the details to sendpublic DeleteExternalContainerDatabaseResponse deleteExternalContainerDatabase(DeleteExternalContainerDatabaseRequest request)
Database
Deletes the createExternalContainerDatabaseDetails
resource. Any external pluggable databases registered
under this container database must be deleted in your Oracle Cloud Infrastructure tenancy
prior to this operation.
deleteExternalContainerDatabase
in interface Database
request
- The request object containing the details to sendpublic DeleteExternalDatabaseConnectorResponse deleteExternalDatabaseConnector(DeleteExternalDatabaseConnectorRequest request)
Database
Deletes an external database connector. Any services enabled using the external database connector must be deleted prior to this operation.
deleteExternalDatabaseConnector
in interface Database
request
- The request object containing the details to sendpublic DeleteExternalNonContainerDatabaseResponse deleteExternalNonContainerDatabase(DeleteExternalNonContainerDatabaseRequest request)
Database
Deletes the Oracle Cloud Infrastructure resource representing an external non-container database.
deleteExternalNonContainerDatabase
in interface Database
request
- The request object containing the details to sendpublic DeleteExternalPluggableDatabaseResponse deleteExternalPluggableDatabase(DeleteExternalPluggableDatabaseRequest request)
Database
Deletes the createExternalPluggableDatabaseDetails
. resource.
deleteExternalPluggableDatabase
in interface Database
request
- The request object containing the details to sendpublic DeleteKeyStoreResponse deleteKeyStore(DeleteKeyStoreRequest request)
Database
Deletes a key store.
deleteKeyStore
in interface Database
request
- The request object containing the details to sendpublic DeleteOneoffPatchResponse deleteOneoffPatch(DeleteOneoffPatchRequest request)
Database
Deletes a one-off patch.
deleteOneoffPatch
in interface Database
request
- The request object containing the details to sendpublic DeletePluggableDatabaseResponse deletePluggableDatabase(DeletePluggableDatabaseRequest request)
Database
Deletes the specified pluggable database.
deletePluggableDatabase
in interface Database
request
- The request object containing the details to sendpublic DeleteScheduledActionResponse deleteScheduledAction(DeleteScheduledActionRequest request)
Database
Deletes the scheduled action.
deleteScheduledAction
in interface Database
request
- The request object containing the details to sendpublic DeleteSchedulingPlanResponse deleteSchedulingPlan(DeleteSchedulingPlanRequest request)
Database
Deletes the scheduling plan.
deleteSchedulingPlan
in interface Database
request
- The request object containing the details to sendpublic DeleteSchedulingPolicyResponse deleteSchedulingPolicy(DeleteSchedulingPolicyRequest request)
Database
Deletes the scheduling policy.
deleteSchedulingPolicy
in interface Database
request
- The request object containing the details to sendpublic DeleteSchedulingWindowResponse deleteSchedulingWindow(DeleteSchedulingWindowRequest request)
Database
Deletes the scheduling window.
deleteSchedulingWindow
in interface Database
request
- The request object containing the details to sendpublic DeleteVmClusterResponse deleteVmCluster(DeleteVmClusterRequest request)
Database
Deletes the specified VM cluster. Applies to Exadata Cloud@Customer instances only.
deleteVmCluster
in interface Database
request
- The request object containing the details to sendpublic DeleteVmClusterNetworkResponse deleteVmClusterNetwork(DeleteVmClusterNetworkRequest request)
Database
Deletes the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.
To delete a cloud VM cluster in an Exadata Cloud Service instance, use the deleteCloudVmCluster
operation.
deleteVmClusterNetwork
in interface Database
request
- The request object containing the details to sendpublic DeregisterAutonomousDatabaseDataSafeResponse deregisterAutonomousDatabaseDataSafe(DeregisterAutonomousDatabaseDataSafeRequest request)
Database
Asynchronously deregisters this Autonomous Database with Data Safe.
deregisterAutonomousDatabaseDataSafe
in interface Database
request
- The request object containing the details to sendpublic DisableAutonomousDatabaseManagementResponse disableAutonomousDatabaseManagement(DisableAutonomousDatabaseManagementRequest request)
Database
Disables Database Management for the Autonomous Database resource.
disableAutonomousDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic DisableAutonomousDatabaseOperationsInsightsResponse disableAutonomousDatabaseOperationsInsights(DisableAutonomousDatabaseOperationsInsightsRequest request)
Database
Disables Operations Insights for the Autonomous Database resource.
disableAutonomousDatabaseOperationsInsights
in interface Database
request
- The request object containing the details to sendpublic DisableDatabaseManagementResponse disableDatabaseManagement(DisableDatabaseManagementRequest request)
Database
Disables the Database Management service for the database.
disableDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic DisableExternalContainerDatabaseDatabaseManagementResponse disableExternalContainerDatabaseDatabaseManagement(DisableExternalContainerDatabaseDatabaseManagementRequest request)
Database
Disable Database Management service for the external container database.
disableExternalContainerDatabaseDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic DisableExternalContainerDatabaseStackMonitoringResponse disableExternalContainerDatabaseStackMonitoring(DisableExternalContainerDatabaseStackMonitoringRequest request)
Database
Disable Stack Monitoring for the external container database.
disableExternalContainerDatabaseStackMonitoring
in interface Database
request
- The request object containing the details to sendpublic DisableExternalNonContainerDatabaseDatabaseManagementResponse disableExternalNonContainerDatabaseDatabaseManagement(DisableExternalNonContainerDatabaseDatabaseManagementRequest request)
Database
Disable Database Management Service for the external non-container database. For more information about the Database Management Service, see Database Management Service.
disableExternalNonContainerDatabaseDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic DisableExternalNonContainerDatabaseOperationsInsightsResponse disableExternalNonContainerDatabaseOperationsInsights(DisableExternalNonContainerDatabaseOperationsInsightsRequest request)
Database
Disable Operations Insights for the external non-container database.
disableExternalNonContainerDatabaseOperationsInsights
in interface Database
request
- The request object containing the details to sendpublic DisableExternalNonContainerDatabaseStackMonitoringResponse disableExternalNonContainerDatabaseStackMonitoring(DisableExternalNonContainerDatabaseStackMonitoringRequest request)
Database
Disable Stack Monitoring for the external non-container database.
disableExternalNonContainerDatabaseStackMonitoring
in interface Database
request
- The request object containing the details to sendpublic DisableExternalPluggableDatabaseDatabaseManagementResponse disableExternalPluggableDatabaseDatabaseManagement(DisableExternalPluggableDatabaseDatabaseManagementRequest request)
Database
Disable Database Management Service for the external pluggable database. For more information about the Database Management Service, see Database Management Service.
disableExternalPluggableDatabaseDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic DisableExternalPluggableDatabaseOperationsInsightsResponse disableExternalPluggableDatabaseOperationsInsights(DisableExternalPluggableDatabaseOperationsInsightsRequest request)
Database
Disable Operations Insights for the external pluggable database.
disableExternalPluggableDatabaseOperationsInsights
in interface Database
request
- The request object containing the details to sendpublic DisableExternalPluggableDatabaseStackMonitoringResponse disableExternalPluggableDatabaseStackMonitoring(DisableExternalPluggableDatabaseStackMonitoringRequest request)
Database
Disable Stack Monitoring for the external pluggable database.
disableExternalPluggableDatabaseStackMonitoring
in interface Database
request
- The request object containing the details to sendpublic DisablePluggableDatabaseManagementResponse disablePluggableDatabaseManagement(DisablePluggableDatabaseManagementRequest request)
Database
Disables the Database Management service for the pluggable database.
disablePluggableDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic DownloadExadataInfrastructureConfigFileResponse downloadExadataInfrastructureConfigFile(DownloadExadataInfrastructureConfigFileRequest request)
Database
Downloads the configuration file for the specified Exadata Cloud@Customer infrastructure.
downloadExadataInfrastructureConfigFile
in interface Database
request
- The request object containing the details to sendpublic DownloadOneoffPatchResponse downloadOneoffPatch(DownloadOneoffPatchRequest request)
Database
Download one-off patch.
downloadOneoffPatch
in interface Database
request
- The request object containing the details to sendpublic DownloadValidationReportResponse downloadValidationReport(DownloadValidationReportRequest request)
Database
Downloads the network validation report file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.
downloadValidationReport
in interface Database
request
- The request object containing the details to sendpublic DownloadVmClusterNetworkConfigFileResponse downloadVmClusterNetworkConfigFile(DownloadVmClusterNetworkConfigFileRequest request)
Database
Downloads the configuration file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.
downloadVmClusterNetworkConfigFile
in interface Database
request
- The request object containing the details to sendpublic EnableAutonomousDatabaseManagementResponse enableAutonomousDatabaseManagement(EnableAutonomousDatabaseManagementRequest request)
Database
Enables Database Management for Autonomous Database.
enableAutonomousDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic EnableAutonomousDatabaseOperationsInsightsResponse enableAutonomousDatabaseOperationsInsights(EnableAutonomousDatabaseOperationsInsightsRequest request)
Database
Enables the specified Autonomous Database with Operations Insights.
enableAutonomousDatabaseOperationsInsights
in interface Database
request
- The request object containing the details to sendpublic EnableDatabaseManagementResponse enableDatabaseManagement(EnableDatabaseManagementRequest request)
Database
Enables the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure. This service allows the database to access tools including Metrics and Performance hub. Database Management is enabled at the container database (CDB) level.
enableDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic EnableExternalContainerDatabaseDatabaseManagementResponse enableExternalContainerDatabaseDatabaseManagement(EnableExternalContainerDatabaseDatabaseManagementRequest request)
Database
Enables Database Management Service for the external container database. For more information about the Database Management Service, see Database Management Service.
enableExternalContainerDatabaseDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic EnableExternalContainerDatabaseStackMonitoringResponse enableExternalContainerDatabaseStackMonitoring(EnableExternalContainerDatabaseStackMonitoringRequest request)
Database
Enable Stack Monitoring for the external container database.
enableExternalContainerDatabaseStackMonitoring
in interface Database
request
- The request object containing the details to sendpublic EnableExternalNonContainerDatabaseDatabaseManagementResponse enableExternalNonContainerDatabaseDatabaseManagement(EnableExternalNonContainerDatabaseDatabaseManagementRequest request)
Database
Enable Database Management Service for the external non-container database. For more information about the Database Management Service, see Database Management Service.
enableExternalNonContainerDatabaseDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic EnableExternalNonContainerDatabaseOperationsInsightsResponse enableExternalNonContainerDatabaseOperationsInsights(EnableExternalNonContainerDatabaseOperationsInsightsRequest request)
Database
Enable Operations Insights for the external non-container database.
enableExternalNonContainerDatabaseOperationsInsights
in interface Database
request
- The request object containing the details to sendpublic EnableExternalNonContainerDatabaseStackMonitoringResponse enableExternalNonContainerDatabaseStackMonitoring(EnableExternalNonContainerDatabaseStackMonitoringRequest request)
Database
Enable Stack Monitoring for the external non-container database.
enableExternalNonContainerDatabaseStackMonitoring
in interface Database
request
- The request object containing the details to sendpublic EnableExternalPluggableDatabaseDatabaseManagementResponse enableExternalPluggableDatabaseDatabaseManagement(EnableExternalPluggableDatabaseDatabaseManagementRequest request)
Database
Enable Database Management Service for the external pluggable database. For more information about the Database Management Service, see Database Management Service.
enableExternalPluggableDatabaseDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic EnableExternalPluggableDatabaseOperationsInsightsResponse enableExternalPluggableDatabaseOperationsInsights(EnableExternalPluggableDatabaseOperationsInsightsRequest request)
Database
Enable Operations Insights for the external pluggable database.
enableExternalPluggableDatabaseOperationsInsights
in interface Database
request
- The request object containing the details to sendpublic EnableExternalPluggableDatabaseStackMonitoringResponse enableExternalPluggableDatabaseStackMonitoring(EnableExternalPluggableDatabaseStackMonitoringRequest request)
Database
Enable Stack Monitoring for the external pluggable database.
enableExternalPluggableDatabaseStackMonitoring
in interface Database
request
- The request object containing the details to sendpublic EnablePluggableDatabaseManagementResponse enablePluggableDatabaseManagement(EnablePluggableDatabaseManagementRequest request)
Database
Enables the Database Management service for an Oracle Pluggable Database located in Oracle Cloud Infrastructure. This service allows the pluggable database to access tools including Metrics and Performance hub. Database Management is enabled at the pluggable database (PDB) level.
enablePluggableDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic FailOverAutonomousDatabaseResponse failOverAutonomousDatabase(FailOverAutonomousDatabaseRequest request)
Database
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.
failOverAutonomousDatabase
in interface Database
request
- The request object containing the details to sendpublic FailoverAutonomousContainerDatabaseDataguardAssociationResponse failoverAutonomousContainerDatabaseDataguardAssociation(FailoverAutonomousContainerDatabaseDataguardAssociationRequest request)
Database
Fails over the standby Autonomous Container Database identified by the autonomousContainerDatabaseId parameter to the primary Autonomous Container Database after the existing primary Autonomous Container Database fails or becomes unreachable.
A failover can result in data loss, depending on the protection mode in effect at the time the primary Autonomous Container Database fails.
failoverAutonomousContainerDatabaseDataguardAssociation
in interface Database
request
- The request object containing the details to sendpublic FailoverDataGuardAssociationResponse failoverDataGuardAssociation(FailoverDataGuardAssociationRequest request)
Database
Performs a failover to transition the standby database identified by the databaseId
parameter into the specified Data Guard association’s primary role after the existing primary
database fails or becomes unreachable.
A failover might result in data loss depending on the protection mode in effect at the time of the primary database failure.
failoverDataGuardAssociation
in interface Database
request
- The request object containing the details to sendpublic GenerateAutonomousDatabaseWalletResponse generateAutonomousDatabaseWallet(GenerateAutonomousDatabaseWalletRequest request)
Database
Creates and downloads a wallet for the specified Autonomous Database.
generateAutonomousDatabaseWallet
in interface Database
request
- The request object containing the details to sendpublic GenerateRecommendedVmClusterNetworkResponse generateRecommendedVmClusterNetwork(GenerateRecommendedVmClusterNetworkRequest request)
Database
Generates a recommended Cloud@Customer VM cluster network configuration.
generateRecommendedVmClusterNetwork
in interface Database
request
- The request object containing the details to sendpublic GetApplicationVipResponse getApplicationVip(GetApplicationVipRequest request)
Database
Gets information about a specified application virtual IP (VIP) address.
getApplicationVip
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousContainerDatabaseResponse getAutonomousContainerDatabase(GetAutonomousContainerDatabaseRequest request)
Database
Gets information about the specified Autonomous Container Database.
getAutonomousContainerDatabase
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousContainerDatabaseDataguardAssociationResponse getAutonomousContainerDatabaseDataguardAssociation(GetAutonomousContainerDatabaseDataguardAssociationRequest request)
Database
Gets an Autonomous Container Database enabled with Autonomous Data Guard associated with the specified Autonomous Container Database.
getAutonomousContainerDatabaseDataguardAssociation
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousContainerDatabaseResourceUsageResponse getAutonomousContainerDatabaseResourceUsage(GetAutonomousContainerDatabaseResourceUsageRequest request)
Database
Get resource usage details for the specified Autonomous Container Database.
getAutonomousContainerDatabaseResourceUsage
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousDatabaseResponse getAutonomousDatabase(GetAutonomousDatabaseRequest request)
Database
Gets the details of the specified Autonomous Database.
getAutonomousDatabase
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousDatabaseBackupResponse getAutonomousDatabaseBackup(GetAutonomousDatabaseBackupRequest request)
Database
Gets information about the specified Autonomous Database backup.
getAutonomousDatabaseBackup
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousDatabaseDataguardAssociationResponse getAutonomousDatabaseDataguardAssociation(GetAutonomousDatabaseDataguardAssociationRequest request)
Database
Gets an Autonomous Data Guard-enabled database associated with the specified Autonomous Database.
getAutonomousDatabaseDataguardAssociation
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousDatabaseRegionalWalletResponse getAutonomousDatabaseRegionalWallet(GetAutonomousDatabaseRegionalWalletRequest request)
Database
Gets the Autonomous Database regional wallet details.
getAutonomousDatabaseRegionalWallet
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousDatabaseSoftwareImageResponse getAutonomousDatabaseSoftwareImage(GetAutonomousDatabaseSoftwareImageRequest request)
Database
Gets information about the specified Autonomous Database Software Image.
getAutonomousDatabaseSoftwareImage
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousDatabaseWalletResponse getAutonomousDatabaseWallet(GetAutonomousDatabaseWalletRequest request)
Database
Gets the wallet details for the specified Autonomous Database.
getAutonomousDatabaseWallet
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousExadataInfrastructureResponse getAutonomousExadataInfrastructure(GetAutonomousExadataInfrastructureRequest request)
Database
Deprecated. Use the getCloudExadataInfrastructure
operation to get details of an Exadata Infrastructure resource
and the getCloudAutonomousVmCluster
operation to get details of an Autonomous Exadata VM cluster.
getAutonomousExadataInfrastructure
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousPatchResponse getAutonomousPatch(GetAutonomousPatchRequest request)
Database
Gets information about a specific autonomous patch.
getAutonomousPatch
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousVirtualMachineResponse getAutonomousVirtualMachine(GetAutonomousVirtualMachineRequest request)
Database
Gets the details of specific Autonomous Virtual Machine.
getAutonomousVirtualMachine
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousVmClusterResponse getAutonomousVmCluster(GetAutonomousVmClusterRequest request)
Database
Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer
system. To get information about an Autonomous VM Cluster in the Oracle cloud, see getCloudAutonomousVmCluster
.
getAutonomousVmCluster
in interface Database
request
- The request object containing the details to sendpublic GetAutonomousVmClusterResourceUsageResponse getAutonomousVmClusterResourceUsage(GetAutonomousVmClusterResourceUsageRequest request)
Database
Get the resource usage details for the specified Autonomous Exadata VM cluster.
getAutonomousVmClusterResourceUsage
in interface Database
request
- The request object containing the details to sendpublic GetBackupResponse getBackup(GetBackupRequest request)
Database
Gets information about the specified backup.
public GetBackupDestinationResponse getBackupDestination(GetBackupDestinationRequest request)
Database
Gets information about the specified backup destination in an Exadata Cloud@Customer system.
getBackupDestination
in interface Database
request
- The request object containing the details to sendpublic GetCloudAutonomousVmClusterResponse getCloudAutonomousVmCluster(GetCloudAutonomousVmClusterRequest request)
Database
Gets information about the specified Autonomous Exadata VM cluster in the Oracle cloud. For
Exadata Cloud@Custustomer systems, see getAutonomousVmCluster
.
getCloudAutonomousVmCluster
in interface Database
request
- The request object containing the details to sendpublic GetCloudAutonomousVmClusterResourceUsageResponse getCloudAutonomousVmClusterResourceUsage(GetCloudAutonomousVmClusterResourceUsageRequest request)
Database
Get the resource usage details for the specified Cloud Autonomous Exadata VM cluster.
getCloudAutonomousVmClusterResourceUsage
in interface Database
request
- The request object containing the details to sendpublic GetCloudExadataInfrastructureResponse getCloudExadataInfrastructure(GetCloudExadataInfrastructureRequest request)
Database
Gets information about the specified cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
getCloudExadataInfrastructure
in interface Database
request
- The request object containing the details to sendpublic GetCloudExadataInfrastructureUnallocatedResourcesResponse getCloudExadataInfrastructureUnallocatedResources(GetCloudExadataInfrastructureUnallocatedResourcesRequest request)
Database
Gets unallocated resources information for the specified Cloud Exadata infrastructure.
getCloudExadataInfrastructureUnallocatedResources
in interface Database
request
- The request object containing the details to sendpublic GetCloudVmClusterResponse getCloudVmCluster(GetCloudVmClusterRequest request)
Database
Gets information about the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
getCloudVmCluster
in interface Database
request
- The request object containing the details to sendpublic GetCloudVmClusterIormConfigResponse getCloudVmClusterIormConfig(GetCloudVmClusterIormConfigRequest request)
Database
Gets the IORM configuration for the specified cloud VM cluster in an Exadata Cloud Service instance. If you have not specified an IORM configuration, the default configuration is returned.
getCloudVmClusterIormConfig
in interface Database
request
- The request object containing the details to sendpublic GetCloudVmClusterUpdateResponse getCloudVmClusterUpdate(GetCloudVmClusterUpdateRequest request)
Database
Gets information about a specified maintenance update package for a cloud VM cluster. Applies to Exadata Cloud Service instances only.
getCloudVmClusterUpdate
in interface Database
request
- The request object containing the details to sendpublic GetCloudVmClusterUpdateHistoryEntryResponse getCloudVmClusterUpdateHistoryEntry(GetCloudVmClusterUpdateHistoryEntryRequest request)
Database
Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud Service instances only.
getCloudVmClusterUpdateHistoryEntry
in interface Database
request
- The request object containing the details to sendpublic GetConsoleConnectionResponse getConsoleConnection(GetConsoleConnectionRequest request)
Database
Gets the specified database node console connection’s information.
getConsoleConnection
in interface Database
request
- The request object containing the details to sendpublic GetConsoleHistoryResponse getConsoleHistory(GetConsoleHistoryRequest request)
Database
Gets information about the specified database node console history.
getConsoleHistory
in interface Database
request
- The request object containing the details to sendpublic GetConsoleHistoryContentResponse getConsoleHistoryContent(GetConsoleHistoryContentRequest request)
Database
Retrieves the specified database node console history contents upto a megabyte.
getConsoleHistoryContent
in interface Database
request
- The request object containing the details to sendpublic GetDataGuardAssociationResponse getDataGuardAssociation(GetDataGuardAssociationRequest request)
Database
Gets the specified Data Guard association’s configuration information.
getDataGuardAssociation
in interface Database
request
- The request object containing the details to sendpublic GetDatabaseResponse getDatabase(GetDatabaseRequest request)
Database
Gets information about the specified database.
getDatabase
in interface Database
request
- The request object containing the details to sendpublic GetDatabaseSoftwareImageResponse getDatabaseSoftwareImage(GetDatabaseSoftwareImageRequest request)
Database
Gets information about the specified database software image.
getDatabaseSoftwareImage
in interface Database
request
- The request object containing the details to sendpublic GetDatabaseUpgradeHistoryEntryResponse getDatabaseUpgradeHistoryEntry(GetDatabaseUpgradeHistoryEntryRequest request)
Database
gets the upgrade history for a specified database.
getDatabaseUpgradeHistoryEntry
in interface Database
request
- The request object containing the details to sendpublic GetDbHomeResponse getDbHome(GetDbHomeRequest request)
Database
Gets information about the specified Database Home.
public GetDbHomePatchResponse getDbHomePatch(GetDbHomePatchRequest request)
Database
Gets information about a specified patch package.
getDbHomePatch
in interface Database
request
- The request object containing the details to sendpublic GetDbHomePatchHistoryEntryResponse getDbHomePatchHistoryEntry(GetDbHomePatchHistoryEntryRequest request)
Database
Gets the patch history details for the specified patchHistoryEntryId
getDbHomePatchHistoryEntry
in interface Database
request
- The request object containing the details to sendpublic GetDbNodeResponse getDbNode(GetDbNodeRequest request)
Database
Gets information about the specified database node.
public GetDbServerResponse getDbServer(GetDbServerRequest request)
Database
Gets information about the Exadata Db server.
getDbServer
in interface Database
request
- The request object containing the details to sendpublic GetDbSystemResponse getDbSystem(GetDbSystemRequest request)
Database
Gets information about the specified DB system.
*Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.
For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.
getDbSystem
in interface Database
request
- The request object containing the details to sendpublic GetDbSystemPatchResponse getDbSystemPatch(GetDbSystemPatchRequest request)
Database
Gets information the specified patch.
getDbSystemPatch
in interface Database
request
- The request object containing the details to sendpublic GetDbSystemPatchHistoryEntryResponse getDbSystemPatchHistoryEntry(GetDbSystemPatchHistoryEntryRequest request)
Database
Gets the details of the specified patch operation on the specified DB system.
getDbSystemPatchHistoryEntry
in interface Database
request
- The request object containing the details to sendpublic GetDbSystemUpgradeHistoryEntryResponse getDbSystemUpgradeHistoryEntry(GetDbSystemUpgradeHistoryEntryRequest request)
Database
Gets the details of the specified operating system upgrade operation for the specified DB system.
getDbSystemUpgradeHistoryEntry
in interface Database
request
- The request object containing the details to sendpublic GetExadataInfrastructureResponse getExadataInfrastructure(GetExadataInfrastructureRequest request)
Database
Gets information about the specified Exadata infrastructure. Applies to Exadata
Cloud@Customer instances only. To get information on an Exadata Cloud Service infrastructure
resource, use the getCloudExadataInfrastructure
operation.
getExadataInfrastructure
in interface Database
request
- The request object containing the details to sendpublic GetExadataInfrastructureOcpusResponse getExadataInfrastructureOcpus(GetExadataInfrastructureOcpusRequest request)
Database
Gets details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure resource.
getExadataInfrastructureOcpus
in interface Database
request
- The request object containing the details to sendpublic GetExadataInfrastructureUnAllocatedResourcesResponse getExadataInfrastructureUnAllocatedResources(GetExadataInfrastructureUnAllocatedResourcesRequest request)
Database
Gets un allocated resources information for the specified Exadata infrastructure. Applies to Exadata Cloud@Customer instances only.
getExadataInfrastructureUnAllocatedResources
in interface Database
request
- The request object containing the details to sendpublic GetExadataIormConfigResponse getExadataIormConfig(GetExadataIormConfigRequest request)
Database
Gets the IORM configuration settings for the specified cloud Exadata DB system. All Exadata service instances have default IORM settings.
*Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.
For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.
The getCloudVmClusterIormConfig
API is used for this operation with Exadata systems using the
new resource model.
getExadataIormConfig
in interface Database
request
- The request object containing the details to sendpublic GetExadbVmClusterResponse getExadbVmCluster(GetExadbVmClusterRequest request)
Database
Gets information about the specified Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.
getExadbVmCluster
in interface Database
request
- The request object containing the details to sendpublic GetExadbVmClusterUpdateResponse getExadbVmClusterUpdate(GetExadbVmClusterUpdateRequest request)
Database
Gets information about a specified maintenance update package for a Exadata VM cluster on Exascale Infrastructure.
getExadbVmClusterUpdate
in interface Database
request
- The request object containing the details to sendpublic GetExadbVmClusterUpdateHistoryEntryResponse getExadbVmClusterUpdateHistoryEntry(GetExadbVmClusterUpdateHistoryEntryRequest request)
Database
Gets the maintenance update history details for the specified update history entry.
getExadbVmClusterUpdateHistoryEntry
in interface Database
request
- The request object containing the details to sendpublic GetExascaleDbStorageVaultResponse getExascaleDbStorageVault(GetExascaleDbStorageVaultRequest request)
Database
Gets information about the specified Exadata Database Storage Vaults in the specified compartment.
getExascaleDbStorageVault
in interface Database
request
- The request object containing the details to sendpublic GetExecutionActionResponse getExecutionAction(GetExecutionActionRequest request)
Database
Gets information about the specified execution action.
getExecutionAction
in interface Database
request
- The request object containing the details to sendpublic GetExecutionWindowResponse getExecutionWindow(GetExecutionWindowRequest request)
Database
Gets information about the specified execution window.
getExecutionWindow
in interface Database
request
- The request object containing the details to sendpublic GetExternalBackupJobResponse getExternalBackupJob(GetExternalBackupJobRequest request)
Database
Gets information about the specified external backup job.
*Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](https://docs.cloud.oracle.com/Content/Database/Tasks/mig-onprembackup.htm) for more information.
getExternalBackupJob
in interface Database
request
- The request object containing the details to sendpublic GetExternalContainerDatabaseResponse getExternalContainerDatabase(GetExternalContainerDatabaseRequest request)
Database
Gets information about the specified external container database.
getExternalContainerDatabase
in interface Database
request
- The request object containing the details to sendpublic GetExternalDatabaseConnectorResponse getExternalDatabaseConnector(GetExternalDatabaseConnectorRequest request)
Database
Gets information about the specified external database connector.
getExternalDatabaseConnector
in interface Database
request
- The request object containing the details to sendpublic GetExternalNonContainerDatabaseResponse getExternalNonContainerDatabase(GetExternalNonContainerDatabaseRequest request)
Database
Gets information about a specific external non-container database.
getExternalNonContainerDatabase
in interface Database
request
- The request object containing the details to sendpublic GetExternalPluggableDatabaseResponse getExternalPluggableDatabase(GetExternalPluggableDatabaseRequest request)
Database
Gets information about a specific createExternalPluggableDatabaseDetails
resource.
getExternalPluggableDatabase
in interface Database
request
- The request object containing the details to sendpublic GetInfrastructureTargetVersionsResponse getInfrastructureTargetVersions(GetInfrastructureTargetVersionsRequest request)
Database
Gets details of the Exadata Infrastructure target system software versions that can be applied to the specified infrastructure resource for maintenance updates. Applies to Exadata Cloud@Customer and Exadata Cloud instances only.
getInfrastructureTargetVersions
in interface Database
request
- The request object containing the details to sendpublic GetKeyStoreResponse getKeyStore(GetKeyStoreRequest request)
Database
Gets information about the specified key store.
getKeyStore
in interface Database
request
- The request object containing the details to sendpublic GetMaintenanceRunResponse getMaintenanceRun(GetMaintenanceRunRequest request)
Database
Gets information about the specified maintenance run.
getMaintenanceRun
in interface Database
request
- The request object containing the details to sendpublic GetMaintenanceRunHistoryResponse getMaintenanceRunHistory(GetMaintenanceRunHistoryRequest request)
Database
Gets information about the specified maintenance run history.
getMaintenanceRunHistory
in interface Database
request
- The request object containing the details to sendpublic GetOneoffPatchResponse getOneoffPatch(GetOneoffPatchRequest request)
Database
Gets information about the specified one-off patch.
getOneoffPatch
in interface Database
request
- The request object containing the details to sendpublic GetPdbConversionHistoryEntryResponse getPdbConversionHistoryEntry(GetPdbConversionHistoryEntryRequest request)
Database
Gets the details of operations performed to convert the specified database from non-container (non-CDB) to pluggable (PDB).
getPdbConversionHistoryEntry
in interface Database
request
- The request object containing the details to sendpublic GetPluggableDatabaseResponse getPluggableDatabase(GetPluggableDatabaseRequest request)
Database
Gets information about the specified pluggable database.
getPluggableDatabase
in interface Database
request
- The request object containing the details to sendpublic GetScheduledActionResponse getScheduledAction(GetScheduledActionRequest request)
Database
Gets information about the specified Scheduled Action.
getScheduledAction
in interface Database
request
- The request object containing the details to sendpublic GetSchedulingPlanResponse getSchedulingPlan(GetSchedulingPlanRequest request)
Database
Gets information about the specified Scheduling Plan.
getSchedulingPlan
in interface Database
request
- The request object containing the details to sendpublic GetSchedulingPolicyResponse getSchedulingPolicy(GetSchedulingPolicyRequest request)
Database
Gets information about the specified Scheduling Policy.
getSchedulingPolicy
in interface Database
request
- The request object containing the details to sendpublic GetSchedulingWindowResponse getSchedulingWindow(GetSchedulingWindowRequest request)
Database
Gets information about the specified Scheduling Window.
getSchedulingWindow
in interface Database
request
- The request object containing the details to sendpublic GetVmClusterResponse getVmCluster(GetVmClusterRequest request)
Database
Gets information about the VM cluster. Applies to Exadata Cloud@Customer instances only.
getVmCluster
in interface Database
request
- The request object containing the details to sendpublic GetVmClusterNetworkResponse getVmClusterNetwork(GetVmClusterNetworkRequest request)
Database
Gets information about the specified VM cluster network. Applies to Exadata Cloud@Customer
instances only. To get information about a cloud VM cluster in an Exadata Cloud Service
instance, use the getCloudVmCluster
operation.
getVmClusterNetwork
in interface Database
request
- The request object containing the details to sendpublic GetVmClusterPatchResponse getVmClusterPatch(GetVmClusterPatchRequest request)
Database
Gets information about a specified patch package.
getVmClusterPatch
in interface Database
request
- The request object containing the details to sendpublic GetVmClusterPatchHistoryEntryResponse getVmClusterPatchHistoryEntry(GetVmClusterPatchHistoryEntryRequest request)
Database
Gets the patch history details for the specified patch history entry.
getVmClusterPatchHistoryEntry
in interface Database
request
- The request object containing the details to sendpublic GetVmClusterUpdateResponse getVmClusterUpdate(GetVmClusterUpdateRequest request)
Database
Gets information about a specified maintenance update package for a VM cluster. Applies to Exadata Cloud@Customer instances only.
getVmClusterUpdate
in interface Database
request
- The request object containing the details to sendpublic GetVmClusterUpdateHistoryEntryResponse getVmClusterUpdateHistoryEntry(GetVmClusterUpdateHistoryEntryRequest request)
Database
Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud@Customer instances only.
getVmClusterUpdateHistoryEntry
in interface Database
request
- The request object containing the details to sendpublic LaunchAutonomousExadataInfrastructureResponse launchAutonomousExadataInfrastructure(LaunchAutonomousExadataInfrastructureRequest request)
Database
Deprecated To create a new Autonomous Database system on dedicated Exadata
Infrastructure, use the createCloudExadataInfrastructure
and createCloudAutonomousVmCluster
operations instead. Note that to create an Autonomous VM
cluster, you must have an existing Exadata Infrastructure resource to contain the VM cluster.
launchAutonomousExadataInfrastructure
in interface Database
request
- The request object containing the details to sendpublic LaunchDbSystemResponse launchDbSystem(LaunchDbSystemRequest request)
Database
Creates a new DB system in the specified compartment and availability domain. The Oracle Database edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed.
An initial database is created on the DB system based on the request parameters you provide and some default options. For detailed information about default options, see [Bare metal and virtual machine DB system default options.](https://docs.cloud.oracle.com/Content/Database/Tasks/creatingDBsystem.htm#Default)
*Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.
For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.
Use the createCloudExadataInfrastructure
and createCloudVmCluster
APIs to provision a
new Exadata Cloud Service instance.
launchDbSystem
in interface Database
request
- The request object containing the details to sendpublic ListApplicationVipsResponse listApplicationVips(ListApplicationVipsRequest request)
Database
Gets a list of application virtual IP (VIP) addresses on a cloud VM cluster.
listApplicationVips
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousContainerDatabaseDataguardAssociationsResponse listAutonomousContainerDatabaseDataguardAssociations(ListAutonomousContainerDatabaseDataguardAssociationsRequest request)
Database
Gets a list of the Autonomous Container Databases with Autonomous Data Guard-enabled associated with the specified Autonomous Container Database.
listAutonomousContainerDatabaseDataguardAssociations
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousContainerDatabaseVersionsResponse listAutonomousContainerDatabaseVersions(ListAutonomousContainerDatabaseVersionsRequest request)
Database
Gets a list of supported Autonomous Container Database versions.
listAutonomousContainerDatabaseVersions
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousContainerDatabasesResponse listAutonomousContainerDatabases(ListAutonomousContainerDatabasesRequest request)
Database
Gets a list of the Autonomous Container Databases in the specified compartment.
listAutonomousContainerDatabases
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousDatabaseBackupsResponse listAutonomousDatabaseBackups(ListAutonomousDatabaseBackupsRequest request)
Database
Gets a list of Autonomous Database backups based on either the autonomousDatabaseId
or
compartmentId
specified as a query parameter.
listAutonomousDatabaseBackups
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousDatabaseCharacterSetsResponse listAutonomousDatabaseCharacterSets(ListAutonomousDatabaseCharacterSetsRequest request)
Database
Gets a list of supported character sets.
listAutonomousDatabaseCharacterSets
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousDatabaseClonesResponse listAutonomousDatabaseClones(ListAutonomousDatabaseClonesRequest request)
Database
Lists the Autonomous Database clones for the specified Autonomous Database.
listAutonomousDatabaseClones
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousDatabaseDataguardAssociationsResponse listAutonomousDatabaseDataguardAssociations(ListAutonomousDatabaseDataguardAssociationsRequest request)
Database
Gets a list of the Autonomous Data Guard-enabled databases associated with the specified Autonomous Database.
listAutonomousDatabaseDataguardAssociations
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousDatabasePeersResponse listAutonomousDatabasePeers(ListAutonomousDatabasePeersRequest request)
Database
Lists the Autonomous Database peers for the specified Autonomous Database.
listAutonomousDatabasePeers
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousDatabaseRefreshableClonesResponse listAutonomousDatabaseRefreshableClones(ListAutonomousDatabaseRefreshableClonesRequest request)
Database
Lists the OCIDs of the Autonomous Database local and connected remote refreshable clones with the region where they exist for the specified source database.
listAutonomousDatabaseRefreshableClones
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousDatabaseSoftwareImagesResponse listAutonomousDatabaseSoftwareImages(ListAutonomousDatabaseSoftwareImagesRequest request)
Database
Gets a list of the Autonomous Database Software Images in the specified compartment.
listAutonomousDatabaseSoftwareImages
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousDatabasesResponse listAutonomousDatabases(ListAutonomousDatabasesRequest request)
Database
Gets a list of Autonomous Databases based on the query parameters specified.
listAutonomousDatabases
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousDbPreviewVersionsResponse listAutonomousDbPreviewVersions(ListAutonomousDbPreviewVersionsRequest request)
Database
Gets a list of supported Autonomous Database versions. Note that preview version software is only available for Autonomous Database Serverless (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) databases.
listAutonomousDbPreviewVersions
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousDbVersionsResponse listAutonomousDbVersions(ListAutonomousDbVersionsRequest request)
Database
Gets a list of supported Autonomous Database versions.
listAutonomousDbVersions
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousExadataInfrastructureShapesResponse listAutonomousExadataInfrastructureShapes(ListAutonomousExadataInfrastructureShapesRequest request)
Database
Deprecated.
listAutonomousExadataInfrastructureShapes
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousExadataInfrastructuresResponse listAutonomousExadataInfrastructures(ListAutonomousExadataInfrastructuresRequest request)
Database
Deprecated. Use the listCloudExadataInfrastructures
operation to list Exadata Infrastructures in the Oracle
cloud and the listCloudAutonomousVmClusters
operation to list Autonomous Exadata VM clusters.
listAutonomousExadataInfrastructures
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousVirtualMachinesResponse listAutonomousVirtualMachines(ListAutonomousVirtualMachinesRequest request)
Database
Lists the Autonomous Virtual Machines in the specified Autonomous VM Cluster and Compartment.
listAutonomousVirtualMachines
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousVmClusterAcdResourceUsageResponse listAutonomousVmClusterAcdResourceUsage(ListAutonomousVmClusterAcdResourceUsageRequest request)
Database
Gets the list of resource usage details for all the Autonomous Container Database in the specified Autonomous Exadata VM cluster.
listAutonomousVmClusterAcdResourceUsage
in interface Database
request
- The request object containing the details to sendpublic ListAutonomousVmClustersResponse listAutonomousVmClusters(ListAutonomousVmClustersRequest request)
Database
Gets a list of Exadata Cloud@Customer Autonomous VM clusters in the specified compartment. To
list Autonomous VM Clusters in the Oracle Cloud, see listCloudAutonomousVmClusters
.
listAutonomousVmClusters
in interface Database
request
- The request object containing the details to sendpublic ListBackupDestinationResponse listBackupDestination(ListBackupDestinationRequest request)
Database
Gets a list of backup destinations in the specified compartment.
listBackupDestination
in interface Database
request
- The request object containing the details to sendpublic ListBackupsResponse listBackups(ListBackupsRequest request)
Database
Gets a list of backups based on the databaseId
or compartmentId
specified. Either one of
these query parameters must be provided.
listBackups
in interface Database
request
- The request object containing the details to sendpublic ListCloudAutonomousVmClusterAcdResourceUsageResponse listCloudAutonomousVmClusterAcdResourceUsage(ListCloudAutonomousVmClusterAcdResourceUsageRequest request)
Database
Gets the list of resource usage details for all the Cloud Autonomous Container Database in the specified Cloud Autonomous Exadata VM cluster.
listCloudAutonomousVmClusterAcdResourceUsage
in interface Database
request
- The request object containing the details to sendpublic ListCloudAutonomousVmClustersResponse listCloudAutonomousVmClusters(ListCloudAutonomousVmClustersRequest request)
Database
Lists Autonomous Exadata VM clusters in the Oracle cloud. For Exadata Cloud@Customer systems,
see listAutonomousVmClusters
.
listCloudAutonomousVmClusters
in interface Database
request
- The request object containing the details to sendpublic ListCloudExadataInfrastructuresResponse listCloudExadataInfrastructures(ListCloudExadataInfrastructuresRequest request)
Database
Gets a list of the cloud Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
listCloudExadataInfrastructures
in interface Database
request
- The request object containing the details to sendpublic ListCloudVmClusterUpdateHistoryEntriesResponse listCloudVmClusterUpdateHistoryEntries(ListCloudVmClusterUpdateHistoryEntriesRequest request)
Database
Gets the history of the maintenance update actions performed on the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.
listCloudVmClusterUpdateHistoryEntries
in interface Database
request
- The request object containing the details to sendpublic ListCloudVmClusterUpdatesResponse listCloudVmClusterUpdates(ListCloudVmClusterUpdatesRequest request)
Database
Lists the maintenance updates that can be applied to the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.
listCloudVmClusterUpdates
in interface Database
request
- The request object containing the details to sendpublic ListCloudVmClustersResponse listCloudVmClusters(ListCloudVmClustersRequest request)
Database
Gets a list of the cloud VM clusters in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.
listCloudVmClusters
in interface Database
request
- The request object containing the details to sendpublic ListConsoleConnectionsResponse listConsoleConnections(ListConsoleConnectionsRequest request)
Database
Lists the console connections for the specified database node.
listConsoleConnections
in interface Database
request
- The request object containing the details to sendpublic ListConsoleHistoriesResponse listConsoleHistories(ListConsoleHistoriesRequest request)
Database
Lists the console histories for the specified database node.
listConsoleHistories
in interface Database
request
- The request object containing the details to sendpublic ListContainerDatabasePatchesResponse listContainerDatabasePatches(ListContainerDatabasePatchesRequest request)
Database
Lists the patches applicable to the requested container database.
listContainerDatabasePatches
in interface Database
request
- The request object containing the details to sendpublic ListDataGuardAssociationsResponse listDataGuardAssociations(ListDataGuardAssociationsRequest request)
Database
Lists all Data Guard associations for the specified database.
listDataGuardAssociations
in interface Database
request
- The request object containing the details to sendpublic ListDatabaseSoftwareImagesResponse listDatabaseSoftwareImages(ListDatabaseSoftwareImagesRequest request)
Database
Gets a list of the database software images in the specified compartment.
listDatabaseSoftwareImages
in interface Database
request
- The request object containing the details to sendpublic ListDatabaseUpgradeHistoryEntriesResponse listDatabaseUpgradeHistoryEntries(ListDatabaseUpgradeHistoryEntriesRequest request)
Database
Gets the upgrade history for a specified database in a bare metal or virtual machine DB system.
listDatabaseUpgradeHistoryEntries
in interface Database
request
- The request object containing the details to sendpublic ListDatabasesResponse listDatabases(ListDatabasesRequest request)
Database
Gets a list of the databases in the specified Database Home.
listDatabases
in interface Database
request
- The request object containing the details to sendpublic ListDbHomePatchHistoryEntriesResponse listDbHomePatchHistoryEntries(ListDbHomePatchHistoryEntriesRequest request)
Database
Lists the history of patch operations on the specified Database Home.
listDbHomePatchHistoryEntries
in interface Database
request
- The request object containing the details to sendpublic ListDbHomePatchesResponse listDbHomePatches(ListDbHomePatchesRequest request)
Database
Lists patches applicable to the requested Database Home.
listDbHomePatches
in interface Database
request
- The request object containing the details to sendpublic ListDbHomesResponse listDbHomes(ListDbHomesRequest request)
Database
Lists the Database Homes in the specified DB system and compartment. A Database Home is a directory where Oracle Database software is installed.
listDbHomes
in interface Database
request
- The request object containing the details to sendpublic ListDbNodesResponse listDbNodes(ListDbNodesRequest request)
Database
Lists the database nodes in the specified DB system and compartment. A database node is a server running database software.
listDbNodes
in interface Database
request
- The request object containing the details to sendpublic ListDbServersResponse listDbServers(ListDbServersRequest request)
Database
Lists the Exadata DB servers in the ExadataInfrastructureId and specified compartment.
listDbServers
in interface Database
request
- The request object containing the details to sendpublic ListDbSystemComputePerformancesResponse listDbSystemComputePerformances(ListDbSystemComputePerformancesRequest request)
Database
Gets a list of expected compute performance parameters for a virtual machine DB system based on system configuration.
listDbSystemComputePerformances
in interface Database
request
- The request object containing the details to sendpublic ListDbSystemPatchHistoryEntriesResponse listDbSystemPatchHistoryEntries(ListDbSystemPatchHistoryEntriesRequest request)
Database
Gets the history of the patch actions performed on the specified DB system.
listDbSystemPatchHistoryEntries
in interface Database
request
- The request object containing the details to sendpublic ListDbSystemPatchesResponse listDbSystemPatches(ListDbSystemPatchesRequest request)
Database
Lists the patches applicable to the specified DB system.
listDbSystemPatches
in interface Database
request
- The request object containing the details to sendpublic ListDbSystemShapesResponse listDbSystemShapes(ListDbSystemShapesRequest request)
Database
Gets a list of the shapes that can be used to launch a new DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.
listDbSystemShapes
in interface Database
request
- The request object containing the details to sendpublic ListDbSystemStoragePerformancesResponse listDbSystemStoragePerformances(ListDbSystemStoragePerformancesRequest request)
Database
Gets a list of possible expected storage performance parameters of a VMDB System based on Configuration.
listDbSystemStoragePerformances
in interface Database
request
- The request object containing the details to sendpublic ListDbSystemUpgradeHistoryEntriesResponse listDbSystemUpgradeHistoryEntries(ListDbSystemUpgradeHistoryEntriesRequest request)
Database
Gets the history of the upgrade actions performed on the specified DB system.
listDbSystemUpgradeHistoryEntries
in interface Database
request
- The request object containing the details to sendpublic ListDbSystemsResponse listDbSystems(ListDbSystemsRequest request)
Database
Lists the DB systems in the specified compartment. You can specify a backupId
to list only
the DB systems that support creating a database using this backup in this compartment.
*Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.
For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.
listDbSystems
in interface Database
request
- The request object containing the details to sendpublic ListDbVersionsResponse listDbVersions(ListDbVersionsRequest request)
Database
Gets a list of supported Oracle Database versions.
listDbVersions
in interface Database
request
- The request object containing the details to sendpublic ListExadataInfrastructuresResponse listExadataInfrastructures(ListExadataInfrastructuresRequest request)
Database
Lists the Exadata infrastructure resources in the specified compartment. Applies to Exadata
Cloud@Customer instances only. To list the Exadata Cloud Service infrastructure resources in
a compartment, use the listCloudExadataInfrastructures
operation.
listExadataInfrastructures
in interface Database
request
- The request object containing the details to sendpublic ListExadbVmClusterUpdateHistoryEntriesResponse listExadbVmClusterUpdateHistoryEntries(ListExadbVmClusterUpdateHistoryEntriesRequest request)
Database
Gets the history of the maintenance update actions performed on the specified Exadata VM cluster on Exascale Infrastructure.
listExadbVmClusterUpdateHistoryEntries
in interface Database
request
- The request object containing the details to sendpublic ListExadbVmClusterUpdatesResponse listExadbVmClusterUpdates(ListExadbVmClusterUpdatesRequest request)
Database
Lists the maintenance updates that can be applied to the specified Exadata VM cluster on Exascale Infrastructure.
listExadbVmClusterUpdates
in interface Database
request
- The request object containing the details to sendpublic ListExadbVmClustersResponse listExadbVmClusters(ListExadbVmClustersRequest request)
Database
Gets a list of the Exadata VM clusters on Exascale Infrastructure in the specified compartment. Applies to Exadata Database Service on Exascale Infrastructure only.
listExadbVmClusters
in interface Database
request
- The request object containing the details to sendpublic ListExascaleDbStorageVaultsResponse listExascaleDbStorageVaults(ListExascaleDbStorageVaultsRequest request)
Database
Gets a list of the Exadata Database Storage Vaults in the specified compartment.
listExascaleDbStorageVaults
in interface Database
request
- The request object containing the details to sendpublic ListExecutionActionsResponse listExecutionActions(ListExecutionActionsRequest request)
Database
Lists the execution action resources in the specified compartment.
listExecutionActions
in interface Database
request
- The request object containing the details to sendpublic ListExecutionWindowsResponse listExecutionWindows(ListExecutionWindowsRequest request)
Database
Lists the execution window resources in the specified compartment.
listExecutionWindows
in interface Database
request
- The request object containing the details to sendpublic ListExternalContainerDatabasesResponse listExternalContainerDatabases(ListExternalContainerDatabasesRequest request)
Database
Gets a list of the external container databases in the specified compartment.
listExternalContainerDatabases
in interface Database
request
- The request object containing the details to sendpublic ListExternalDatabaseConnectorsResponse listExternalDatabaseConnectors(ListExternalDatabaseConnectorsRequest request)
Database
Gets a list of the external database connectors in the specified compartment.
listExternalDatabaseConnectors
in interface Database
request
- The request object containing the details to sendpublic ListExternalNonContainerDatabasesResponse listExternalNonContainerDatabases(ListExternalNonContainerDatabasesRequest request)
Database
Gets a list of the ExternalNonContainerDatabases in the specified compartment.
listExternalNonContainerDatabases
in interface Database
request
- The request object containing the details to sendpublic ListExternalPluggableDatabasesResponse listExternalPluggableDatabases(ListExternalPluggableDatabasesRequest request)
Database
Gets a list of the createExternalPluggableDatabaseDetails
resources in the specified compartment.
listExternalPluggableDatabases
in interface Database
request
- The request object containing the details to sendpublic ListFlexComponentsResponse listFlexComponents(ListFlexComponentsRequest request)
Database
Gets a list of the flex components that can be used to launch a new DB system. The flex component determines resources to allocate to the DB system - Database Servers and Storage Servers.
listFlexComponents
in interface Database
request
- The request object containing the details to sendpublic ListGiVersionMinorVersionsResponse listGiVersionMinorVersions(ListGiVersionMinorVersionsRequest request)
Database
Gets a list of supported Oracle Grid Infrastructure minor versions for the given major version and shape family.
listGiVersionMinorVersions
in interface Database
request
- The request object containing the details to sendpublic ListGiVersionsResponse listGiVersions(ListGiVersionsRequest request)
Database
Gets a list of supported GI versions.
listGiVersions
in interface Database
request
- The request object containing the details to sendpublic ListKeyStoresResponse listKeyStores(ListKeyStoresRequest request)
Database
Gets a list of key stores in the specified compartment.
listKeyStores
in interface Database
request
- The request object containing the details to sendpublic ListMaintenanceRunHistoryResponse listMaintenanceRunHistory(ListMaintenanceRunHistoryRequest request)
Database
Gets a list of the maintenance run histories in the specified compartment.
listMaintenanceRunHistory
in interface Database
request
- The request object containing the details to sendpublic ListMaintenanceRunsResponse listMaintenanceRuns(ListMaintenanceRunsRequest request)
Database
Gets a list of the maintenance runs in the specified compartment.
listMaintenanceRuns
in interface Database
request
- The request object containing the details to sendpublic ListOneoffPatchesResponse listOneoffPatches(ListOneoffPatchesRequest request)
Database
Lists one-off patches in the specified compartment.
listOneoffPatches
in interface Database
request
- The request object containing the details to sendpublic ListParamsForActionTypeResponse listParamsForActionType(ListParamsForActionTypeRequest request)
Database
List all the action params and their possible values for a given action type
listParamsForActionType
in interface Database
request
- The request object containing the details to sendpublic ListPdbConversionHistoryEntriesResponse listPdbConversionHistoryEntries(ListPdbConversionHistoryEntriesRequest request)
Database
Gets the pluggable database conversion history for a specified database in a bare metal or virtual machine DB system.
listPdbConversionHistoryEntries
in interface Database
request
- The request object containing the details to sendpublic ListPluggableDatabasesResponse listPluggableDatabases(ListPluggableDatabasesRequest request)
Database
Gets a list of the pluggable databases in a database or compartment. You must provide either
a databaseId
or compartmentId
value.
listPluggableDatabases
in interface Database
request
- The request object containing the details to sendpublic ListRecommendedScheduledActionsResponse listRecommendedScheduledActions(ListRecommendedScheduledActionsRequest request)
Database
Returns a recommended Scheduled Actions configuration for a given resource, plan intent and scheduling policy.
listRecommendedScheduledActions
in interface Database
request
- The request object containing the details to sendpublic ListScheduledActionsResponse listScheduledActions(ListScheduledActionsRequest request)
Database
Lists the Scheduled Action resources in the specified compartment.
listScheduledActions
in interface Database
request
- The request object containing the details to sendpublic ListSchedulingPlansResponse listSchedulingPlans(ListSchedulingPlansRequest request)
Database
Lists the Scheduling Plan resources in the specified compartment.
listSchedulingPlans
in interface Database
request
- The request object containing the details to sendpublic ListSchedulingPoliciesResponse listSchedulingPolicies(ListSchedulingPoliciesRequest request)
Database
Lists the Scheduling Policy resources in the specified compartment.
listSchedulingPolicies
in interface Database
request
- The request object containing the details to sendpublic ListSchedulingWindowsResponse listSchedulingWindows(ListSchedulingWindowsRequest request)
Database
Lists the Scheduling Window resources in the specified compartment.
listSchedulingWindows
in interface Database
request
- The request object containing the details to sendpublic ListSystemVersionsResponse listSystemVersions(ListSystemVersionsRequest request)
Database
Gets a list of supported Exadata system versions for a given shape and GI version.
listSystemVersions
in interface Database
request
- The request object containing the details to sendpublic ListVmClusterNetworksResponse listVmClusterNetworks(ListVmClusterNetworksRequest request)
Database
Gets a list of the VM cluster networks in the specified compartment. Applies to Exadata Cloud@Customer instances only.
listVmClusterNetworks
in interface Database
request
- The request object containing the details to sendpublic ListVmClusterPatchHistoryEntriesResponse listVmClusterPatchHistoryEntries(ListVmClusterPatchHistoryEntriesRequest request)
Database
Gets the history of the patch actions performed on the specified VM cluster in an Exadata Cloud@Customer system.
listVmClusterPatchHistoryEntries
in interface Database
request
- The request object containing the details to sendpublic ListVmClusterPatchesResponse listVmClusterPatches(ListVmClusterPatchesRequest request)
Database
Lists the patches applicable to the specified VM cluster in an Exadata Cloud@Customer system.
listVmClusterPatches
in interface Database
request
- The request object containing the details to sendpublic ListVmClusterUpdateHistoryEntriesResponse listVmClusterUpdateHistoryEntries(ListVmClusterUpdateHistoryEntriesRequest request)
Database
Gets the history of the maintenance update actions performed on the specified VM cluster. Applies to Exadata Cloud@Customer instances only.
listVmClusterUpdateHistoryEntries
in interface Database
request
- The request object containing the details to sendpublic ListVmClusterUpdatesResponse listVmClusterUpdates(ListVmClusterUpdatesRequest request)
Database
Lists the maintenance updates that can be applied to the specified VM cluster. Applies to Exadata Cloud@Customer instances only.
listVmClusterUpdates
in interface Database
request
- The request object containing the details to sendpublic ListVmClustersResponse listVmClusters(ListVmClustersRequest request)
Database
Lists the VM clusters in the specified compartment. Applies to Exadata Cloud@Customer
instances only. To list the cloud VM clusters in an Exadata Cloud Service instance, use the
listCloudVmClusters
operation.
listVmClusters
in interface Database
request
- The request object containing the details to sendpublic LocalClonePluggableDatabaseResponse localClonePluggableDatabase(LocalClonePluggableDatabaseRequest request)
Database
Deprecated. Use createPluggableDatabase
for Pluggable Database LocalClone Operation. Clones and starts a
pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be
in the READ_WRITE
openMode to perform the clone operation.
localClonePluggableDatabase
in interface Database
request
- The request object containing the details to sendpublic MigrateExadataDbSystemResourceModelResponse migrateExadataDbSystemResourceModel(MigrateExadataDbSystemResourceModelRequest request)
Database
Migrates the Exadata DB system to the new Exadata resource model. All related resources will be migrated.
migrateExadataDbSystemResourceModel
in interface Database
request
- The request object containing the details to sendpublic MigrateVaultKeyResponse migrateVaultKey(MigrateVaultKeyRequest request)
Database
Changes encryption key management from customer-managed, using the Vault service, to Oracle-managed.
migrateVaultKey
in interface Database
request
- The request object containing the details to sendpublic ModifyDatabaseManagementResponse modifyDatabaseManagement(ModifyDatabaseManagementRequest request)
Database
Updates one or more attributes of the Database Management service for the database.
modifyDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic ModifyPluggableDatabaseManagementResponse modifyPluggableDatabaseManagement(ModifyPluggableDatabaseManagementRequest request)
Database
Updates one or more attributes of the Database Management service for the pluggable database.
modifyPluggableDatabaseManagement
in interface Database
request
- The request object containing the details to sendpublic MoveExecutionActionMemberResponse moveExecutionActionMember(MoveExecutionActionMemberRequest request)
Database
Moves an execution action member to this execution action resource from another.
moveExecutionActionMember
in interface Database
request
- The request object containing the details to sendpublic RefreshPluggableDatabaseResponse refreshPluggableDatabase(RefreshPluggableDatabaseRequest request)
Database
Refreshes a pluggable database (PDB) Refreshable clone.
refreshPluggableDatabase
in interface Database
request
- The request object containing the details to sendpublic RegisterAutonomousDatabaseDataSafeResponse registerAutonomousDatabaseDataSafe(RegisterAutonomousDatabaseDataSafeRequest request)
Database
Asynchronously registers this Autonomous Database with Data Safe.
registerAutonomousDatabaseDataSafe
in interface Database
request
- The request object containing the details to sendpublic ReinstateAutonomousContainerDatabaseDataguardAssociationResponse reinstateAutonomousContainerDatabaseDataguardAssociation(ReinstateAutonomousContainerDatabaseDataguardAssociationRequest request)
Database
Reinstates a disabled standby Autonomous Container Database, identified by the autonomousContainerDatabaseId parameter, to an active standby Autonomous Container Database.
reinstateAutonomousContainerDatabaseDataguardAssociation
in interface Database
request
- The request object containing the details to sendpublic ReinstateDataGuardAssociationResponse reinstateDataGuardAssociation(ReinstateDataGuardAssociationRequest request)
Database
Reinstates the database identified by the databaseId
parameter into the standby role in a
Data Guard association.
reinstateDataGuardAssociation
in interface Database
request
- The request object containing the details to sendpublic RemoteClonePluggableDatabaseResponse remoteClonePluggableDatabase(RemoteClonePluggableDatabaseRequest request)
Database
Deprecated. Use createPluggableDatabase
for Pluggable Database RemoteClone Operation. Clones a pluggable
database (PDB) to a different database from the source PDB. The cloned PDB will be started
upon completion of the clone operation. The source PDB must be in the READ_WRITE
openMode
when performing the clone. For Exadata Cloud@Customer instances, the source pluggable
database (PDB) must be on the same Exadata Infrastructure as the target container database
(CDB) to create a remote clone.
remoteClonePluggableDatabase
in interface Database
request
- The request object containing the details to sendpublic RemoveVirtualMachineFromCloudVmClusterResponse removeVirtualMachineFromCloudVmCluster(RemoveVirtualMachineFromCloudVmClusterRequest request)
Database
Remove Virtual Machines from the Cloud VM cluster. Applies to Exadata Cloud instances only.
removeVirtualMachineFromCloudVmCluster
in interface Database
request
- The request object containing the details to sendpublic RemoveVirtualMachineFromExadbVmClusterResponse removeVirtualMachineFromExadbVmCluster(RemoveVirtualMachineFromExadbVmClusterRequest request)
Database
Remove Virtual Machines from the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Cloud instances only.
removeVirtualMachineFromExadbVmCluster
in interface Database
request
- The request object containing the details to sendpublic RemoveVirtualMachineFromVmClusterResponse removeVirtualMachineFromVmCluster(RemoveVirtualMachineFromVmClusterRequest request)
Database
Remove Virtual Machines from the VM cluster. Applies to Exadata Cloud@Customer instances only.
removeVirtualMachineFromVmCluster
in interface Database
request
- The request object containing the details to sendpublic ReorderExecutionActionsResponse reorderExecutionActions(ReorderExecutionActionsRequest request)
Database
Reorders the execution actions under this execution window resource.
reorderExecutionActions
in interface Database
request
- The request object containing the details to sendpublic ReorderScheduledActionsResponse reorderScheduledActions(ReorderScheduledActionsRequest request)
Database
Re-order the scheduled actions under this scheduling plan resource.
reorderScheduledActions
in interface Database
request
- The request object containing the details to sendpublic ResizeVmClusterNetworkResponse resizeVmClusterNetwork(ResizeVmClusterNetworkRequest request)
Database
Adds or removes Db server network nodes to extend or shrink the existing VM cluster network. Applies to Exadata Cloud@Customer instances only.
resizeVmClusterNetwork
in interface Database
request
- The request object containing the details to sendpublic ResourcePoolShapesResponse resourcePoolShapes(ResourcePoolShapesRequest request)
Database
Lists available resource pools shapes.
resourcePoolShapes
in interface Database
request
- The request object containing the details to sendpublic RestartAutonomousContainerDatabaseResponse restartAutonomousContainerDatabase(RestartAutonomousContainerDatabaseRequest request)
Database
Rolling restarts the specified Autonomous Container Database.
restartAutonomousContainerDatabase
in interface Database
request
- The request object containing the details to sendpublic RestartAutonomousDatabaseResponse restartAutonomousDatabase(RestartAutonomousDatabaseRequest request)
Database
Restarts the specified Autonomous Database.
restartAutonomousDatabase
in interface Database
request
- The request object containing the details to sendpublic RestoreAutonomousDatabaseResponse restoreAutonomousDatabase(RestoreAutonomousDatabaseRequest request)
Database
Restores an Autonomous Database based on the provided request parameters.
restoreAutonomousDatabase
in interface Database
request
- The request object containing the details to sendpublic RestoreDatabaseResponse restoreDatabase(RestoreDatabaseRequest request)
Database
Restore a Database based on the request parameters you provide.
restoreDatabase
in interface Database
request
- The request object containing the details to sendpublic RotateAutonomousContainerDatabaseEncryptionKeyResponse rotateAutonomousContainerDatabaseEncryptionKey(RotateAutonomousContainerDatabaseEncryptionKeyRequest request)
Database
Creates a new version of an existing Vault service key.
rotateAutonomousContainerDatabaseEncryptionKey
in interface Database
request
- The request object containing the details to sendpublic RotateAutonomousDatabaseEncryptionKeyResponse rotateAutonomousDatabaseEncryptionKey(RotateAutonomousDatabaseEncryptionKeyRequest request)
Database
Rotate existing AutonomousDatabase Vault service key.
rotateAutonomousDatabaseEncryptionKey
in interface Database
request
- The request object containing the details to sendpublic RotateAutonomousVmClusterOrdsCertsResponse rotateAutonomousVmClusterOrdsCerts(RotateAutonomousVmClusterOrdsCertsRequest request)
Database
Rotates the Oracle REST Data Services (ORDS) certificates for Autonomous Exadata VM cluster.
rotateAutonomousVmClusterOrdsCerts
in interface Database
request
- The request object containing the details to sendpublic RotateAutonomousVmClusterSslCertsResponse rotateAutonomousVmClusterSslCerts(RotateAutonomousVmClusterSslCertsRequest request)
Database
Rotates the SSL certificates for Autonomous Exadata VM cluster.
rotateAutonomousVmClusterSslCerts
in interface Database
request
- The request object containing the details to sendpublic RotateCloudAutonomousVmClusterOrdsCertsResponse rotateCloudAutonomousVmClusterOrdsCerts(RotateCloudAutonomousVmClusterOrdsCertsRequest request)
Database
Rotates the Oracle REST Data Services (ORDS) certificates for a cloud Autonomous Exadata VM cluster.
rotateCloudAutonomousVmClusterOrdsCerts
in interface Database
request
- The request object containing the details to sendpublic RotateCloudAutonomousVmClusterSslCertsResponse rotateCloudAutonomousVmClusterSslCerts(RotateCloudAutonomousVmClusterSslCertsRequest request)
Database
Rotates the SSL certficates for a cloud Autonomous Exadata VM cluster.
rotateCloudAutonomousVmClusterSslCerts
in interface Database
request
- The request object containing the details to sendpublic RotateOrdsCertsResponse rotateOrdsCerts(RotateOrdsCertsRequest request)
Database
Deprecated. Use the rotateCloudAutonomousVmClusterOrdsCerts
to rotate Oracle REST Data Services (ORDS) certs for
an Autonomous Exadata VM cluster instead.
rotateOrdsCerts
in interface Database
request
- The request object containing the details to sendpublic RotatePluggableDatabaseEncryptionKeyResponse rotatePluggableDatabaseEncryptionKey(RotatePluggableDatabaseEncryptionKeyRequest request)
Database
Create a new version of the existing encryption key.
rotatePluggableDatabaseEncryptionKey
in interface Database
request
- The request object containing the details to sendpublic RotateSslCertsResponse rotateSslCerts(RotateSslCertsRequest request)
Database
Deprecated. Use the rotateCloudAutonomousVmClusterSslCerts
to rotate SSL certs for an Autonomous Exadata VM
cluster instead.
rotateSslCerts
in interface Database
request
- The request object containing the details to sendpublic RotateVaultKeyResponse rotateVaultKey(RotateVaultKeyRequest request)
Database
Creates a new version of an existing Vault service key.
rotateVaultKey
in interface Database
request
- The request object containing the details to sendpublic SaasAdminUserStatusResponse saasAdminUserStatus(SaasAdminUserStatusRequest request)
Database
This operation gets SaaS administrative user status of the Autonomous Database.
saasAdminUserStatus
in interface Database
request
- The request object containing the details to sendpublic ScanExternalContainerDatabasePluggableDatabasesResponse scanExternalContainerDatabasePluggableDatabases(ScanExternalContainerDatabasePluggableDatabasesRequest request)
Database
Scans for pluggable databases in the specified external container database. This operation
will return un-registered pluggable databases in the getWorkRequest
operation.
scanExternalContainerDatabasePluggableDatabases
in interface Database
request
- The request object containing the details to sendpublic SetDbKeyVersionResponse setDbKeyVersion(SetDbKeyVersionRequest request)
Database
Sets a new version of an existing Vault service key.
setDbKeyVersion
in interface Database
request
- The request object containing the details to sendpublic SetPdbKeyVersionResponse setPdbKeyVersion(SetPdbKeyVersionRequest request)
Database
Sets a new version of an existing Vault service key.
setPdbKeyVersion
in interface Database
request
- The request object containing the details to sendpublic ShrinkAutonomousDatabaseResponse shrinkAutonomousDatabase(ShrinkAutonomousDatabaseRequest request)
Database
This operation shrinks the current allocated storage down to the current actual used data storage (actualUsedDataStorageSizeInTBs). The if the base storage value for the database (dataStorageSizeInTBs) is larger than the actualUsedDataStorageSizeInTBs value, you are billed for the base storage value.
shrinkAutonomousDatabase
in interface Database
request
- The request object containing the details to sendpublic StartAutonomousDatabaseResponse startAutonomousDatabase(StartAutonomousDatabaseRequest request)
Database
Starts the specified Autonomous Database.
startAutonomousDatabase
in interface Database
request
- The request object containing the details to sendpublic StartPluggableDatabaseResponse startPluggableDatabase(StartPluggableDatabaseRequest request)
Database
Starts a stopped pluggable database. The openMode
value of the pluggable database will be
READ_WRITE
upon completion.
startPluggableDatabase
in interface Database
request
- The request object containing the details to sendpublic StopAutonomousDatabaseResponse stopAutonomousDatabase(StopAutonomousDatabaseRequest request)
Database
Stops the specified Autonomous Database.
stopAutonomousDatabase
in interface Database
request
- The request object containing the details to sendpublic StopPluggableDatabaseResponse stopPluggableDatabase(StopPluggableDatabaseRequest request)
Database
Stops a pluggable database. The openMode
value of the pluggable database will be MOUNTED
upon completion.
stopPluggableDatabase
in interface Database
request
- The request object containing the details to sendpublic SwitchoverAutonomousContainerDatabaseDataguardAssociationResponse switchoverAutonomousContainerDatabaseDataguardAssociation(SwitchoverAutonomousContainerDatabaseDataguardAssociationRequest request)
Database
Switches over the primary Autonomous Container Database of an Autonomous Data Guard peer association to standby role. The standby Autonomous Container Database associated with autonomousContainerDatabaseDataguardAssociationId assumes the primary Autonomous Container Database role.
A switchover incurs no data loss.
switchoverAutonomousContainerDatabaseDataguardAssociation
in interface Database
request
- The request object containing the details to sendpublic SwitchoverAutonomousDatabaseResponse switchoverAutonomousDatabase(SwitchoverAutonomousDatabaseRequest request)
Database
Initiates a switchover 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 switchover will happen in the same region.
switchoverAutonomousDatabase
in interface Database
request
- The request object containing the details to sendpublic SwitchoverDataGuardAssociationResponse switchoverDataGuardAssociation(SwitchoverDataGuard