@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public interface Database extends AutoCloseable
The API for the Database Service. Use this API to manage resources such as databases and DB Systems. For more information, see Overview of the Database Service.
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
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.
region
- The region of the service.void setRegion(String regionId)
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
.
regionId
- The public region ID.ActivateExadataInfrastructureResponse activateExadataInfrastructure(ActivateExadataInfrastructureRequest request)
Activates the specified Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ActivateExadataInfrastructure API.
AutonomousDatabaseManualRefreshResponse autonomousDatabaseManualRefresh(AutonomousDatabaseManualRefreshRequest request)
Initiates a data refresh for an Autonomous Database refreshable clone. Data is refreshed from the source database to the point of a specified timestamp.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use AutonomousDatabaseManualRefresh API.
ChangeAutonomousContainerDatabaseCompartmentResponse changeAutonomousContainerDatabaseCompartment(ChangeAutonomousContainerDatabaseCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeAutonomousContainerDatabaseCompartment API.
ChangeAutonomousDatabaseCompartmentResponse changeAutonomousDatabaseCompartment(ChangeAutonomousDatabaseCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeAutonomousDatabaseCompartment API.
ChangeAutonomousExadataInfrastructureCompartmentResponse changeAutonomousExadataInfrastructureCompartment(ChangeAutonomousExadataInfrastructureCompartmentRequest request)
Moves the Autonomous Exadata Infrastructure resource and its dependent resources to the specified compartment. For more information, see Moving Database Resources to a Different Compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeAutonomousExadataInfrastructureCompartment API.
ChangeAutonomousVmClusterCompartmentResponse changeAutonomousVmClusterCompartment(ChangeAutonomousVmClusterCompartmentRequest request)
To move an Autonomous VM cluster and its dependent resources to another compartment, use the
changeAutonomousVmClusterCompartment
operation.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeAutonomousVmClusterCompartment API.
ChangeBackupDestinationCompartmentResponse changeBackupDestinationCompartment(ChangeBackupDestinationCompartmentRequest request)
Move the backup destination and its dependent resources to the specified compartment. For more information, see Moving Database Resources to a Different Compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeBackupDestinationCompartment API.
ChangeCloudExadataInfrastructureCompartmentResponse changeCloudExadataInfrastructureCompartment(ChangeCloudExadataInfrastructureCompartmentRequest request)
Moves a cloud Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud Service instances only. For more information about moving resources to a different compartment, see Moving Database Resources to a Different Compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeCloudExadataInfrastructureCompartment API.
ChangeCloudVmClusterCompartmentResponse changeCloudVmClusterCompartment(ChangeCloudVmClusterCompartmentRequest request)
Moves a cloud VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud Service instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeCloudVmClusterCompartment API.
ChangeDatabaseSoftwareImageCompartmentResponse changeDatabaseSoftwareImageCompartment(ChangeDatabaseSoftwareImageCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeDatabaseSoftwareImageCompartment API.
ChangeDbSystemCompartmentResponse changeDbSystemCompartment(ChangeDbSystemCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeDbSystemCompartment API.
ChangeExadataInfrastructureCompartmentResponse changeExadataInfrastructureCompartment(ChangeExadataInfrastructureCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeExadataInfrastructureCompartment API.
ChangeExternalContainerDatabaseCompartmentResponse changeExternalContainerDatabaseCompartment(ChangeExternalContainerDatabaseCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeExternalContainerDatabaseCompartment API.
ChangeExternalNonContainerDatabaseCompartmentResponse changeExternalNonContainerDatabaseCompartment(ChangeExternalNonContainerDatabaseCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeExternalNonContainerDatabaseCompartment API.
ChangeExternalPluggableDatabaseCompartmentResponse changeExternalPluggableDatabaseCompartment(ChangeExternalPluggableDatabaseCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeExternalPluggableDatabaseCompartment API.
ChangeKeyStoreCompartmentResponse changeKeyStoreCompartment(ChangeKeyStoreCompartmentRequest request)
Move the key store resource to the specified compartment. For more information about moving key stores, see Moving Database Resources to a Different Compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeKeyStoreCompartment API.
ChangeVmClusterCompartmentResponse changeVmClusterCompartment(ChangeVmClusterCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ChangeVmClusterCompartment API.
CheckExternalDatabaseConnectorConnectionStatusResponse checkExternalDatabaseConnectorConnectionStatus(CheckExternalDatabaseConnectorConnectionStatusRequest request)
Check the status of the external database connection specified in this connector. This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CheckExternalDatabaseConnectorConnectionStatus API.
CompleteExternalBackupJobResponse completeExternalBackupJob(CompleteExternalBackupJobRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CompleteExternalBackupJob API.
CreateAutonomousContainerDatabaseResponse createAutonomousContainerDatabase(CreateAutonomousContainerDatabaseRequest request)
Creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateAutonomousContainerDatabase API.
CreateAutonomousDatabaseResponse createAutonomousDatabase(CreateAutonomousDatabaseRequest request)
Creates a new Autonomous Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateAutonomousDatabase API.
CreateAutonomousDatabaseBackupResponse createAutonomousDatabaseBackup(CreateAutonomousDatabaseBackupRequest request)
Creates a new Autonomous Database backup for the specified database based on the provided request parameters.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateAutonomousDatabaseBackup API.
CreateAutonomousVmClusterResponse createAutonomousVmCluster(CreateAutonomousVmClusterRequest request)
Creates an Autonomous VM cluster for Exadata Cloud@Customer.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateAutonomousVmCluster API.
CreateBackupResponse createBackup(CreateBackupRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateBackup API.
CreateBackupDestinationResponse createBackupDestination(CreateBackupDestinationRequest request)
Creates a backup destination in an Exadata Cloud@Customer system.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateBackupDestination API.
CreateCloudExadataInfrastructureResponse createCloudExadataInfrastructure(CreateCloudExadataInfrastructureRequest request)
Creates a cloud Exadata infrastructure resource. This resource is used to create an Exadata Cloud Service instance.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateCloudExadataInfrastructure API.
CreateCloudVmClusterResponse createCloudVmCluster(CreateCloudVmClusterRequest request)
Creates a cloud VM cluster.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateCloudVmCluster API.
CreateConsoleConnectionResponse createConsoleConnection(CreateConsoleConnectionRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateConsoleConnection API.
CreateDataGuardAssociationResponse createDataGuardAssociation(CreateDataGuardAssociationRequest request)
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).
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateDataGuardAssociation API.
CreateDatabaseResponse createDatabase(CreateDatabaseRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateDatabase API.
CreateDatabaseSoftwareImageResponse createDatabaseSoftwareImage(CreateDatabaseSoftwareImageRequest request)
create database software image in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateDatabaseSoftwareImage API.
CreateDbHomeResponse createDbHome(CreateDbHomeRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateDbHome API.
CreateExadataInfrastructureResponse createExadataInfrastructure(CreateExadataInfrastructureRequest request)
Creates an Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only.
To create an Exadata Cloud Service infrastructure resource, use the createCloudExadataInfrastructure
operation.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateExadataInfrastructure API.
CreateExternalBackupJobResponse createExternalBackupJob(CreateExternalBackupJobRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateExternalBackupJob API.
CreateExternalContainerDatabaseResponse createExternalContainerDatabase(CreateExternalContainerDatabaseRequest request)
Creates a new external container database resource.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateExternalContainerDatabase API.
CreateExternalDatabaseConnectorResponse createExternalDatabaseConnector(CreateExternalDatabaseConnectorRequest request)
Creates a new external database connector.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateExternalDatabaseConnector API.
CreateExternalNonContainerDatabaseResponse createExternalNonContainerDatabase(CreateExternalNonContainerDatabaseRequest request)
Creates a new ExternalNonContainerDatabase resource
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateExternalNonContainerDatabase API.
CreateExternalPluggableDatabaseResponse createExternalPluggableDatabase(CreateExternalPluggableDatabaseRequest request)
Registers a new createExternalPluggableDatabaseDetails
resource.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateExternalPluggableDatabase API.
CreateKeyStoreResponse createKeyStore(CreateKeyStoreRequest request)
Creates a Key Store.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateKeyStore API.
CreateVmClusterResponse createVmCluster(CreateVmClusterRequest request)
Creates an Exadata Cloud@Customer VM cluster.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateVmCluster API.
CreateVmClusterNetworkResponse createVmClusterNetwork(CreateVmClusterNetworkRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use CreateVmClusterNetwork API.
DbNodeActionResponse dbNodeAction(DbNodeActionRequest request)
Performs one of the following power actions on the specified DB node:
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DbNodeAction API.
DeleteAutonomousDatabaseResponse deleteAutonomousDatabase(DeleteAutonomousDatabaseRequest request)
Deletes the specified Autonomous Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteAutonomousDatabase API.
DeleteAutonomousVmClusterResponse deleteAutonomousVmCluster(DeleteAutonomousVmClusterRequest request)
Deletes the specified Autonomous VM cluster in an Exadata Cloud@Customer system.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteAutonomousVmCluster API.
DeleteBackupResponse deleteBackup(DeleteBackupRequest request)
Deletes a full backup. You cannot delete automatic backups using this API.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteBackup API.
DeleteBackupDestinationResponse deleteBackupDestination(DeleteBackupDestinationRequest request)
Deletes a backup destination in an Exadata Cloud@Customer system.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteBackupDestination API.
DeleteCloudExadataInfrastructureResponse deleteCloudExadataInfrastructure(DeleteCloudExadataInfrastructureRequest request)
Deletes the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteCloudExadataInfrastructure API.
DeleteCloudVmClusterResponse deleteCloudVmCluster(DeleteCloudVmClusterRequest request)
Deletes the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteCloudVmCluster API.
DeleteConsoleConnectionResponse deleteConsoleConnection(DeleteConsoleConnectionRequest request)
Deletes the specified database node console connection.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteConsoleConnection API.
DeleteDatabaseResponse deleteDatabase(DeleteDatabaseRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteDatabase API.
DeleteDatabaseSoftwareImageResponse deleteDatabaseSoftwareImage(DeleteDatabaseSoftwareImageRequest request)
Delete a database software image
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteDatabaseSoftwareImage API.
DeleteDbHomeResponse deleteDbHome(DeleteDbHomeRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteDbHome API.
DeleteExadataInfrastructureResponse deleteExadataInfrastructure(DeleteExadataInfrastructureRequest request)
Deletes the Exadata Cloud@Customer infrastructure.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteExadataInfrastructure API.
DeleteExternalContainerDatabaseResponse deleteExternalContainerDatabase(DeleteExternalContainerDatabaseRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteExternalContainerDatabase API.
DeleteExternalDatabaseConnectorResponse deleteExternalDatabaseConnector(DeleteExternalDatabaseConnectorRequest request)
Deletes an external database connector. Any services enabled using the external database connector must be deleted prior to this operation.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteExternalDatabaseConnector API.
DeleteExternalNonContainerDatabaseResponse deleteExternalNonContainerDatabase(DeleteExternalNonContainerDatabaseRequest request)
Deletes the Oracle Cloud Infrastructure resource representing an external non-container database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteExternalNonContainerDatabase API.
DeleteExternalPluggableDatabaseResponse deleteExternalPluggableDatabase(DeleteExternalPluggableDatabaseRequest request)
Deletes the createExternalPluggableDatabaseDetails
.
resource.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteExternalPluggableDatabase API.
DeleteKeyStoreResponse deleteKeyStore(DeleteKeyStoreRequest request)
Deletes a key store.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteKeyStore API.
DeleteVmClusterResponse deleteVmCluster(DeleteVmClusterRequest request)
Deletes the specified VM cluster. Applies to Exadata Cloud@Customer instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteVmCluster API.
DeleteVmClusterNetworkResponse deleteVmClusterNetwork(DeleteVmClusterNetworkRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeleteVmClusterNetwork API.
DeregisterAutonomousDatabaseDataSafeResponse deregisterAutonomousDatabaseDataSafe(DeregisterAutonomousDatabaseDataSafeRequest request)
Asynchronously deregisters this Autonomous Database with Data Safe.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DeregisterAutonomousDatabaseDataSafe API.
DisableAutonomousDatabaseOperationsInsightsResponse disableAutonomousDatabaseOperationsInsights(DisableAutonomousDatabaseOperationsInsightsRequest request)
Disables Operations Insights for the Autonomous Database resource.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DisableAutonomousDatabaseOperationsInsights API.
DisableExternalContainerDatabaseDatabaseManagementResponse disableExternalContainerDatabaseDatabaseManagement(DisableExternalContainerDatabaseDatabaseManagementRequest request)
Disable Database Management service for the external container database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DisableExternalContainerDatabaseDatabaseManagement API.
DisableExternalNonContainerDatabaseDatabaseManagementResponse disableExternalNonContainerDatabaseDatabaseManagement(DisableExternalNonContainerDatabaseDatabaseManagementRequest request)
Disable Database Management Service for the external non-container database. For more information about the Database Management Service, see Database Management Service.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DisableExternalNonContainerDatabaseDatabaseManagement API.
DisableExternalPluggableDatabaseDatabaseManagementResponse disableExternalPluggableDatabaseDatabaseManagement(DisableExternalPluggableDatabaseDatabaseManagementRequest request)
Disable Database Management Service for the external pluggable database. For more information about the Database Management Service, see Database Management Service.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DisableExternalPluggableDatabaseDatabaseManagement API.
DownloadExadataInfrastructureConfigFileResponse downloadExadataInfrastructureConfigFile(DownloadExadataInfrastructureConfigFileRequest request)
Downloads the configuration file for the specified Exadata Cloud@Customer infrastructure.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DownloadExadataInfrastructureConfigFile API.
DownloadVmClusterNetworkConfigFileResponse downloadVmClusterNetworkConfigFile(DownloadVmClusterNetworkConfigFileRequest request)
Downloads the configuration file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use DownloadVmClusterNetworkConfigFile API.
EnableAutonomousDatabaseOperationsInsightsResponse enableAutonomousDatabaseOperationsInsights(EnableAutonomousDatabaseOperationsInsightsRequest request)
Enables the specified Autonomous Database with Operations Insights.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use EnableAutonomousDatabaseOperationsInsights API.
EnableExternalContainerDatabaseDatabaseManagementResponse enableExternalContainerDatabaseDatabaseManagement(EnableExternalContainerDatabaseDatabaseManagementRequest request)
Enables Database Management Service for the external container database. For more information about the Database Management Service, see Database Management Service.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use EnableExternalContainerDatabaseDatabaseManagement API.
EnableExternalNonContainerDatabaseDatabaseManagementResponse enableExternalNonContainerDatabaseDatabaseManagement(EnableExternalNonContainerDatabaseDatabaseManagementRequest request)
Enable Database Management Service for the external non-container database. For more information about the Database Management Service, see Database Management Service.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use EnableExternalNonContainerDatabaseDatabaseManagement API.
EnableExternalPluggableDatabaseDatabaseManagementResponse enableExternalPluggableDatabaseDatabaseManagement(EnableExternalPluggableDatabaseDatabaseManagementRequest request)
Enable Database Management Service for the external pluggable database. For more information about the Database Management Service, see Database Management Service.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use EnableExternalPluggableDatabaseDatabaseManagement API.
FailOverAutonomousDatabaseResponse failOverAutonomousDatabase(FailOverAutonomousDatabaseRequest request)
Initiates a failover the specified Autonomous Database to a standby.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use FailOverAutonomousDatabase API.
FailoverAutonomousContainerDatabaseDataguardAssociationResponse failoverAutonomousContainerDatabaseDataguardAssociation(FailoverAutonomousContainerDatabaseDataguardAssociationRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use FailoverAutonomousContainerDatabaseDataguardAssociation API.
FailoverDataGuardAssociationResponse failoverDataGuardAssociation(FailoverDataGuardAssociationRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use FailoverDataGuardAssociation API.
GenerateAutonomousDatabaseWalletResponse generateAutonomousDatabaseWallet(GenerateAutonomousDatabaseWalletRequest request)
Creates and downloads a wallet for the specified Autonomous Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GenerateAutonomousDatabaseWallet API.
GenerateRecommendedVmClusterNetworkResponse generateRecommendedVmClusterNetwork(GenerateRecommendedVmClusterNetworkRequest request)
Generates a recommended Cloud@Customer VM cluster network configuration.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GenerateRecommendedVmClusterNetwork API.
GetAutonomousContainerDatabaseResponse getAutonomousContainerDatabase(GetAutonomousContainerDatabaseRequest request)
Gets information about the specified Autonomous Container Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetAutonomousContainerDatabase API.
GetAutonomousContainerDatabaseDataguardAssociationResponse getAutonomousContainerDatabaseDataguardAssociation(GetAutonomousContainerDatabaseDataguardAssociationRequest request)
Gets an Autonomous Container Database enabled with Autonomous Data Guard associated with the specified Autonomous Container Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetAutonomousContainerDatabaseDataguardAssociation API.
GetAutonomousDatabaseResponse getAutonomousDatabase(GetAutonomousDatabaseRequest request)
Gets the details of the specified Autonomous Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetAutonomousDatabase API.
GetAutonomousDatabaseBackupResponse getAutonomousDatabaseBackup(GetAutonomousDatabaseBackupRequest request)
Gets information about the specified Autonomous Database backup.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetAutonomousDatabaseBackup API.
GetAutonomousDatabaseDataguardAssociationResponse getAutonomousDatabaseDataguardAssociation(GetAutonomousDatabaseDataguardAssociationRequest request)
Gets an Autonomous Data Guard-enabled database associated with the specified Autonomous Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetAutonomousDatabaseDataguardAssociation API.
GetAutonomousDatabaseRegionalWalletResponse getAutonomousDatabaseRegionalWallet(GetAutonomousDatabaseRegionalWalletRequest request)
Gets the Autonomous Database regional wallet details.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetAutonomousDatabaseRegionalWallet API.
GetAutonomousDatabaseWalletResponse getAutonomousDatabaseWallet(GetAutonomousDatabaseWalletRequest request)
Gets the wallet details for the specified Autonomous Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetAutonomousDatabaseWallet API.
GetAutonomousExadataInfrastructureResponse getAutonomousExadataInfrastructure(GetAutonomousExadataInfrastructureRequest request)
Gets information about the specified Autonomous Exadata Infrastructure resource.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetAutonomousExadataInfrastructure API.
GetAutonomousPatchResponse getAutonomousPatch(GetAutonomousPatchRequest request)
Gets information about a specific autonomous patch.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetAutonomousPatch API.
GetAutonomousVmClusterResponse getAutonomousVmCluster(GetAutonomousVmClusterRequest request)
Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetAutonomousVmCluster API.
GetBackupResponse getBackup(GetBackupRequest request)
Gets information about the specified backup.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetBackup API.
GetBackupDestinationResponse getBackupDestination(GetBackupDestinationRequest request)
Gets information about the specified backup destination in an Exadata Cloud@Customer system.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetBackupDestination API.
GetCloudExadataInfrastructureResponse getCloudExadataInfrastructure(GetCloudExadataInfrastructureRequest request)
Gets information about the specified cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetCloudExadataInfrastructure API.
GetCloudVmClusterResponse getCloudVmCluster(GetCloudVmClusterRequest request)
Gets information about the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetCloudVmCluster API.
GetCloudVmClusterIormConfigResponse getCloudVmClusterIormConfig(GetCloudVmClusterIormConfigRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetCloudVmClusterIormConfig API.
GetCloudVmClusterUpdateResponse getCloudVmClusterUpdate(GetCloudVmClusterUpdateRequest request)
Gets information about a specified maintenance update package for a cloud VM cluster. Applies to Exadata Cloud Service instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetCloudVmClusterUpdate API.
GetCloudVmClusterUpdateHistoryEntryResponse getCloudVmClusterUpdateHistoryEntry(GetCloudVmClusterUpdateHistoryEntryRequest request)
Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud Service instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetCloudVmClusterUpdateHistoryEntry API.
GetConsoleConnectionResponse getConsoleConnection(GetConsoleConnectionRequest request)
Gets the specified database node console connection’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetConsoleConnection API.
GetDataGuardAssociationResponse getDataGuardAssociation(GetDataGuardAssociationRequest request)
Gets the specified Data Guard association’s configuration information.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetDataGuardAssociation API.
GetDatabaseResponse getDatabase(GetDatabaseRequest request)
Gets information about the specified database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetDatabase API.
GetDatabaseSoftwareImageResponse getDatabaseSoftwareImage(GetDatabaseSoftwareImageRequest request)
Gets information about the specified database software image.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetDatabaseSoftwareImage API.
GetDatabaseUpgradeHistoryEntryResponse getDatabaseUpgradeHistoryEntry(GetDatabaseUpgradeHistoryEntryRequest request)
gets the upgrade history for a specified database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetDatabaseUpgradeHistoryEntry API.
GetDbHomeResponse getDbHome(GetDbHomeRequest request)
Gets information about the specified Database Home.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetDbHome API.
GetDbHomePatchResponse getDbHomePatch(GetDbHomePatchRequest request)
Gets information about a specified patch package.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetDbHomePatch API.
GetDbHomePatchHistoryEntryResponse getDbHomePatchHistoryEntry(GetDbHomePatchHistoryEntryRequest request)
Gets the patch history details for the specified patchHistoryEntryId
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetDbHomePatchHistoryEntry API.
GetDbNodeResponse getDbNode(GetDbNodeRequest request)
Gets information about the specified database node.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetDbNode API.
GetDbSystemResponse getDbSystem(GetDbSystemRequest request)
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/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/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetDbSystem API.
GetDbSystemPatchResponse getDbSystemPatch(GetDbSystemPatchRequest request)
Gets information the specified patch.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetDbSystemPatch API.
GetDbSystemPatchHistoryEntryResponse getDbSystemPatchHistoryEntry(GetDbSystemPatchHistoryEntryRequest request)
Gets the details of the specified patch operation on the specified DB system.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetDbSystemPatchHistoryEntry API.
GetExadataInfrastructureResponse getExadataInfrastructure(GetExadataInfrastructureRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetExadataInfrastructure API.
GetExadataInfrastructureOcpusResponse getExadataInfrastructureOcpus(GetExadataInfrastructureOcpusRequest request)
Gets details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure resource.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetExadataInfrastructureOcpus API.
GetExadataIormConfigResponse getExadataIormConfig(GetExadataIormConfigRequest request)
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/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/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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetExadataIormConfig API.
GetExternalBackupJobResponse getExternalBackupJob(GetExternalBackupJobRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetExternalBackupJob API.
GetExternalContainerDatabaseResponse getExternalContainerDatabase(GetExternalContainerDatabaseRequest request)
Gets information about the specified external container database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetExternalContainerDatabase API.
GetExternalDatabaseConnectorResponse getExternalDatabaseConnector(GetExternalDatabaseConnectorRequest request)
Gets information about the specified external database connector.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetExternalDatabaseConnector API.
GetExternalNonContainerDatabaseResponse getExternalNonContainerDatabase(GetExternalNonContainerDatabaseRequest request)
Gets information about a specific external non-container database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetExternalNonContainerDatabase API.
GetExternalPluggableDatabaseResponse getExternalPluggableDatabase(GetExternalPluggableDatabaseRequest request)
Gets information about a specific
createExternalPluggableDatabaseDetails
resource.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetExternalPluggableDatabase API.
GetKeyStoreResponse getKeyStore(GetKeyStoreRequest request)
Gets information about the specified key store.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetKeyStore API.
GetMaintenanceRunResponse getMaintenanceRun(GetMaintenanceRunRequest request)
Gets information about the specified maintenance run.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetMaintenanceRun API.
GetVmClusterResponse getVmCluster(GetVmClusterRequest request)
Gets information about the VM cluster. Applies to Exadata Cloud@Customer instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetVmCluster API.
GetVmClusterNetworkResponse getVmClusterNetwork(GetVmClusterNetworkRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetVmClusterNetwork API.
GetVmClusterPatchResponse getVmClusterPatch(GetVmClusterPatchRequest request)
Gets information about a specified patch package.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetVmClusterPatch API.
GetVmClusterPatchHistoryEntryResponse getVmClusterPatchHistoryEntry(GetVmClusterPatchHistoryEntryRequest request)
Gets the patch history details for the specified patch history entry.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetVmClusterPatchHistoryEntry API.
LaunchAutonomousExadataInfrastructureResponse launchAutonomousExadataInfrastructure(LaunchAutonomousExadataInfrastructureRequest request)
Creates a new Autonomous Exadata Infrastructure in the specified compartment and availability domain.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use LaunchAutonomousExadataInfrastructure API.
LaunchDbSystemResponse launchDbSystem(LaunchDbSystemRequest request)
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/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/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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use LaunchDbSystem API.
ListAutonomousContainerDatabaseDataguardAssociationsResponse listAutonomousContainerDatabaseDataguardAssociations(ListAutonomousContainerDatabaseDataguardAssociationsRequest request)
Gets a list of the Autonomous Container Databases with Autonomous Data Guard-enabled associated with the specified Autonomous Container Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListAutonomousContainerDatabaseDataguardAssociations API.
ListAutonomousContainerDatabasesResponse listAutonomousContainerDatabases(ListAutonomousContainerDatabasesRequest request)
Gets a list of the Autonomous Container Databases in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListAutonomousContainerDatabases API.
ListAutonomousDatabaseBackupsResponse listAutonomousDatabaseBackups(ListAutonomousDatabaseBackupsRequest request)
Gets a list of Autonomous Database backups based on either the autonomousDatabaseId
or compartmentId
specified as a query parameter.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListAutonomousDatabaseBackups API.
ListAutonomousDatabaseClonesResponse listAutonomousDatabaseClones(ListAutonomousDatabaseClonesRequest request)
Lists the Autonomous Database clones for the specified Autonomous Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListAutonomousDatabaseClones API.
ListAutonomousDatabaseDataguardAssociationsResponse listAutonomousDatabaseDataguardAssociations(ListAutonomousDatabaseDataguardAssociationsRequest request)
Gets a list of the Autonomous Data Guard-enabled databases associated with the specified Autonomous Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListAutonomousDatabaseDataguardAssociations API.
ListAutonomousDatabasesResponse listAutonomousDatabases(ListAutonomousDatabasesRequest request)
Gets a list of Autonomous Databases based on the query parameters specified.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListAutonomousDatabases API.
ListAutonomousDbPreviewVersionsResponse listAutonomousDbPreviewVersions(ListAutonomousDbPreviewVersionsRequest request)
Gets a list of supported Autonomous Database versions. Note that preview version software is only available for databases with shared Exadata infrastructure.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListAutonomousDbPreviewVersions API.
ListAutonomousDbVersionsResponse listAutonomousDbVersions(ListAutonomousDbVersionsRequest request)
Gets a list of supported Autonomous Database versions.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListAutonomousDbVersions API.
ListAutonomousExadataInfrastructureShapesResponse listAutonomousExadataInfrastructureShapes(ListAutonomousExadataInfrastructureShapesRequest request)
Gets a list of the shapes that can be used to launch a new Autonomous Exadata Infrastructure resource. The shape determines resources to allocate (CPU cores, memory and storage).
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListAutonomousExadataInfrastructureShapes API.
ListAutonomousExadataInfrastructuresResponse listAutonomousExadataInfrastructures(ListAutonomousExadataInfrastructuresRequest request)
Gets a list of the Autonomous Exadata Infrastructures in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListAutonomousExadataInfrastructures API.
ListAutonomousVmClustersResponse listAutonomousVmClusters(ListAutonomousVmClustersRequest request)
Gets a list of Exadata Cloud@Customer Autonomous VM clusters in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListAutonomousVmClusters API.
ListBackupDestinationResponse listBackupDestination(ListBackupDestinationRequest request)
Gets a list of backup destinations in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListBackupDestination API.
ListBackupsResponse listBackups(ListBackupsRequest request)
Gets a list of backups based on the databaseId
or compartmentId
specified. Either one of these query parameters must be provided.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListBackups API.
ListCloudExadataInfrastructuresResponse listCloudExadataInfrastructures(ListCloudExadataInfrastructuresRequest request)
Gets a list of the cloud Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud Service instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListCloudExadataInfrastructures API.
ListCloudVmClusterUpdateHistoryEntriesResponse listCloudVmClusterUpdateHistoryEntries(ListCloudVmClusterUpdateHistoryEntriesRequest request)
Gets the history of the maintenance update actions performed on the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListCloudVmClusterUpdateHistoryEntries API.
ListCloudVmClusterUpdatesResponse listCloudVmClusterUpdates(ListCloudVmClusterUpdatesRequest request)
Lists the maintenance updates that can be applied to the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListCloudVmClusterUpdates API.
ListCloudVmClustersResponse listCloudVmClusters(ListCloudVmClustersRequest request)
Gets a list of the cloud VM clusters in the specified compartment. Applies to Exadata Cloud Service instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListCloudVmClusters API.
ListConsoleConnectionsResponse listConsoleConnections(ListConsoleConnectionsRequest request)
Lists the console connections for the specified database node.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListConsoleConnections API.
ListContainerDatabasePatchesResponse listContainerDatabasePatches(ListContainerDatabasePatchesRequest request)
Lists the patches applicable to the requested container database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListContainerDatabasePatches API.
ListDataGuardAssociationsResponse listDataGuardAssociations(ListDataGuardAssociationsRequest request)
Lists all Data Guard associations for the specified database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListDataGuardAssociations API.
ListDatabaseSoftwareImagesResponse listDatabaseSoftwareImages(ListDatabaseSoftwareImagesRequest request)
Gets a list of the database software images in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListDatabaseSoftwareImages API.
ListDatabaseUpgradeHistoryEntriesResponse listDatabaseUpgradeHistoryEntries(ListDatabaseUpgradeHistoryEntriesRequest request)
Gets the upgrade history for a specified database in a bare metal or virtual machine DB system.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListDatabaseUpgradeHistoryEntries API.
ListDatabasesResponse listDatabases(ListDatabasesRequest request)
Gets a list of the databases in the specified Database Home.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListDatabases API.
ListDbHomePatchHistoryEntriesResponse listDbHomePatchHistoryEntries(ListDbHomePatchHistoryEntriesRequest request)
Lists the history of patch operations on the specified Database Home.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListDbHomePatchHistoryEntries API.
ListDbHomePatchesResponse listDbHomePatches(ListDbHomePatchesRequest request)
Lists patches applicable to the requested Database Home.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListDbHomePatches API.
ListDbHomesResponse listDbHomes(ListDbHomesRequest request)
Lists the Database Homes in the specified DB system and compartment. A Database Home is a directory where Oracle Database software is installed.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListDbHomes API.
ListDbNodesResponse listDbNodes(ListDbNodesRequest request)
Lists the database nodes in the specified DB system and compartment. A database node is a server running database software.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListDbNodes API.
ListDbSystemPatchHistoryEntriesResponse listDbSystemPatchHistoryEntries(ListDbSystemPatchHistoryEntriesRequest request)
Gets the history of the patch actions performed on the specified DB system.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListDbSystemPatchHistoryEntries API.
ListDbSystemPatchesResponse listDbSystemPatches(ListDbSystemPatchesRequest request)
Lists the patches applicable to the specified DB system.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListDbSystemPatches API.
ListDbSystemShapesResponse listDbSystemShapes(ListDbSystemShapesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListDbSystemShapes API.
ListDbSystemsResponse listDbSystems(ListDbSystemsRequest request)
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/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/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListDbSystems API.
ListDbVersionsResponse listDbVersions(ListDbVersionsRequest request)
Gets a list of supported Oracle Database versions.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListDbVersions API.
ListExadataInfrastructuresResponse listExadataInfrastructures(ListExadataInfrastructuresRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListExadataInfrastructures API.
ListExternalContainerDatabasesResponse listExternalContainerDatabases(ListExternalContainerDatabasesRequest request)
Gets a list of the external container databases in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListExternalContainerDatabases API.
ListExternalDatabaseConnectorsResponse listExternalDatabaseConnectors(ListExternalDatabaseConnectorsRequest request)
Gets a list of the external database connectors in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListExternalDatabaseConnectors API.
ListExternalNonContainerDatabasesResponse listExternalNonContainerDatabases(ListExternalNonContainerDatabasesRequest request)
Gets a list of the ExternalNonContainerDatabases in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListExternalNonContainerDatabases API.
ListExternalPluggableDatabasesResponse listExternalPluggableDatabases(ListExternalPluggableDatabasesRequest request)
Gets a list of the createExternalPluggableDatabaseDetails
resources in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListExternalPluggableDatabases API.
ListFlexComponentsResponse listFlexComponents(ListFlexComponentsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListFlexComponents API.
ListGiVersionsResponse listGiVersions(ListGiVersionsRequest request)
Gets a list of supported GI versions for the Exadata Cloud@Customer VM cluster.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListGiVersions API.
ListKeyStoresResponse listKeyStores(ListKeyStoresRequest request)
Gets a list of key stores in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListKeyStores API.
ListMaintenanceRunsResponse listMaintenanceRuns(ListMaintenanceRunsRequest request)
Gets a list of the maintenance runs in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListMaintenanceRuns API.
ListVmClusterNetworksResponse listVmClusterNetworks(ListVmClusterNetworksRequest request)
Gets a list of the VM cluster networks in the specified compartment. Applies to Exadata Cloud@Customer instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListVmClusterNetworks API.
ListVmClusterPatchHistoryEntriesResponse listVmClusterPatchHistoryEntries(ListVmClusterPatchHistoryEntriesRequest request)
Gets the history of the patch actions performed on the specified VM cluster in an Exadata Cloud@Customer system.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListVmClusterPatchHistoryEntries API.
ListVmClusterPatchesResponse listVmClusterPatches(ListVmClusterPatchesRequest request)
Lists the patches applicable to the specified VM cluster in an Exadata Cloud@Customer system.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListVmClusterPatches API.
ListVmClustersResponse listVmClusters(ListVmClustersRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListVmClusters API.
MigrateExadataDbSystemResourceModelResponse migrateExadataDbSystemResourceModel(MigrateExadataDbSystemResourceModelRequest request)
Migrates the Exadata DB system to the new Exadata resource model. All related resources will be migrated.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use MigrateExadataDbSystemResourceModel API.
MigrateVaultKeyResponse migrateVaultKey(MigrateVaultKeyRequest request)
Changes encryption key management from customer-managed, using the Vault service, to Oracle-managed.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use MigrateVaultKey API.
RegisterAutonomousDatabaseDataSafeResponse registerAutonomousDatabaseDataSafe(RegisterAutonomousDatabaseDataSafeRequest request)
Asynchronously registers this Autonomous Database with Data Safe.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use RegisterAutonomousDatabaseDataSafe API.
ReinstateAutonomousContainerDatabaseDataguardAssociationResponse reinstateAutonomousContainerDatabaseDataguardAssociation(ReinstateAutonomousContainerDatabaseDataguardAssociationRequest request)
Reinstates a disabled standby Autonomous Container Database, identified by the autonomousContainerDatabaseId parameter, to an active standby Autonomous Container Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ReinstateAutonomousContainerDatabaseDataguardAssociation API.
ReinstateDataGuardAssociationResponse reinstateDataGuardAssociation(ReinstateDataGuardAssociationRequest request)
Reinstates the database identified by the databaseId
parameter into the standby role in a Data Guard association.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ReinstateDataGuardAssociation API.
RestartAutonomousContainerDatabaseResponse restartAutonomousContainerDatabase(RestartAutonomousContainerDatabaseRequest request)
Rolling restarts the specified Autonomous Container Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use RestartAutonomousContainerDatabase API.
RestartAutonomousDatabaseResponse restartAutonomousDatabase(RestartAutonomousDatabaseRequest request)
Restarts the specified Autonomous Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use RestartAutonomousDatabase API.
RestoreAutonomousDatabaseResponse restoreAutonomousDatabase(RestoreAutonomousDatabaseRequest request)
Restores an Autonomous Database based on the provided request parameters.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use RestoreAutonomousDatabase API.
RestoreDatabaseResponse restoreDatabase(RestoreDatabaseRequest request)
Restore a Database based on the request parameters you provide.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use RestoreDatabase API.
RotateAutonomousContainerDatabaseEncryptionKeyResponse rotateAutonomousContainerDatabaseEncryptionKey(RotateAutonomousContainerDatabaseEncryptionKeyRequest request)
Creates a new version of an existing Vault service key.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use RotateAutonomousContainerDatabaseEncryptionKey API.
RotateAutonomousDatabaseEncryptionKeyResponse rotateAutonomousDatabaseEncryptionKey(RotateAutonomousDatabaseEncryptionKeyRequest request)
Rotate existing AutonomousDatabase Vault service key.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use RotateAutonomousDatabaseEncryptionKey API.
RotateOrdsCertsResponse rotateOrdsCerts(RotateOrdsCertsRequest request)
Rotates Oracle REST Data Services (ORDS) certs for an Autonomous Exadata Infrastructure resource.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use RotateOrdsCerts API.
RotateSslCertsResponse rotateSslCerts(RotateSslCertsRequest request)
Rotates SSL certs for an Autonomous Exadata Infrastructure resource.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use RotateSslCerts API.
RotateVaultKeyResponse rotateVaultKey(RotateVaultKeyRequest request)
Creates a new version of an existing Vault service key.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use RotateVaultKey API.
ScanExternalContainerDatabasePluggableDatabasesResponse scanExternalContainerDatabasePluggableDatabases(ScanExternalContainerDatabasePluggableDatabasesRequest request)
Scans for pluggable databases in the specified external container database.
This operation will return un-registered pluggable databases in the GetWorkRequest
operation.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ScanExternalContainerDatabasePluggableDatabases API.
StartAutonomousDatabaseResponse startAutonomousDatabase(StartAutonomousDatabaseRequest request)
Starts the specified Autonomous Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use StartAutonomousDatabase API.
StopAutonomousDatabaseResponse stopAutonomousDatabase(StopAutonomousDatabaseRequest request)
Stops the specified Autonomous Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use StopAutonomousDatabase API.
SwitchoverAutonomousContainerDatabaseDataguardAssociationResponse switchoverAutonomousContainerDatabaseDataguardAssociation(SwitchoverAutonomousContainerDatabaseDataguardAssociationRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use SwitchoverAutonomousContainerDatabaseDataguardAssociation API.
SwitchoverAutonomousDatabaseResponse switchoverAutonomousDatabase(SwitchoverAutonomousDatabaseRequest request)
Initiates a switchover of the specified Autonomous Database to the associated standby database. Applicable only to databases with Autonomous Data Guard enabled.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use SwitchoverAutonomousDatabase API.
SwitchoverDataGuardAssociationResponse switchoverDataGuardAssociation(SwitchoverDataGuardAssociationRequest request)
Performs a switchover to transition the primary database of a Data Guard association into a standby role. The
standby database associated with the dataGuardAssociationId
assumes the primary database role.
A switchover guarantees no data loss.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use SwitchoverDataGuardAssociation API.
TerminateAutonomousContainerDatabaseResponse terminateAutonomousContainerDatabase(TerminateAutonomousContainerDatabaseRequest request)
Terminates an Autonomous Container Database, which permanently deletes the container database and any databases within the container database. The database data is local to the Autonomous Exadata Infrastructure and will be lost when the container database is terminated. Oracle recommends that you back up any data in the Autonomous Container Database prior to terminating it.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use TerminateAutonomousContainerDatabase API.
TerminateAutonomousExadataInfrastructureResponse terminateAutonomousExadataInfrastructure(TerminateAutonomousExadataInfrastructureRequest request)
Terminates an Autonomous Exadata Infrastructure, which permanently deletes the infrastructure resource and any container databases and databases contained in the resource. The database data is local to the Autonomous Exadata Infrastructure and will be lost when the system is terminated. Oracle recommends that you back up any data in the Autonomous Exadata Infrastructure prior to terminating it.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use TerminateAutonomousExadataInfrastructure API.
TerminateDbSystemResponse terminateDbSystem(TerminateDbSystemRequest request)
Terminates a DB system and permanently deletes it and any databases running on it, and any storage volumes attached to it. The database data is local to the DB system and will be lost when the system is terminated. Oracle recommends that you back up any data in the DB system prior to terminating it.
Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/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/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use TerminateDbSystem API.
UpdateAutonomousContainerDatabaseResponse updateAutonomousContainerDatabase(UpdateAutonomousContainerDatabaseRequest request)
Updates the properties of an Autonomous Container Database, such as the OCPU core count and storage size.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateAutonomousContainerDatabase API.
UpdateAutonomousDatabaseResponse updateAutonomousDatabase(UpdateAutonomousDatabaseRequest request)
Updates one or more attributes of the specified Autonomous Database. See the UpdateAutonomousDatabaseDetails resource for a full list of attributes that can be updated.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateAutonomousDatabase API.
UpdateAutonomousDatabaseRegionalWalletResponse updateAutonomousDatabaseRegionalWallet(UpdateAutonomousDatabaseRegionalWalletRequest request)
Updates the Autonomous Database regional wallet.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateAutonomousDatabaseRegionalWallet API.
UpdateAutonomousDatabaseWalletResponse updateAutonomousDatabaseWallet(UpdateAutonomousDatabaseWalletRequest request)
Updates the wallet for the specified Autonomous Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateAutonomousDatabaseWallet API.
UpdateAutonomousExadataInfrastructureResponse updateAutonomousExadataInfrastructure(UpdateAutonomousExadataInfrastructureRequest request)
Updates the properties of an Autonomous Exadata Infrastructure, such as the CPU core count.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateAutonomousExadataInfrastructure API.
UpdateAutonomousVmClusterResponse updateAutonomousVmCluster(UpdateAutonomousVmClusterRequest request)
Updates the specified Autonomous VM cluster for the Exadata Cloud@Customer system.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateAutonomousVmCluster API.
UpdateBackupDestinationResponse updateBackupDestination(UpdateBackupDestinationRequest request)
If no database is associated with the backup destination:
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateBackupDestination API.
UpdateCloudExadataInfrastructureResponse updateCloudExadataInfrastructure(UpdateCloudExadataInfrastructureRequest request)
Updates the Cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateCloudExadataInfrastructure API.
UpdateCloudVmClusterResponse updateCloudVmCluster(UpdateCloudVmClusterRequest request)
Updates the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateCloudVmCluster API.
UpdateCloudVmClusterIormConfigResponse updateCloudVmClusterIormConfig(UpdateCloudVmClusterIormConfigRequest request)
Updates the IORM settings for the specified cloud VM cluster in an Exadata Cloud Service instance.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateCloudVmClusterIormConfig API.
UpdateDatabaseResponse updateDatabase(UpdateDatabaseRequest request)
Update the specified database based on the request parameters provided.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateDatabase API.
UpdateDatabaseSoftwareImageResponse updateDatabaseSoftwareImage(UpdateDatabaseSoftwareImageRequest request)
Updates the properties of a Database Software Image, like Display Nmae
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateDatabaseSoftwareImage API.
UpdateDbHomeResponse updateDbHome(UpdateDbHomeRequest request)
Patches the specified Database Home.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateDbHome API.
UpdateDbSystemResponse updateDbSystem(UpdateDbSystemRequest request)
Updates the properties of the specified DB system.
Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/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/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateDbSystem API.
UpdateExadataInfrastructureResponse updateExadataInfrastructure(UpdateExadataInfrastructureRequest request)
Updates the Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only.
To update an Exadata Cloud Service infrastructure resource, use the updateCloudExadataInfrastructure
operation.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateExadataInfrastructure API.
UpdateExadataIormConfigResponse updateExadataIormConfig(UpdateExadataIormConfigRequest request)
Updates IORM settings for the specified Exadata DB system.
Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/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/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.
The updateCloudVmClusterIormConfig
API is used for Exadata systems using the
new resource model.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateExadataIormConfig API.
UpdateExternalContainerDatabaseResponse updateExternalContainerDatabase(UpdateExternalContainerDatabaseRequest request)
Updates the properties of
an createExternalContainerDatabaseDetails
resource,
such as the display name.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateExternalContainerDatabase API.
UpdateExternalDatabaseConnectorResponse updateExternalDatabaseConnector(UpdateExternalDatabaseConnectorRequest request)
Updates the properties of an external database connector, such as the display name.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateExternalDatabaseConnector API.
UpdateExternalNonContainerDatabaseResponse updateExternalNonContainerDatabase(UpdateExternalNonContainerDatabaseRequest request)
Updates the properties of an external non-container database, such as the display name.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateExternalNonContainerDatabase API.
UpdateExternalPluggableDatabaseResponse updateExternalPluggableDatabase(UpdateExternalPluggableDatabaseRequest request)
Updates the properties of an
createExternalPluggableDatabaseDetails
resource,
such as the display name.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateExternalPluggableDatabase API.
UpdateKeyStoreResponse updateKeyStore(UpdateKeyStoreRequest request)
If no database is associated with the key store, edit the key store.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateKeyStore API.
UpdateMaintenanceRunResponse updateMaintenanceRun(UpdateMaintenanceRunRequest request)
Updates the properties of a maintenance run, such as the state of a maintenance run.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateMaintenanceRun API.
UpdateVmClusterResponse updateVmCluster(UpdateVmClusterRequest request)
Updates the specified VM cluster. Applies to Exadata Cloud@Customer instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateVmCluster API.
UpdateVmClusterNetworkResponse updateVmClusterNetwork(UpdateVmClusterNetworkRequest request)
Updates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.
To update a cloud VM cluster in an Exadata Cloud Service instance, use the updateCloudVmCluster
operation.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpdateVmClusterNetwork API.
UpgradeDatabaseResponse upgradeDatabase(UpgradeDatabaseRequest request)
Upgrades the specified Oracle Database instance.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use UpgradeDatabase API.
ValidateVmClusterNetworkResponse validateVmClusterNetwork(ValidateVmClusterNetworkRequest request)
Validates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ValidateVmClusterNetwork API.
@Deprecated DatabaseWaiters getWaiters()
newWaiters(WorkRequest)
instead. Otherwise, a default one will be provided
that does not support operations that rely on the WorkRequestClient
for polling. An
IllegalStateException
will be thrown for such operations.Gets the pre-configured waiters available for resources for this service.
DatabaseWaiters newWaiters(WorkRequest workRequestClient)
Creates a new DatabaseWaiters
for resources for this service.
workRequestClient
- The work request service client used to query for work request statusDatabasePaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data. These paginators provide an Iterable
interface so that service responses, or
resources/records, can be iterated through without having to manually deal with pagination and page tokens.
Copyright © 2016–2021. All rights reserved.