Amazon Web Services, Inc.

odb

Oracle Database@Amazon Web Services is an offering that enables you to access Oracle Exadata infrastructure managed by Oracle Cloud Infrastructure (OCI)…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Oracle Database@Amazon Web Services is an offering that enables you to access Oracle Exadata infrastructure managed by Oracle Cloud Infrastructure (OCI) inside Amazon Web Services data centers. You can migrate your Oracle Exadata workloads, establish low-latency connectivity with applications running on Amazon Web Services, and integrate with Amazon Web Services services. For example, you can run application servers in a Virtual Private Cloud (VPC) and access an Oracle Exadata system running in Oracle Database@Amazon Web Services. You can get started with Oracle Database@Amazon Web Services by using the familiar Amazon Web Services Management Console, APIs, or CLI. This interface reference for Oracle Database@Amazon Web Services contains documentation for a programming or command line interface that you can use to manage Oracle Database@Amazon Web Services. Oracle Database@Amazon Web Services is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. The reference structure is as follows. Oracle Database@Amazon Web Services API Reference For the alphabetical list of API actions, see API Actions . For the alphabetical list of data types, see Data Types . For a list of common query parameters, see Common Parameters . For descriptions of the error codes, see Common Errors .

Endpoints 86

Cloud vm cluster

  • POSTAssociate virtual machines to cloud vm cluster/#X-Amz-Target=Odb.AssociateVirtualMachinesToCloudVmClusterAdds virtual machines to the specified VM cluster.
  • POSTCreate cloud vm cluster/#X-Amz-Target=Odb.CreateCloudVmClusterCreates a VM cluster on the specified Exadata infrastructure.
  • POSTDelete cloud vm cluster/#X-Amz-Target=Odb.DeleteCloudVmClusterDeletes the specified VM cluster.
  • POSTDisassociate virtual machines from cloud vm cluster/#X-Amz-Target=Odb.DisassociateVirtualMachinesFromCloudVmClusterRemoves virtual machines from the specified VM cluster.
  • POSTGet cloud vm cluster/#X-Amz-Target=Odb.GetCloudVmClusterReturns information about the specified VM cluster.
  • POSTList cloud vm clusters/#X-Amz-Target=Odb.ListCloudVmClustersReturns information about the VM clusters owned by your Amazon Web Services account or only the ones on the specified Exadata infrastructure.
  • POSTUpdate cloud vm cluster/#X-Amz-Target=Odb.UpdateCloudVmClusterUpdates the properties of the specified VM cluster.

Exadb vm cluster

  • POSTAssociate virtual machines to exadb vm cluster/#X-Amz-Target=Odb.AssociateVirtualMachinesToExadbVmClusterAdds virtual machines to the specified Exascale VM cluster.
  • POSTCreate exadb vm cluster/#X-Amz-Target=Odb.CreateExadbVmClusterCreates an Exascale VM cluster.
  • POSTDelete exadb vm cluster/#X-Amz-Target=Odb.DeleteExadbVmClusterDeletes the specified Exascale VM cluster.
  • POSTDisassociate virtual machines from exadb vm cluster/#X-Amz-Target=Odb.DisassociateVirtualMachinesFromExadbVmClusterRemoves virtual machines from the specified Exascale VM cluster.
  • POSTGet exadb vm cluster/#X-Amz-Target=Odb.GetExadbVmClusterReturns information about the specified Exascale VM cluster.
  • POSTList exadb vm clusters/#X-Amz-Target=Odb.ListExadbVmClustersReturns information about the Exascale VM clusters owned by your Amazon Web Services account.
  • POSTUpdate exadb vm cluster/#X-Amz-Target=Odb.UpdateExadbVmClusterUpdates the specified Exascale VM cluster.

Autonomous database

  • POSTCreate autonomous database/#X-Amz-Target=Odb.CreateAutonomousDatabaseCreates a new Autonomous Database.
  • POSTCreate autonomous database wallet/#X-Amz-Target=Odb.CreateAutonomousDatabaseWalletCreates a new wallet for the specified Autonomous Database.
  • POSTDelete autonomous database/#X-Amz-Target=Odb.DeleteAutonomousDatabaseDeletes the specified Autonomous Database.
  • POSTFailover autonomous database/#X-Amz-Target=Odb.FailoverAutonomousDatabaseInitiates a failover of the specified Autonomous Database to a standby peer database.
  • POSTGet autonomous database/#X-Amz-Target=Odb.GetAutonomousDatabaseGets information about a specific Autonomous Database.
  • POSTGet autonomous database wallet details/#X-Amz-Target=Odb.GetAutonomousDatabaseWalletDetailsGets the wallet details for the specified Autonomous Database.
  • POSTList autonomous database clones/#X-Amz-Target=Odb.ListAutonomousDatabaseClonesLists the clones of the specified Autonomous Database.
  • POSTList autonomous database peers/#X-Amz-Target=Odb.ListAutonomousDatabasePeersLists the peer databases of the specified Autonomous Database.
  • POSTList autonomous databases/#X-Amz-Target=Odb.ListAutonomousDatabasesReturns information about the Autonomous Databases owned by your Amazon Web Services account in the current Amazon Web Services Region.
  • POSTReboot autonomous database/#X-Amz-Target=Odb.RebootAutonomousDatabaseReboots the specified Autonomous Database.
  • POSTRestore autonomous database/#X-Amz-Target=Odb.RestoreAutonomousDatabaseRestores the specified Autonomous Database to a point in time.
  • POSTShrink autonomous database/#X-Amz-Target=Odb.ShrinkAutonomousDatabaseShrinks the storage of the specified Autonomous Database to reclaim unused space.
  • POSTStart autonomous database/#X-Amz-Target=Odb.StartAutonomousDatabaseStarts the specified Autonomous Database.
  • POSTStop autonomous database/#X-Amz-Target=Odb.StopAutonomousDatabaseStops the specified Autonomous Database.
  • POSTSwitchover autonomous database/#X-Amz-Target=Odb.SwitchoverAutonomousDatabasePerforms a switchover of the specified Autonomous Database to a standby peer database.
  • POSTUpdate autonomous database/#X-Amz-Target=Odb.UpdateAutonomousDatabaseUpdates the properties of an Autonomous Database.

Autonomous database backup

  • POSTCreate autonomous database backup/#X-Amz-Target=Odb.CreateAutonomousDatabaseBackupCreates a new backup of the specified Autonomous Database.
  • POSTDelete autonomous database backup/#X-Amz-Target=Odb.DeleteAutonomousDatabaseBackupDeletes the specified Autonomous Database backup.
  • POSTGet autonomous database backup/#X-Amz-Target=Odb.GetAutonomousDatabaseBackupGets information about a specific Autonomous Database backup.
  • POSTList autonomous database backups/#X-Amz-Target=Odb.ListAutonomousDatabaseBackupsLists the backups of the specified Autonomous Database.
  • POSTUpdate autonomous database backup/#X-Amz-Target=Odb.UpdateAutonomousDatabaseBackupUpdates the properties of an Autonomous Database backup.

Cloud autonomous vm cluster

  • POSTCreate cloud autonomous vm cluster/#X-Amz-Target=Odb.CreateCloudAutonomousVmClusterCreates a new Autonomous VM cluster in the specified Exadata infrastructure.
  • POSTDelete cloud autonomous vm cluster/#X-Amz-Target=Odb.DeleteCloudAutonomousVmClusterDeletes an Autonomous VM cluster.
  • POSTGet cloud autonomous vm cluster/#X-Amz-Target=Odb.GetCloudAutonomousVmClusterGets information about a specific Autonomous VM cluster.
  • POSTList autonomous virtual machines/#X-Amz-Target=Odb.ListAutonomousVirtualMachinesLists all Autonomous VMs in an Autonomous VM cluster.
  • POSTList cloud autonomous vm clusters/#X-Amz-Target=Odb.ListCloudAutonomousVmClustersLists all Autonomous VM clusters in a specified Cloud Exadata infrastructure.
  • POSTUpdate cloud autonomous vm cluster/#X-Amz-Target=Odb.UpdateCloudAutonomousVmClusterUpdates the properties of the specified Autonomous VM cluster.

Cloud exadata infrastructure

  • POSTCreate cloud exadata infrastructure/#X-Amz-Target=Odb.CreateCloudExadataInfrastructureCreates an Exadata infrastructure.
  • POSTDelete cloud exadata infrastructure/#X-Amz-Target=Odb.DeleteCloudExadataInfrastructureDeletes the specified Exadata infrastructure. Before you use this operation, make sure to delete all of the VM clusters that are hosted on this Exadata…
  • POSTGet cloud exadata infrastructure/#X-Amz-Target=Odb.GetCloudExadataInfrastructureReturns information about the specified Exadata infrastructure.
  • POSTGet cloud exadata infrastructure unallocated resources/#X-Amz-Target=Odb.GetCloudExadataInfrastructureUnallocatedResourcesRetrieves information about unallocated resources in a specified Cloud Exadata Infrastructure.
  • POSTGet db server/#X-Amz-Target=Odb.GetDbServerReturns information about the specified database server.
  • POSTList cloud exadata infrastructures/#X-Amz-Target=Odb.ListCloudExadataInfrastructuresReturns information about the Exadata infrastructures owned by your Amazon Web Services account.
  • POSTList db servers/#X-Amz-Target=Odb.ListDbServersReturns information about the database servers that belong to the specified Exadata infrastructure.
  • POSTUpdate cloud exadata infrastructure/#X-Amz-Target=Odb.UpdateCloudExadataInfrastructureUpdates the properties of an Exadata infrastructure resource.
  • POSTUpdate cloud exadata infrastructure storage capacity/#X-Amz-Target=Odb.UpdateCloudExadataInfrastructureStorageCapacityAdds storage capacity to the specified Exadata infrastructure.
  • POSTUpdate exascale cloud exadata infrastructure/#X-Amz-Target=Odb.UpdateExascaleCloudExadataInfrastructureConfigures or updates the Exascale storage on an Exadata infrastructure. After you configure Exascale storage, you can create Exascale storage vaults on the…

Exascale db storage vault

  • POSTCreate exascale db storage vault/#X-Amz-Target=Odb.CreateExascaleDbStorageVaultCreates an Exascale storage vault. To create the Exascale storage vault on dedicated Exadata infrastructure, specify cloudExadataInfrastructureId .
  • POSTDelete exascale db storage vault/#X-Amz-Target=Odb.DeleteExascaleDbStorageVaultDeletes the specified Exascale storage vault.
  • POSTGet exascale db storage vault/#X-Amz-Target=Odb.GetExascaleDbStorageVaultReturns information about the specified Exascale storage vault.
  • POSTList exascale db storage vaults/#X-Amz-Target=Odb.ListExascaleDbStorageVaultsReturns information about the Exascale storage vaults owned by your Amazon Web Services account.
  • POSTUpdate exascale db storage vault/#X-Amz-Target=Odb.UpdateExascaleDbStorageVaultUpdates the specified Exascale storage vault.

Odb network

  • POSTCreate odb network/#X-Amz-Target=Odb.CreateOdbNetworkCreates an ODB network.
  • POSTDelete odb network/#X-Amz-Target=Odb.DeleteOdbNetworkDeletes the specified ODB network.
  • POSTGet odb network/#X-Amz-Target=Odb.GetOdbNetworkReturns information about the specified ODB network.
  • POSTList odb networks/#X-Amz-Target=Odb.ListOdbNetworksReturns information about the ODB networks owned by your Amazon Web Services account.
  • POSTUpdate odb network/#X-Amz-Target=Odb.UpdateOdbNetworkUpdates properties of a specified ODB network.

Odb peering connection

  • POSTCreate odb peering connection/#X-Amz-Target=Odb.CreateOdbPeeringConnectionCreates a peering connection between an ODB network and a VPC. A peering connection enables private connectivity between the networks for application-tier…
  • POSTDelete odb peering connection/#X-Amz-Target=Odb.DeleteOdbPeeringConnectionDeletes an ODB peering connection. When you delete an ODB peering connection, the underlying VPC peering connection is also deleted.
  • POSTGet odb peering connection/#X-Amz-Target=Odb.GetOdbPeeringConnectionRetrieves information about an ODB peering connection.
  • POSTList odb peering connections/#X-Amz-Target=Odb.ListOdbPeeringConnectionsLists all ODB peering connections or those associated with a specific ODB network.
  • POSTUpdate odb peering connection/#X-Amz-Target=Odb.UpdateOdbPeeringConnectionModifies the settings of an Oracle Database@Amazon Web Services peering connection. You can update the display name and add or remove CIDR blocks from the…

Db node

  • POSTGet db node/#X-Amz-Target=Odb.GetDbNodeReturns information about the specified DB node.
  • POSTList db nodes/#X-Amz-Target=Odb.ListDbNodesReturns information about the DB nodes for the specified VM cluster.
  • POSTReboot db node/#X-Amz-Target=Odb.RebootDbNodeReboots the specified DB node in a VM cluster.
  • POSTStart db node/#X-Amz-Target=Odb.StartDbNodeStarts the specified DB node in a VM cluster.
  • POSTStop db node/#X-Amz-Target=Odb.StopDbNodeStops the specified DB node in a VM cluster.
  • POSTAccept marketplace registration/#X-Amz-Target=Odb.AcceptMarketplaceRegistrationRegisters the Amazon Web Services Marketplace token for your Amazon Web Services account to activate your Oracle Database@Amazon Web Services subscription.
  • POSTAssociate iam role to resource/#X-Amz-Target=Odb.AssociateIamRoleToResourceAssociates an Amazon Web Services Identity and Access Management (IAM) service role with a specified resource to enable Amazon Web Services service integration.
  • POSTDisassociate iam role from resource/#X-Amz-Target=Odb.DisassociateIamRoleFromResourceDisassociates an Amazon Web Services Identity and Access Management (IAM) service role from a specified resource to disable Amazon Web Services service…
  • POSTGet oci onboarding status/#X-Amz-Target=Odb.GetOciOnboardingStatusReturns the tenancy activation link and onboarding status for your Amazon Web Services account.
  • POSTInitialize service/#X-Amz-Target=Odb.InitializeServiceInitializes the ODB service for the first time in an account.
  • POSTList autonomous database character sets/#X-Amz-Target=Odb.ListAutonomousDatabaseCharacterSetsLists the available character sets for Autonomous Databases.
  • POSTList autonomous database versions/#X-Amz-Target=Odb.ListAutonomousDatabaseVersionsLists the available Oracle Database software versions for Autonomous Databases.
  • POSTList db system shapes/#X-Amz-Target=Odb.ListDbSystemShapesReturns information about the shapes that are available for an Exadata infrastructure.
  • POSTList flex components/#X-Amz-Target=Odb.ListFlexComponentsReturns information about the flex components that are available for an Exadata infrastructure.
  • POSTList gi minor versions/#X-Amz-Target=Odb.ListGiMinorVersionsReturns a list of the Oracle Grid Infrastructure (GI) minor versions for the specified major version.
  • POSTList gi versions/#X-Amz-Target=Odb.ListGiVersionsReturns information about Oracle Grid Infrastructure (GI) software versions that are available for a VM cluster for the specified shape.
  • POSTList system versions/#X-Amz-Target=Odb.ListSystemVersionsReturns information about the system versions that are available for a VM cluster for the specified giVersion and shape .
  • POSTList tags for resource/#X-Amz-Target=Odb.ListTagsForResourceReturns information about the tags applied to this resource.
  • POSTTag resource/#X-Amz-Target=Odb.TagResourceApplies tags to the specified resource.
  • POSTUntag resource/#X-Amz-Target=Odb.UntagResourceRemoves tags from the specified resource.

API details

Base URL
https://odb.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
86 operations on 86 pathsPOST 86
Main resources
Autonomous database 16Cloud exadata infrastructure 10Cloud vm cluster 7Exadb vm cluster 7Cloud autonomous vm cluster 6Autonomous database backup 5Db node 5Exascale db storage vault 5Odb network 5Odb peering connection 5
Description format
AWS Smithy model, API version 2024-08-20

How to test the odb in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the odb collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate virtual machines to cloud vm cluster” (POST /#X-Amz-Target=Odb.AssociateVirtualMachinesToCloudVmCluster), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the odb?

Oracle Database@Amazon Web Services is an offering that enables you to access Oracle Exadata infrastructure managed by Oracle Cloud Infrastructure (OCI)… It is listed under Developer tools and has 86 endpoints.

Who publishes the odb?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the odb?

Requests go to https://odb.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the odb?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the odb have?

86 operations on 86 paths (86 POST). The largest groups are Autonomous database, Cloud exadata infrastructure, Cloud vm cluster, Exadb vm cluster.

Is forking the odb free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.