Oracle Cloud Infrastructure Documentation

Manage the Associated Services for External Database

You can use the OCI Console or API to enable or disable services for external databases including Database Management, Operations Insights, and Stack Monitoring.

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.

Enable an Associated Service for an External Database

Perform the following steps to enable an associated service for an external database.

  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. Select your Compartment. A list of external databases is displayed.
  4. In the list of external databases, click the name of the database for which you want to enable an associated service. Details of the external database you selected are displayed.
  5. On the External database details page, in the External database information tab, under the Associated services, a list of associated services is displayed.
  6. Click Enable.
  7. The Enable Database Management (Diagnostics & Management) window appears.
  8. Select an external database connector from the drop-down list.
  9. Choose a license type: The type of license you want to use. Your choice affects metering for billing.
    • Bring Your Own License (BYOL) means you will use your organization's Oracle Database Diagnostics and Tuning pack licenses for this service.
    • License included will subscribe to Oracle Database Management (Diagnostics & Management) for this external database using new software licenses.
  10. Click Enable.

Disable an Associated Service for an External Database

Perform the following steps to disable an associated service for an external database.

  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. Select your Compartment. A list of external databases is displayed.
  4. In the list of external databases, click the name of the database for which you want to disable an associated service. Details of the external database you selected are displayed.
  5. On the External database details page, in the External database information tab, under the Associated services, a list of associated services is displayed.
  6. Click Disable.

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 enable or disable associated services for external databases:

Database Management

  • EnableExternalContainerDatabaseDatabaseManagement
  • DisableExternalContainerDatabaseDatabaseManagement
  • EnableExternalPluggableDatabaseDatabaseManagement
  • DisableExternalPluggableDatabaseDatabaseManagement
  • EnableExternalNonContainerDatabaseDatabaseManagement
  • DisableExternalNonContainerDatabaseDatabaseManagement

Operations Insights

  • EnableExternalPluggableDatabaseOperationsInsights
  • DisableExternalPluggableDatabaseOperationsInsights
  • EnableExternalNonContainerDatabaseOperationsInsights
  • DisableExternalNonContainerDatabaseOperationsInsights

Application Performance Monitoring

  • EnableExternalContainerDatabaseStackMonitoring
  • DisableExternalContainerDatabaseStackMonitoring
  • EnableExternalPluggableDatabaseStackMonitoring
  • DisableExternalPluggableDatabaseStackMonitoring
  • EnableExternalNonContainerDatabaseStackMonitoring
  • DisableExternalNonContainerDatabaseStackMonitoring

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