API Reference for Autonomous Database on Dedicated Exadata Infrastructure

You can use API to view and manage the different infrastructure resources of an Autonomous Database on Dedicated Exadata Infrastructure.

For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.

Related Topics

IAM Policy Details

API to Manage Exadata Infrastructure Resources

The following table lists the REST API endpoints to manage Exadata Infrastructure resources on Oracle Public Cloud.

Operation	REST API Endpoint	Required IAM Permissions
Create an Exadata Infrastructure resource	CreateCloudExadataInfrastructure	CLOUD_EXADATA_INFRASTRUCTURE_CREATE VNIC_CREATE SUBNET_ATTACH VNIC_ATTACH
View a list of Exadata Infrastructure resources	ListCloudExadataInfrastructures	CLOUD_EXADATA_INFRASTRUCTURE_INSPECT
View details of an Exadata Infrastructure resource	GetCloudExadataInfrastructure	CLOUD_EXADATA_INFRASTRUCTURE_INSPECT
Update details an Exadata Infrastructure resource. You can use this API to update compute, storage, contacts, tags, and maintenance window.	UpdateCloudExadataInfrastructure	CLOUD_EXADATA_INFRASTRUCTURE_UPDATE
Move an Exadata Infrastructure resource to another compartment	ChangeCloudExadataInfrastructureCompartment	CLOUD_EXADATA_INFRASTRUCTURE_UPDATE
Terminate an Exadata Infrastructure resource	DeleteCloudExadataInfrastructure	CLOUD_EXADATA_INFRASTRUCTURE_DELETE VNIC_DELETE SUBNET_DETACH VNIC_DETACH

The following table lists the REST API endpoints to manage Exadata Infrastructure resources on Exadata Cloud@Customer.

Operation	REST API Endpoint	Required IAM Permissions
Create an Exadata Infrastructure resource	CreateExadataInfrastructure	EXADATA_INFRASTRUCTURE_CREATE
View a list of Exadata Infrastructure resources	ListExadataInfrastructures	EXADATA_INFRASTRUCTURE_INSPECT
View details of an Exadata Infrastructure resource	GetExadataInfrastructure	EXADATA_INFRASTRUCTURE_INSPECT
Update details an Exadata Infrastructure resource. You can use this API to update compute, storage, contacts, tags, and maintenance window.	UpdateExadataInfrastructure	EXADATA_INFRASTRUCTURE_UPDATE
Move an Exadata Infrastructure resource to another compartment	ChangeExadataInfrastructureCompartment	EXADATA_INFRASTRUCTURE_INSPECT and EXADATA_INFRASTRUCTURE_UPDATE
Terminate an Exadata Infrastructure resource	DeleteExadataInfrastructure	EXADATA_INFRASTRUCTURE_DELETE
Download an Exadata Infrastructure resource configuration file	DownloadExadataInfrastructureConfigFile	EXADATA_INFRASTRUCTURE_CONTENT_READ
Add storage capacity to an Exadata Infrastructure	AddStorageCapacityExadataInfrastructure	EXADATA_INFRASTRUCTURE_UPDATE
Activate an Exadata Infrastructure	ActivateExadataInfrastructure	EXADATA_INFRASTRUCTURE_UPDATE

API to Manage Autonomous Exadata VM Clusters

The following table lists the REST API endpoints to manage Autonomous Exadata VM Clusters on Oracle Public Cloud.

Operation	REST API Endpoint	Required IAM Permissions
Create an Autonomous Exadata VM Cluster	CreateCloudAutonomousVmCluster	CLOUD_AUTONOMOUS_VM_CLUSTER_CREATE and CLOUD_EXADATA_INFRASTRUCTURE_UPDATE
View details of an Autonomous Exadata VM Cluster	GetCloudAutonomousVmCluster	CLOUD_AUTONOMOUS_VM_CLUSTER_INSPECT
View a list of Autonomous Exadata VM Clusters	ListCloudAutonomousVmClusters	CLOUD_AUTONOMOUS_VM_CLUSTER_INSPECT
Move an Autonomous Exadata VM Cluster to another compartment	ChangeCloudAutonomousVmClusterCompartment	CLOUD_AUTONOMOUS_VM_CLUSTER_INSPECT and CLOUD_AUTONOMOUS_VM_CLUSTER_UPDATE
Terminate an Autonomous Exadata VM Cluster	DeleteCloudAutonomousVmCluster	CLOUD_AUTONOMOUS_VM_CLUSTER_DELETE
Rotate ORDS Certificates	RotateCloudAutonomousVmClusterOrdsCerts	CLOUD_AUTONOMOUS_VM_CLUSTER_UPDATE
Rotate SSL Certificates	RotateCloudAutonomousVmClusterSslCerts	CLOUD_AUTONOMOUS_VM_CLUSTER_UPDATE
Update details of Autonomous Exadata VM Clusters. You can modify the tags, license model, or Network Security Groups (NSG) using this API.	UpdateCloudAutonomousVmCluster	CLOUD_AUTONOMOUS_VM_CLUSTER_UPDATE
Get the resource usage details of an Autonomous Exadata VM Cluster and the usage statistics of the Autonomous Container Databases within it.	GetAutonomousVMClusterResourceUsage	CLOUD_AUTONOMOUS_VM_CLUSTER_INSPECT

The following table lists the REST API endpoints to manage Autonomous Exadata VM Clusters on Exadata Cloud@Customer.

Operation	REST API Endpoint	Required IAM Permissions
Create an Autonomous Exadata VM Cluster	CreateAutonomousVmCluster	AUTONOMOUS_VM_CLUSTER_CREATE and EXADATA_INFRASTRUCTURE_INSPECT and EXADATA_INFRASTRUCTURE_UPDATE
View a list of Autonomous Exadata VM Clusters	ListAutonomousVmClusters	AUTONOMOUS_VM_CLUSTER_INSPECT
View details of an Autonomous Exadata VM Cluster	GetAutonomousVmCluster	AUTONOMOUS_VM_CLUSTER_INSPECT
Change the license type of an Autonomous Exadata VM Cluster	UpdateAutonomousVmCluster	AUTONOMOUS_VM_CLUSTER_UPDATE and EXADATA_INFRASTRUCTURE_INSPECT and EXADATA_INFRASTRUCTURE_UPDATE
Move an Autonomous Exadata VM Cluster to another compartment	ChangeAutonomousVmClusterCompartment	AUTONOMOUS_VM_CLUSTER_INSPECT and AUTONOMOUS_VM_CLUSTER_UPDATE
Terminate an Autonomous Exadata VM Cluster	DeleteAutonomousVmCluster	AUTONOMOUS_VM_CLUSTER_DELETE

API to Manage Autonomous Container Databases

The following table lists the REST API endpoints to manage Autonomous Container Databases.

Operation	REST API Endpoint	Required IAM Permissions
Create an Autonomous Container Database	CreateAutonomousContainerDatabase	On Oracle Public Cloud: CLOUD_EXADATA_INFRASTRUCTURE_UPDATE and CLOUD_AUTONOMOUS_VM_CLUSTER_UPDATE and AUTONOMOUS_CONTAINER_DATABASE_CREATE On Exadata Cloud@Customer: EXADATA_INFRASTRUCTURE_UPDATE and AUTONOMOUS_VM_CLUSTER_UPDATE and AUTONOMOUS_CONTAINER_DATABASE_CREATE
View a list of Autonomous Container Databases	ListAutonomousContainerDatabases	AUTONOMOUS_CONTAINER_DATABASE_INSPECT
View details of an Autonomous Container Database	GetAutonomousContainerDatabase	AUTONOMOUS_CONTAINER_DATABASE_INSPECT
Change the backup retention policy of an Autonomous Container Database or Edit the maintenance preferences of an Autonomous Container Database	UpdateAutonomousContainerDatabase	AUTONOMOUS_CONTAINER_DATABASE_UPDATE
Restart an Autonomous Container Database	RestartAutonomousContainerDatabase	AUTONOMOUS_CONTAINER_DATABASE_UPDATE
Move an Autonomous Container Database to another compartment	ChangeAutonomousContainerDatabaseCompartment	AUTONOMOUS_CONTAINER_DATABASE_INSPECT and AUTONOMOUS_CONTAINER_DATABASE_UPDATE
Rotate an Autonomous Container Database key	RotateAutonomousContainerDatabaseEncryptionKey	APPLIES TO: Exadata Cloud@Customer only AUTONOMOUS_CONTAINER_DATABASE_UPDATE and AUTONOMOUS_CONTAINER_DATABASE_INSPECT
Terminate an Autonomous Container Database	TerminateAutonomousContainerDatabase	On Oracle Public Cloud: CLOUD_EXADATA_INFRASTRUCTURE_UPDATE and CLOUD_AUTONOMOUS_VM_CLUSTER_UPDATE and AUTONOMOUS_CONTAINER_DATABASE_DELETE On Exadata Cloud@Customer: EXADATA_INFRASTRUCTURE_UPDATE and AUTONOMOUS_VM_CLUSTER_UPDATE and AUTONOMOUS_CONTAINER_DATABASE_DELETE
Get the resource usage statistics of an Autonomous Container Database	GetAutonomousContainerDatabaseResourceUsage	AUTONOMOUS_CONTAINER_DATABASE_INSPECT

API to Manage Autonomous Databases

The following table lists the REST API endpoints to manage Autonomous Databases.

Operation	REST API Endpoint	Required IAM Permissions
Create an Autonomous Database or Clone an Autonomous Database	CreateAutonomousDatabase	AUTONOMOUS_DATABASE_CREATE
View a list of Autonomous Databases	ListAutonomousDatabases	AUTONOMOUS_DATABASE_INSPECT
View details of an Autonomous Database	GetAutonomousDatabase	AUTONOMOUS_DATABASE_INSPECT
View a list of character sets supported by Autonomous Database.	ListAutonomousDatabaseCharacterSets	None
Set the password of an Autonomous Database's ADMIN user or Scale the CPU core count or storage of an Autonomous Database or Enable or disable auto scaling for an Autonomous Database	UpdateAutonomousDatabase	AUTONOMOUS_DATABASE_UPDATE
Move an Autonomous Database to another compartment	ChangeAutonomousDatabaseCompartment	AUTONOMOUS_DATABASE_UPDATE and AUTONOMOUS_DB_BACKUP_INSPECT and AUTONOMOUS_DB_BACKUP_CONTENT_READ and AUTONOMOUS_DATABASE_CONTENT_WRITE
Rotate an Autonomous Database key	RotateAutonomousDatabaseEncryptionKey	AUTONOMOUS_DATABASE_UPDATE
Start an Autonomous Database	StartAutonomousDatabase	AUTONOMOUS_DATABASE_UPDATE
Stop an Autonomous Database	StopAutonomousDatabase	AUTONOMOUS_DATABASE_UPDATE
Restart an Autonomous Database	RestartAutonomousDatabase	AUTONOMOUS_DATABASE_UPDATE
Terminate an Autonomous Database	DeleteAutonomousDatabase	AUTONOMOUS_DATABASE_DELETE
Restore an Autonomous Database	RestoreAutonomousDatabase	AUTONOMOUS_DB_BACKUP_CONTENT_READ and AUTONOMOUS_DATABASE_CONTENT_WRITE
Back up an Autonomous Database manually	CreateAutonomousDatabaseBackup	AUTONOMOUS_DB_BACKUP_CREATE and AUTONOMOUS_DATABASE_CONTENT_READ
View the list of Autonomous Database backups	ListAutonomousDatabaseBackups	AUTONOMOUS_DB_BACKUP_INSPECT
Get the details of an Autonomous Database backup	GetAutonomousDatabaseBackup	AUTONOMOUS_DB_BACKUP_INSPECT
Delete a long-term backup	DeleteAutonomousDatabaseBackup	AUTONOMOUS_DB_BACKUP_DELETE
Update the retention period of a long-term backup	UpdateAutonomousDatabaseBackup	AUTONOMOUS_DB_BACKUP_UPDATE

API to Manage Autonomous Data Guard Configuration

The following table lists the REST API endpoints to manage an Autonomous Data Guard configuration.

Operation	REST API Endpoint	Required IAM Permissions
View the Autonomous Data Guard Association with an Autonomous Container Database.	GetAutonomousContainerDatabaseDataguardAssociation	AUTONOMOUS_CONTAINER_DATABASE_INSPECT
List the Autonomous Container Databases enabled with Autonomous Data Guard associated with the specified Autonomous Container Database or Autonomous Database.	ListAutonomousContainerDatabaseDataguardAssociations	AUTONOMOUS_CONTAINER_DATABASE_INSPECT
Reinstate the Disabled Standby in an Autonomous Data Guard Configuration.	ReinstateAutonomousContainerDatabaseDataguardAssociation	AUTONOMOUS_CONTAINER_DATABASE_INSPECT and AUTONOMOUS_CONTAINER_DATABASE_UPDATE
Switch Roles in an Autonomous Data Guard Configuration.	SwitchoverAutonomousContainerDatabaseDataguardAssociation	AUTONOMOUS_CONTAINER_DATABASE_INSPECT and AUTONOMOUS_CONTAINER_DATABASE_UPDATE
Fail Over to the Standby in an Autonomous Data Guard Configuration.	FailoverAutonomousContainerDatabaseDataguardAssociation	AUTONOMOUS_CONTAINER_DATABASE_INSPECT and AUTONOMOUS_CONTAINER_DATABASE_UPDATE
Enable or Disable Automatic Failover in an Autonomous Data Guard Configuration.	UpdateAutonomousContainerDatabaseDataguardAssociation	AUTONOMOUS_CONTAINER_DATABASE_INSPECT and AUTONOMOUS_CONTAINER_DATABASE_UPDATE
Get an Autonomous Data Guard-enabled database associated with the specified Autonomous Database.	GetAutonomousDatabaseDataguardAssociation	AUTONOMOUS_CONTAINER_DATABASE_INSPECT
List Autonomous Database data guard associations.	ListAutonomousDatabaseDataguardAssociations	AUTONOMOUS_CONTAINER_DATABASE_INSPECT
Enable Autonomous Data Guard on an Autonomous Container Database	CreateAutonomousContainerDatabaseDataguardAssociation	CLOUD_AUTONOMOUS_VM_CLUSTER_INSPECT, AUTONOMOUS_CONTAINER_DATABASE_INSPECT, and AUTONOMOUS_CONTAINER_DATABASE_UPDATE

For complete details of each REST API endpoint along with examples, see:

API to Manage Autonomous Virtual Machines

The following table lists the REST API endpoints to manage an Autonomous Virtual Machines.

Operation	REST API Endpoint	Required IAM Permissions
Gets the details of a specific Autonomous Virtual Machine.	GetAutonomousVirtualMachine	AUTONOMOUS_VIRTUAL_MACHINE_INSPECT
Lists the Autonomous Virtual Machines in the specified Autonomous VM Cluster and Compartment.	ListAutonomousVirtualMachines	AUTONOMOUS_VIRTUAL_MACHINE_INSPECT

API to Manage Autonomous Database Software Images

The following table lists the REST API endpoints to manage an Autonomous Database software image.

Operation	REST API Endpoint	Required IAM Permissions
Create an Autonomous Database software image in the specified compartment.	CreateAutonomousDatabaseSoftwareImage	AUTO_DB_SOFTWARE_IMG_CREATE
Move an Autonomous Database software image and its dependent resources to the specified compartment.	ChangeAutonomousDatabaseSoftwareImageCompartment	AUTO_DB_SOFTWARE_IMG_UPDATE
Delete an Autonomous Database software image.	DeleteAutonomousDatabaseSoftwareImage	AUTO_DB_SOFTWARE_IMG_DELETE
Get information about the specified Autonomous Database software image.	GetAutonomousDatabaseSoftwareImage	AUTO_DB_SOFTWARE_IMG_INSPECT
Get a list of the Autonomous Database software images in the specified compartment.	ListAutonomousDatabaseSoftwareImages	AUTO_DB_SOFTWARE_IMG_INSPECT
Update details of an Autonomous Database software image.	UpdateAutonomousDatabaseSoftwareImage	AUTO_DB_SOFTWARE_IMG_UPDATE

Title and Copyright Information

API Reference for Autonomous Database on Dedicated Exadata Infrastructure

Oracle and/or its affiliates.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.