Oracle Cloud Infrastructure Documentation

Manage the Connections for External Database

This topic provides information about managing external database connections using the Console and API. The external database connection resource enables you to connect an external database handle to an Oracle Database instance located outside of OCI.

Note

Currently the External Database service supports only Management Agent Cloud Service (MACS) agents for creating a connection to your external databases. Enterprise Manager Cloud Control Agents are not supported at this time. For more information about MACS, see Management Agent.

Required IAM Policy

To use Oracle Cloud Infrastructure, you must be granted security access in a policy by an administrator. This access is required whether you're using the Console or the REST API with an SDK, CLI, or other tool. If you get a message that you don't have permission or are unauthorized, verify with your administrator what type of access you have and which compartment to work in.

For administrators: The policy in Let database admins manage Oracle Cloud external database resources lets the specified group do everything with databases and related database resources.

If you're new to policies, see Getting Started with Policies and Common Policies. For more information about writing policies for databases, see Policy Details for External Database.

Check the Connection Status of an External Database connection

Perform the following steps to check the connection status of an external database connection.

  1. Open the navigation menu, select Oracle Database, and then select External Database.
  2. Under External Database, select either Pluggable Databases, Container Databases, or Non-Container Databases depending on the type of external database you are using.
  3. All external databases in the selected compartment are displayed in a table. To view the external databases in a different compartment, use the Compartment filter to switch compartments.
  4. On the External databases list page, select the external database for which you want to check the connection status. Details of the external database you selected are displayed.
  5. On the external database details page, select the Connectors tab. A list of external database connections is displayed.
  6. In the list of external database connections, select the name of the connection for which you want to check the status. Details of the connection you selected are displayed.
  7. On the external connector details page, under External connection information tab, under Connection information section, select Check connection status and confirm when prompted. A Check connection status work request is created.
  8. Select work request name to see details of the connection status.

For more information about work requests, see Work Requests.

Update the Connection Credentials of an External Database Connection

Perform the following steps to update the connection credentials of an external database connection.

  1. Open the navigation menu, select Oracle Database, and then select External Database.
  2. Under External Database, select either Pluggable Databases, Container Databases, or Non-Container Databases depending on the type of external database you are using.
  3. All external databases in the selected compartment are displayed in a table. To view the external databases in a different compartment, use the Compartment filter to switch compartments.
  4. On the External databases list page, select the external database connection you want to update. Details of the external database you selected are displayed.
  5. On the external database details page, select the Connectors tab. A list of external database connections is displayed.
  6. In the list of external database connections, select the name of the connection you want to update. Details of the connection you selected are displayed.
  7. On the external connector details page, select Update connection credentials.
  8. In the Update connection credentials panel, enter the following details:
  9. Credential name: (Read-only) Credential name of the connection.
  10. Username: Provide the user name for the database credentials to be used by this connection.
  11. Password: Provide the password for the database credentials to be used by this connection.
  12. Role: Provide the role for the database credentials to be used by this connection. You can select between NORMAL and SYSDBA.
  13. Secret: Enter a secret for the database credentials to be used by this connection (if the connector was created using TCPS).
    • Select either Select a new secret or Modify current secret.
    • If you select Select a new secret, use the menu to display the existing secrets and select the required secret name.
    • If you select Modify current secret, the Modify current secret dialog box is displayed.
    • Enter the following SSL information:
      • SSL Trust Store Type: Type of the SSL trust store. Available options are PKCS12 and JKS. BCFKS is the only available option in US government regions.
      • SSL Trust Store Location: Fully qualified path of the SSL trust store on the agent host.
      • SSL Trust Store Password: Password of the SSL trust store.
      • SSL Key Store Type: [Read-only] Type of the key store. It is automatically chosen to be the same as the SSL trust store type.
      • SSL Key Store Location: Fully qualified path of the key store on the agent host.
      • SSL Key Store Password: Password of the key store.
      • SSL Server Certificate Distinguished Name: Unique name for the SSL server certificate.
    • Select Modify current secret.
  14. Select Save.

Update the Connection Strings of an External Database Connection

Perform the following steps to update the connection strings of an external database connection.

  1. Open the navigation menu, select Oracle Database, and then select External Database.
  2. Under External Database, select either Pluggable Databases, Container Databases, or Non-Container Databases depending on the type of external database you are using.
  3. All external databases in the selected compartment are displayed in a table. To view the external databases in a different compartment, use the Compartment filter to switch compartments.
  4. On the External databases list page, select the external database connection you want to update. Details of the external database you selected are displayed.
  5. On the external database details page, select the Connectors tab. A list of external database connections is displayed.
  6. In the list of external database connections, select the name of the connection you want to update. Details of the connection you selected are displayed.
  7. In the External connector details panel, select Update connection strings.
  8. In the Update connection strings panel, enter the following details:
  9. DNS hostname or SCAN name: Provide virtual IP (VIP) address or single client access name (SCAN) for the database on your premises that you are connecting to the OCI.
  10. Port: Provide the port being used by the database outside OCI for database connections.
  11. Service: Provide the service name being used by the database outside OCI for database connections.
  12. Protocol: (Read-only) The protocol that was set when you created the connection. This cannot be altered.
  13. Select Save.

Delete an External Database Connection

Perform the following steps to delete an external database connection.

  1. Open the navigation menu, select Oracle Database, and then select External Database.
  2. Under External Database, select either Pluggable Databases, Container Databases, or Non-Container Databases depending on the type of external database you are using.
  3. All external databases in the selected compartment are displayed in a table. To view the external databases in a different compartment, use the Compartment filter to switch compartments.
  4. On the External databases list page, select the external database connection you want to delete. Details of the external database you selected are displayed.
  5. On the external database details page, select the Connectors tab. A list of external database connections is displayed.
  6. In the list of external database connections, select the name of the connection you want to delete. Details of the connection you selected are displayed.
  7. In the External connector details panel, select Delete and confirm.

Use the API

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.

Use these API operations to manage external database connections:

  • ListExternalDatabaseConnectors
  • GetExternalDatabaseConnector
  • CheckExternalDatabaseConnectorConnectionStatus
  • UpdateExternalDatabaseConnector
  • DeleteExternalDatabaseConnector

For the complete list of APIs for the Database service, see Database Service API.