Oracle Db Management API
The dbManagement API from Oracle — 231 operation(s) for dbmanagement.
Oracle Db Management API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include dbManagement. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 304 operations across 231 paths, and defines 496 schemas. It is described by OpenAPI 3.2.0, at version 20201101.
Requests are made against 2 base URLs: http://dbmgmt.{region}.oci.oraclecloud.com/20201101, https://dbmgmt.{region}.oci.oraclecloud.com/20201101.
304 operations
231 paths
496 schemas
17 DELETE158 GET2 PATCH90 POST37 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 304
Across 231 paths, the API surfaces 304 operations — 17 DELETE, 158 GET, 2 PATCH, 90 POST, 37 PUT. Each is listed below with its method, path, parameters, and response codes.
dbManagement 304
POST
/autonomousDatabases/{autonomousDatabaseId}/actions/disableDatabaseManagement
Disables Database Management feature for a database.
POST
/autonomousDatabases/{autonomousDatabaseId}/actions/enableDatabaseManagement
Enables Database Management feature for the Autonomous Database.
POST
/autonomousDatabases/{autonomousDatabaseId}/actions/modifyDatabaseManagement
Modifies Database Management feature for the Autonomous Database.
GET
/cloudAsmInstances
Lists the cloud ASM instances.
GET
/cloudAsmInstances/{cloudAsmInstanceId}
Gets the cloud ASM instance details.
PUT
/cloudAsmInstances/{cloudAsmInstanceId}
Updates a cloud ASM instance.
GET
/cloudAsms
Lists the cloud ASMs.
GET
/cloudAsms/{cloudAsmId}
Gets the cloud ASM details.
PUT
/cloudAsms/{cloudAsmId}
Updates a cloud ASM.
GET
/cloudAsms/{cloudAsmId}/configuration
Gets the cloud ASM configuration.
GET
/cloudAsms/{cloudAsmId}/diskGroups
Lists the cloud ASM disk groups.
GET
/cloudAsms/{cloudAsmId}/metrics
Gets the cloud ASM metrics.
GET
/cloudAsms/{cloudAsmId}/users
Lists the cloud ASM users.
GET
/cloudClusterInstances
Lists the cloud cluster instances.
GET
/cloudClusterInstances/{cloudClusterInstanceId}
Gets the cloud cluster instance details.
PUT
/cloudClusterInstances/{cloudClusterInstanceId}
Updates a cloud cluster instance.
GET
/cloudClusters
Lists the cloud clusters.
GET
/cloudClusters/{cloudClusterId}
Gets the cloud cluster details.
PUT
/cloudClusters/{cloudClusterId}
Updates a cloud cluster.
GET
/cloudClusters/{cloudClusterId}/metrics
Gets the cloud cluster metrics.
GET
/cloudDatabases
Lists the cloud databases in a cloud database system.
GET
/cloudDbHomes
Lists the cloud DB homes.
GET
/cloudDbHomes/{cloudDbHomeId}
Gets the cloud DB home details.
PUT
/cloudDbHomes/{cloudDbHomeId}
Updates a cloud DB home.
GET
/cloudDbNodes
Lists the cloud DB nodes.
GET
/cloudDbNodes/{cloudDbNodeId}
Gets the cloud DB node details.
PUT
/cloudDbNodes/{cloudDbNodeId}
Updates a cloud DB node.
GET
/cloudDbNodes/{cloudDbNodeId}/metrics
Gets the cloud DB nodemetrics.
GET
/cloudDbSystemConnectors
Lists the cloud connectors.
POST
/cloudDbSystemConnectors
Creates a cloud connector.
DELETE
/cloudDbSystemConnectors/{cloudDbSystemConnectorId}
Deletes the cloud connector.
GET
/cloudDbSystemConnectors/{cloudDbSystemConnectorId}
Gets the cloud connector details.
PUT
/cloudDbSystemConnectors/{cloudDbSystemConnectorId}
Updates a cloud connector.
POST
/cloudDbSystemConnectors/{cloudDbSystemConnectorId}/actions/checkConnectionStatus
Checks the connectivity status of a cloud connector.
GET
/cloudDbSystemDiscoveries
Lists the cloud DB system discovery resources.
POST
/cloudDbSystemDiscoveries
Creates a cloud DB system discovery resource.
DELETE
/cloudDbSystemDiscoveries/{cloudDbSystemDiscoveryId}
Deletes the cloud DB system discovery resource.
GET
/cloudDbSystemDiscoveries/{cloudDbSystemDiscoveryId}
Gets the cloud DB system discovery details.
PATCH
/cloudDbSystemDiscoveries/{cloudDbSystemDiscoveryId}
Updates a cloud DB system discovery.
PUT
/cloudDbSystemDiscoveries/{cloudDbSystemDiscoveryId}
Updates a cloud DB system discovery.
GET
/cloudDbSystems
Lists the cloud DB systems.
POST
/cloudDbSystems
Creates a cloud DB system.
DELETE
/cloudDbSystems/{cloudDbSystemId}
Deletes the cloud DB system.
GET
/cloudDbSystems/{cloudDbSystemId}
Gets the cloud DB system details.
PUT
/cloudDbSystems/{cloudDbSystemId}
Updates a cloud DB system.
POST
/cloudDbSystems/{cloudDbSystemId}/actions/disableDatabaseManagement
Disables Database Management service for the cloud DB system.
POST
/cloudDbSystems/{cloudDbSystemId}/actions/disableStackMonitoring
Disables Stack monitoring service for the cloud DB system.
POST
/cloudDbSystems/{cloudDbSystemId}/actions/enableDatabaseManagement
Enables Database Management service for the cloud DB system.
POST
/cloudDbSystems/{cloudDbSystemId}/actions/enableStackMonitoring
Enables Stack Monitoring service for the cloud DB system.
GET
/cloudDbSystems/{cloudDbSystemId}/availabilityMetrics
Gets availability metrics for the cloud DB system components.
GET
/cloudExadataInfrastructures
Lists the Exadata infrastructures.
POST
/cloudExadataInfrastructures
Creates an OCI resource for the Exadata infrastructure.
POST
/cloudExadataInfrastructures/actions/discoverExadataInfrastructure
Start the discovery process for Exadata system infrastructure from the specified agent.
DELETE
/cloudExadataInfrastructures/{cloudExadataInfrastructureId}
Deletes the Exadata infrastructure.
GET
/cloudExadataInfrastructures/{cloudExadataInfrastructureId}
Gets the Exadata infrastructure details.
PUT
/cloudExadataInfrastructures/{cloudExadataInfrastructureId}
Update the Exadata infrastructure.
POST
/cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/changeCompartment
Moves the Exadata infrastructure and its resources to a different compartment.
POST
/cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/disableDatabaseManagement
Disables Database Management for the Exadata infrastructure.
POST
/cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/enableDatabaseManagement
Enables Database Management for the Exadata infrastructure.
GET
/cloudExadataStorageConnectors
Lists the connectors.
POST
/cloudExadataStorageConnectors
Creates an Exadata storage server connector.
DELETE
/cloudExadataStorageConnectors/{cloudExadataStorageConnectorId}
Deletes the exadata connector.
GET
/cloudExadataStorageConnectors/{cloudExadataStorageConnectorId}
Gets the Exadata storage server connector details.
PUT
/cloudExadataStorageConnectors/{cloudExadataStorageConnectorId}
Updates an Exadata storage server connector.
POST
/cloudExadataStorageConnectors/{cloudExadataStorageConnectorId}/actions/checkStatus
Checks the connectivity status of the Exadata storage server connection.
GET
/cloudExadataStorageGrids/{cloudExadataStorageGridId}
Gets the Exadata storage server grid details.
PUT
/cloudExadataStorageGrids/{cloudExadataStorageGridId}
Updates the Exadata storage server grid details.
GET
/cloudExadataStorageServers
Lists the exadata storage servers.
GET
/cloudExadataStorageServers/{cloudExadataStorageServerId}
Gets the Exadata storage server summary.
PUT
/cloudExadataStorageServers/{cloudExadataStorageServerId}
Updates the Exadata storage server.
GET
/cloudExadataStorageServers/{cloudExadataStorageServerId}/iormPlan
Gets the IORM plan from the specified Exadata storage server.
GET
/cloudExadataStorageServers/{cloudExadataStorageServerId}/openAlertHistory
Get open alerts from the specific Exadata storage server.
GET
/cloudListeners
Lists the cloud listeners.
GET
/cloudListeners/{cloudListenerId}
Gets the cloud listener details.
PUT
/cloudListeners/{cloudListenerId}
Updates a cloud listener.
GET
/cloudListeners/{cloudListenerId}/metrics
Gets the cloud listener metrics.
GET
/cloudListeners/{cloudListenerId}/services
Lists the database services registered with the cloud listener.
GET
/databaseFleetBackupMetrics
Gets the health metrics for a fleet of databases.
GET
/databaseFleetDataguardMetrics
Gets the dataguard enabled databases in fleet with dataguard metrics.
GET
/databaseFleetHaOverviewMetrics
Gets the list fleet databases with HA and backup metrics.
GET
/databaseHomeMetrics
Gets a summary of the activity and resource usage metrics for a Managed Database.
POST
/databases/{databaseId}/actions/disableDatabaseManagement
Disables Database Management feature for a database.
POST
/databases/{databaseId}/actions/enableDatabaseManagement
Enables Database Management feature for the Oracle cloud Database.
POST
/databases/{databaseId}/actions/modifyDatabaseManagement
Modifies Database Management feature for the cloud Database.
GET
/dbManagementPrivateEndpoints
Gets a list of Database Management private endpoints.
POST
/dbManagementPrivateEndpoints
Creates a new Database Management private endpoint.
DELETE
/dbManagementPrivateEndpoints/{dbManagementPrivateEndpointId}
Deletes a specific Database Management private endpoint.
GET
/dbManagementPrivateEndpoints/{dbManagementPrivateEndpointId}
Gets the details of a specific Database Management private endpoint.
PUT
/dbManagementPrivateEndpoints/{dbManagementPrivateEndpointId}
Updates one or more attributes of a specific Database Management private endpoint.
POST
/dbManagementPrivateEndpoints/{dbManagementPrivateEndpointId}/actions/changeCompartment
Moves the Database Management private endpoint and its dependent resources to the specified compartment.
GET
/dbManagementPrivateEndpoints/{dbManagementPrivateEndpointId}/associatedDatabases
Gets the list of databases using a specific Database Management private endpoint.
GET
/exadataInfrastructureFleetMetrics
Gets the health metrics for a fleet of Exadata infrastructure.
GET
/externalAsmInstances
Lists the external ASM instances.
GET
/externalAsmInstances/{externalAsmInstanceId}
Gets the external ASM instance details.
PUT
/externalAsmInstances/{externalAsmInstanceId}
Updates an external ASM instance.
GET
/externalAsms
Lists the external ASMs.
GET
/externalAsms/{externalAsmId}
Gets the external ASM details.
PUT
/externalAsms/{externalAsmId}
Updates an external ASM.
GET
/externalAsms/{externalAsmId}/configuration
Gets the external ASM configuration.
GET
/externalAsms/{externalAsmId}/diskGroups
Lists the external ASM disk groups.
GET
/externalAsms/{externalAsmId}/metrics
Gets the external ASM metrics.
GET
/externalAsms/{externalAsmId}/users
Lists the external ASM users.
GET
/externalClusterInstances
Lists the external cluster instances.
GET
/externalClusterInstances/{externalClusterInstanceId}
Gets the external cluster instance details.
PUT
/externalClusterInstances/{externalClusterInstanceId}
Updates an external cluster instance.
GET
/externalClusters
Lists the external clusters.
GET
/externalClusters/{externalClusterId}
Gets the external cluster details.
PUT
/externalClusters/{externalClusterId}
Updates an external cluster.
GET
/externalClusters/{externalClusterId}/metrics
Gets the external cluster metrics.
GET
/externalDatabases
Lists the external databases.
GET
/externalDbHomes
Lists the external DB homes.
GET
/externalDbHomes/{externalDbHomeId}
Gets the external DB home details.
PUT
/externalDbHomes/{externalDbHomeId}
Updates an external DB home.
GET
/externalDbNodes
Lists the external DB nodes.
GET
/externalDbNodes/{externalDbNodeId}
Gets the external DB node details.
PUT
/externalDbNodes/{externalDbNodeId}
Updates an external DB node.
GET
/externalDbNodes/{externalDbNodeId}/metrics
Gets the external DB nodemetrics.
GET
/externalDbSystemConnectors
Lists the external connectors.
POST
/externalDbSystemConnectors
Creates an external connector.
DELETE
/externalDbSystemConnectors/{externalDbSystemConnectorId}
Deletes the external connector.
GET
/externalDbSystemConnectors/{externalDbSystemConnectorId}
Gets the external connector details.
PUT
/externalDbSystemConnectors/{externalDbSystemConnectorId}
Updates an external connector.
POST
/externalDbSystemConnectors/{externalDbSystemConnectorId}/actions/checkConnectionStatus
Checks the connectivity status of an external connector.
GET
/externalDbSystemDiscoveries
Lists the external DB system discovery resources.
POST
/externalDbSystemDiscoveries
Creates an external DB system discovery resource.
DELETE
/externalDbSystemDiscoveries/{externalDbSystemDiscoveryId}
Deletes the external DB system discovery resource.
GET
/externalDbSystemDiscoveries/{externalDbSystemDiscoveryId}
Gets the external DB system discovery details.
PATCH
/externalDbSystemDiscoveries/{externalDbSystemDiscoveryId}
Updates an external DB system discovery.
PUT
/externalDbSystemDiscoveries/{externalDbSystemDiscoveryId}
Updates an external DB system discovery.
GET
/externalDbSystems
Lists the external DB systems.
POST
/externalDbSystems
Creates an external DB system.
DELETE
/externalDbSystems/{externalDbSystemId}
Deletes the external DB system.
GET
/externalDbSystems/{externalDbSystemId}
Gets the external DB system details.
PUT
/externalDbSystems/{externalDbSystemId}
Updates an external DB system.
POST
/externalDbSystems/{externalDbSystemId}/actions/changeCompartment
Moves an external DB system to a different compartment.
POST
/externalDbSystems/{externalDbSystemId}/actions/disableDatabaseManagement
Disables Database Management service for the external DB system.
POST
/externalDbSystems/{externalDbSystemId}/actions/disableStackMonitoring
Disables Stack monitoring service for the external DB system.
POST
/externalDbSystems/{externalDbSystemId}/actions/enableDatabaseManagement
Enables Database Management service for the external DB system.
POST
/externalDbSystems/{externalDbSystemId}/actions/enableStackMonitoring
Enables Stack Monitoring service for the external DB system.
GET
/externalDbSystems/{externalDbSystemId}/availabilityMetrics
Gets availability metrics for the external DB system components.
GET
/externalExadataInfrastructures
Lists the external Exadata infrastructures.
POST
/externalExadataInfrastructures
Creates an OCI resource for the Exadata infrastructure.
POST
/externalExadataInfrastructures/actions/discoverExadataInfrastructure
Start the discovery process for Exadata system infrastructure from the specified agent.
DELETE
/externalExadataInfrastructures/{externalExadataInfrastructureId}
Deletes the Exadata infrastructure.
GET
/externalExadataInfrastructures/{externalExadataInfrastructureId}
Gets the Exadata infrastructure details.
PUT
/externalExadataInfrastructures/{externalExadataInfrastructureId}
Update the Exadata infrastructure.
POST
/externalExadataInfrastructures/{externalExadataInfrastructureId}/actions/changeCompartment
Moves the Exadata infrastructure and its resources to a different compartment.
POST
/externalExadataInfrastructures/{externalExadataInfrastructureId}/actions/disableDatabaseManagement
Disables Database Management for the Exadata infrastructure.
POST
/externalExadataInfrastructures/{externalExadataInfrastructureId}/actions/enableDatabaseManagement
Enables Database Management for the Exadata infrastructure.
GET
/externalExadataStorageConnectors
Lists the external connectors.
POST
/externalExadataStorageConnectors
Creates an Exadata storage server connector.
DELETE
/externalExadataStorageConnectors/{externalExadataStorageConnectorId}
Deletes the external connector.
GET
/externalExadataStorageConnectors/{externalExadataStorageConnectorId}
Gets the Exadata storage server connector details.
PUT
/externalExadataStorageConnectors/{externalExadataStorageConnectorId}
Updates an Exadata storage server connector.
POST
/externalExadataStorageConnectors/{externalExadataStorageConnectorId}/actions/checkStatus
Checks the connectivity status of the Exadata storage server connection.
GET
/externalExadataStorageGrids/{externalExadataStorageGridId}
Gets the Exadata storage server grid details.
PUT
/externalExadataStorageGrids/{externalExadataStorageGridId}
Updates the Exadata storage server grid details.
GET
/externalExadataStorageServers
Lists the external storage servers.
GET
/externalExadataStorageServers/{externalExadataStorageServerId}
Gets the Exadata storage server summary.
PUT
/externalExadataStorageServers/{externalExadataStorageServerId}
Updates the Exadata storage server.
GET
/externalExadataStorageServers/{externalExadataStorageServerId}/iormPlan
Gets the IORM plan from the specified Exadata storage server.
GET
/externalExadataStorageServers/{externalExadataStorageServerId}/openAlertHistory
Get open alerts from the specific Exadata storage server.
GET
/externalExadataStorageServers/{externalExadataStorageServerId}/topSqlCpuActivity
Get the SQL IDs with top cpu activity from Exadata storage server.
GET
/externalListeners
Lists the external listeners.
GET
/externalListeners/{externalListenerId}
Gets the external listener details.
PUT
/externalListeners/{externalListenerId}
Updates an external listener.
GET
/externalListeners/{externalListenerId}/metrics
Gets the external listener metrics.
GET
/externalListeners/{externalListenerId}/services
Lists the database services registered with the external listener.
GET
/externalMySqlDatabaseConnectorsdeprecated
Lists External MySql Connectors.
POST
/externalMySqlDatabaseConnectorsdeprecated
Creates an external MySQL Database Connector resource.
DELETE
/externalMySqlDatabaseConnectors/{externalMySqlDatabaseConnectorId}deprecated
Delete the External MySQL Database Connector resource.
GET
/externalMySqlDatabaseConnectors/{externalMySqlDatabaseConnectorId}deprecated
Get External MySQL Connector
PUT
/externalMySqlDatabaseConnectors/{externalMySqlDatabaseConnectorId}deprecated
Updates External Mysql Database Connector.
POST
/externalMySqlDatabaseConnectors/{externalMySqlDatabaseConnectorId}/actions/checkConnectionStatusdeprecated
Check the status of the external database connection specified in this connector.
GET
/externalMySqlDatabasesdeprecated
Lists External MySql databases in a given compartment.
POST
/externalMySqlDatabasesdeprecated
Creates an external MySQL database resource.
DELETE
/externalMySqlDatabases/{externalMySqlDatabaseId}deprecated
Delete the External MySQL Database resource.
GET
/externalMySqlDatabases/{externalMySqlDatabaseId}deprecated
Get External MySQL database information.
PUT
/externalMySqlDatabases/{externalMySqlDatabaseId}deprecated
Updates External Mysql Database.
POST
/externalMySqlDatabases/{externalMySqlDatabaseId}/actions/disableDatabaseManagementdeprecated
Disables Database Management for an external MySQL Database.
POST
/externalMySqlDatabases/{externalMySqlDatabaseId}/actions/enableDatabaseManagementdeprecated
Enables Database Management for an external MySQL Database resource.
POST
/externalcontainerdatabases/{externalContainerDatabaseId}/actions/disableDatabaseManagement
Disables Database Management feature for an external container Database.
POST
/externalcontainerdatabases/{externalContainerDatabaseId}/actions/enableDatabaseManagement
Enables Database Management feature for the external Database.
POST
/externalcontainerdatabases/{externalContainerDatabaseId}/actions/modifyDatabaseManagement
Modifies Database Management feature for the external Database.
POST
/externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/disableDatabaseManagement
Disables Database Management feature for an external non-container Database.
POST
/externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/enableDatabaseManagement
Enables a Database Management feature for the external non-container database.
POST
/externalpluggabledatabases/{externalPluggableDatabaseId}/actions/disableDatabaseManagement
Disables Database Management feature for an external pluggable Database.
POST
/externalpluggabledatabases/{externalPluggableDatabaseId}/actions/enableDatabaseManagement
Enables Database Management feature for the external pluggable Database.
GET
/fleetMetrics
Gets the health metrics for a fleet of databases.
GET
/jobExecutions
Lists job executions.
GET
/jobExecutions/{jobExecutionId}
Gets job execution details.
GET
/jobExecutionsStatus
Gets a summary of the status of job executions.
GET
/jobRuns
Lists job runs.
GET
/jobRuns/{jobRunId}
Gets job run details.
GET
/jobs
Lists jobs.
POST
/jobs
Creates a job.
DELETE
/jobs/{jobId}
Deletes a job.
GET
/jobs/{jobId}
Gets job details.
PUT
/jobs/{jobId}
Updates job details.
POST
/jobs/{jobId}/actions/changeCompartment
Moves a job to a different compartment.
GET
/managedDatabaseGroups
Lists Managed Database Groups.
POST
/managedDatabaseGroups
Creates a Managed Database Group.
DELETE
/managedDatabaseGroups/{managedDatabaseGroupId}
Deletes a Managed Database Group.
GET
/managedDatabaseGroups/{managedDatabaseGroupId}
Gets Managed Database Group details.
PUT
/managedDatabaseGroups/{managedDatabaseGroupId}
Updates a Managed Database Group.
POST
/managedDatabaseGroups/{managedDatabaseGroupId}/actions/addManagedDatabase
Adds a Managed Database to a Managed Database Group.
POST
/managedDatabaseGroups/{managedDatabaseGroupId}/actions/changeCompartment
Moves a Managed Database Group.
POST
/managedDatabaseGroups/{managedDatabaseGroupId}/actions/removeManagedDatabase
Removes a Managed Database from a Managed Database Group.
GET
/managedDatabases
Lists Managed Databases.
GET
/managedDatabases/{managedDatabaseId}
Gets Managed Database details.
PUT
/managedDatabases/{managedDatabaseId}
Updates Managed Database details.
POST
/managedDatabases/{managedDatabaseId}/actions/changeDatabaseParameters
Changes database parameter values.
POST
/managedDatabases/{managedDatabaseId}/actions/generateAwrSnapshot
Creates an AWR snapshot for the target database.
POST
/managedDatabases/{managedDatabaseId}/actions/resetDatabaseParameters
Resets database parameter values.
POST
/managedDatabases/{managedDatabaseId}/actions/runHistoricAddm
Creates and executes a historic ADDM task using the specified AWR snapshot IDs.
GET
/managedDatabases/{managedDatabaseId}/addmTasks
Lists the ADDM tasks who's end snapshot time falls within the provided time range.
GET
/managedDatabases/{managedDatabaseId}/asmProperties
Gets a list of ASM properties for a Managed Database.
GET
/managedDatabases/{managedDatabaseId}/availabilityMetrics
Gets availability metrics of given managed database.
GET
/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
Summarizes AWR snapshot ranges.
GET
/managedDatabases/{managedDatabaseId}/awrDbs
Gets a list of AWR database information.
GET
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbCpuUsages
Summarizes AWR CPU usage data.
GET
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbMetrics
Summarizes metric samples for the specified database.
GET
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameterChanges
Summarize the AWR database parameter change history.
GET
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameters
Summarize AWR datbase parameter history information.
GET
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbReport
Gets the AWR database report.
GET
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots
List the AWR snapshots for one database.
GET
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSqlReport
Gets the SQL health check report for the SQL statement specified by the SQL ID.
GET
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSysstats
Summarizes AWR Sysstat sample data for one database.
GET
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbTopWaitEvents
Summarizes AWR top N wait events.
GET
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbWaitEventBuckets
Summarize AWR event data into value buckets and frequencies for one database.
GET
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbWaitEvents
Summarizes AWR wait event sample data.
GET
/managedDatabases/{managedDatabaseId}/clusterCacheMetrics
Gets a detailed summary of various cluster cache metrics.
GET
/managedDatabases/{managedDatabaseId}/cursorCacheStatements
Lists the SQL statements from shared SQL area, also called the cursor cache.
GET
/managedDatabases/{managedDatabaseId}/databaseParameters
Lists database parameters.
GET
/managedDatabases/{managedDatabaseId}/dataguardPerformanceMetrics
Gets a summary of the Data Guard performance metrics like ApplyLag, TransportLag and RedoApplyRate metrics for the Managed Databases.
GET
/managedDatabases/{managedDatabaseId}/haBackupDetails
Gets HA and backup details with metrics and backup history for a single database.
GET
/managedDatabases/{managedDatabaseId}/optimizerStatisticsAdvisorExecutions
Lists the optimizer advisor task executions scan details and their findings count.
GET
/managedDatabases/{managedDatabaseId}/optimizerStatisticsAdvisorExecutions/{executionName}
Gets the optimizer statistics advisor task execution detailed report.
POST
/managedDatabases/{managedDatabaseId}/optimizerStatisticsAdvisorExecutions/{executionName}/actions/implementRecommendations
Implements the Optimizer Statistics Advisor task recommendations asynchronously.
GET
/managedDatabases/{managedDatabaseId}/optimizerStatisticsAdvisorExecutions/{executionName}/script
Gets the optimizer statistics advisor execution script for the provided task and execution name.
GET
/managedDatabases/{managedDatabaseId}/optimizerStatisticsCollectionAggregations
Lists the number of optimizer statistics collection operations per hour, grouped by task or object status for the specified Managed Database.
GET
/managedDatabases/{managedDatabaseId}/optimizerStatisticsCollectionOperations
This API returns a detailed summary of optimizer statistics collection operations.
GET
/managedDatabases/{managedDatabaseId}/optimizerStatisticsCollectionOperations/{optimizerStatisticsCollectionOperationId}
The API gets the optimizer statistics collection operation detailed report for the provided managed database.
GET
/managedDatabases/{managedDatabaseId}/pdbMetrics
Gets a summary of the resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory metrics for Pdb's under the container database.
GET
/managedDatabases/{managedDatabaseId}/peerDatabaseMetrics
Gets a comparative summary of the baseline and target values of the Data Guard performance metrics for Managed Databases.
GET
/managedDatabases/{managedDatabaseId}/preferredCredentials
Gets the list of preferred credentials for the given Managed Database.
DELETE
/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}
Delete the preferred credential.
GET
/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}
Gets the preferred credential based on credentialName path attribute.
PUT
/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}
Update the details of preferred credential.
POST
/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}/actions/test
Status of the test preferred credential.
GET
/managedDatabases/{managedDatabaseId}/sqlPlanBaselineConfiguration
Gets SQL plan baseline configuration details.
GET
/managedDatabases/{managedDatabaseId}/sqlPlanBaselineExecutionStats
Get counts of SQL plan baselines aggregated by the age of their last execution in weeks.
GET
/managedDatabases/{managedDatabaseId}/sqlPlanBaselineJobs
Lists the database jobs used for loading SQL plan baselines.
GET
/managedDatabases/{managedDatabaseId}/sqlPlanBaselineStats
Get counts of SQL plan baselines aggregated by their attributes.
GET
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines
Lists the SQL plan baselines.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/changePlanRetention
Changes the retention period of unused plans.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/changeSpaceBudget
Changes the disk space limit for the SQL Management Base.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/changeSqlPlanBaselinesAttributes
Changes one or more attributes of a single plan or all plans associated with a SQL statement.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/configureAutomaticCaptureFilters
Configures automatic capture filters.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/configureAutomaticSpmEvolveAdvisorTask
Configures the Automatic SPM Evolve Advisor task.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/disableAutomaticInitialPlanCapture
Disables automatic initial plan capture.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/disableAutomaticSpmEvolveAdvisorTask
Disables the Automatic SPM Evolve Advisor task.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/disableHighFrequencyAutomaticSpmEvolveAdvisorTask
Disables the high-frequency Automatic SPM Evolve Advisor task.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/disableSqlPlanBaselinesUsage
Disables the use of SQL plan baselines stored in SQL Management Base.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/dropSqlPlanBaselines
Drops a single plan or all plans associated with a SQL statement.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/enableAutomaticInitialPlanCapture
Enables automatic initial plan capture.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/enableAutomaticSpmEvolveAdvisorTask
Enables the Automatic SPM Evolve Advisor task.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/enableHighFrequencyAutomaticSpmEvolveAdvisorTask
Enables the high-frequency Automatic SPM Evolve Advisor task.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/enableSqlPlanBaselinesUsage
Enables the use of SQL plan baselines stored in SQL Management Base.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/loadSqlPlanBaselinesFromAwr
Loads plans from Automatic Workload Repository (AWR) snapshots.
POST
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/loadSqlPlanBaselinesFromCursorCache
Loads plans for statements directly from the shared SQL area, also called the cursor cache.
GET
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/{planName}
Gets SQL plan baseline details.
GET
/managedDatabases/{managedDatabaseId}/tableStatistics
Gets the number of table statistics categorized by statistics status.
GET
/managedDatabases/{managedDatabaseId}/tablespaces
Gets a list of tablespaces for a Managed Database.
POST
/managedDatabases/{managedDatabaseId}/tablespaces
Creates a tablespace.
GET
/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}
Gets the details of the tablespace.
PUT
/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}
Updates tablespace attributes.
POST
/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}/actions/addDataFiles
Adds data files or temp files to the tablespace.
POST
/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}/actions/dropTablespace
Drops the tablespace.
POST
/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}/actions/removeDataFile
Removes a data file or temp file from the tablespace.
POST
/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}/actions/resizeDataFile
Resizes a data file or temp file within the tablespace.
GET
/managedDatabases/{managedDatabaseId}/users
Gets a list of users for a Managed Database.
GET
/managedDatabases/{managedDatabaseId}/users/{userName}
Gets the details of a specific user.
GET
/managedDatabases/{managedDatabaseId}/users/{userName}/consumerGroupPrivileges
Gets a list of Consumer Group Privileges granted to a user.
GET
/managedDatabases/{managedDatabaseId}/users/{userName}/dataAccessContainers
Gets a list of Containers.
GET
/managedDatabases/{managedDatabaseId}/users/{userName}/objectPrivileges
Gets a list of Object Privileges granted a user.
GET
/managedDatabases/{managedDatabaseId}/users/{userName}/proxiedForUsers
Gets a list of proxied users.
GET
/managedDatabases/{managedDatabaseId}/users/{userName}/proxyUsers
Gets a list of proxy Users.
GET
/managedDatabases/{managedDatabaseId}/users/{userName}/roles
Gets a list of roles granted to a user.
GET
/managedDatabases/{managedDatabaseId}/users/{userName}/systemPrivileges
Gets a list of System Privileges granted to a user.
GET
/namedCredentials
Lists Named Credential.
POST
/namedCredentials
Creates a Named Credential.
DELETE
/namedCredentials/{namedCredentialId}
Deletes a Named Credential.
GET
/namedCredentials/{namedCredentialId}
Gets Named Credential details.
PUT
/namedCredentials/{namedCredentialId}
Updates a Named Credential.
POST
/namedCredentials/{namedCredentialId}/actions/changeCompartment
Moves a Named Credential.
POST
/namedCredentials/{namedCredentialId}/actions/test
Status of the test named credential.
POST
/pluggabledatabases/{pluggableDatabaseId}/actions/disableDatabaseManagement
Disables Database Management feature for a database.
POST
/pluggabledatabases/{pluggableDatabaseId}/actions/enableDatabaseManagement
Enables Database Management feature for the cloud pluggable Database.
POST
/pluggabledatabases/{pluggableDatabaseId}/actions/modifyDatabaseManagement
Modifies Database Management feature for the cloud pluggable Database.
GET
/workRequests
List Work Requests
GET
/workRequests/{workRequestId}
Get Work Request Status
GET
/workRequests/{workRequestId}/errors
Lists work request errors
GET
/workRequests/{workRequestId}/logs
Lists work request logs
Schemas 496
The contract defines 496 schemas that model the data the API accepts and returns. The most detailed are TablespaceSummary (39 properties), CloudListener (29 properties), ManagedDatabase (28 properties), ExternalListener (28 properties). Each schema is shown below with its type and property counts.
AsmPropertyCollection
object
A collection of ASM properties for a specific Managed Database.
1 property
1 required
AwrDbTopWaitEventSummary
object
A summary of the AWR top wait event data for one event.
3 properties
1 required
UpdateMySqlDatabaseConnectorDetails
object
Update Details of external database connector. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
8 properties
5 required
SqlCpuActivity
object
The SQL CPU activity from the Exadata storage server.
3 properties
UpdatePreferredCredentialDetails
object
The details required to update the preferred credential.
1 property
1 required
IormPlan
object
The IORM plan from an Exadata storage server.
3 properties
2 required
SnapshotDetails
object
The details of the newly generated AWR snapshot.
1 property
1 required
SystemPrivilegeSummary
object
A Summary of system privileges.
4 properties
ExternalDbNode
object
The details of an external database node.
18 properties
8 required
MemoryAggregateMetrics
object
The memory aggregate metric details.
1 property
CloudCluster
object
The details of a cloud cluster.
22 properties
8 required
PatchCloudDbSystemDiscoveryDetails
object
The details required to update a cloud DB system discovery resource.
1 property
OpenAlertHistory
object
The existing open alerts in the Exadata storage server.
1 property
1 required
CloudDatabaseInstance
object
The details of a cloud database instance.
3 properties
3 required
UpdateCloudDbSystemDetails
object
The details required to update a cloud DB system.
3 properties
ExternalAsmUserCollection
object
A collection of external ASM users.
1 property
1 required
ExternalListenerEndpoint
object
The protocol address that an external listener is configured to listen on.
2 properties
1 required
AwrDbCpuUsageSummary
object
A summary of the AWR CPU resource limits and metrics.
2 properties
RecommendationRationale
object
The details of the rationale for the recommendation.
1 property
1 required
CloudExadataStorageConnectorSummary
object
The connector of the Exadata storage server.
AwrDbCollection
object
The result of AWR query.
ExternalAsmServicedDatabase
The details of a database serviced by an external ASM.
SqlPlanBaselineCollection
object
The SQL plan baseline list.
1 property
1 required
EnableAutonomousDatabaseManagementFeatureDetails
object
The details required to enable a Database Management feature for an Autonomous Database.
1 property
1 required
RemoveDataFileDetails
object
The details required to remove a data file or temp file from the tablespace. It takes either credentialDetails or databaseCredential. It's recommended to provi…
4 properties
2 required
DisableDatabaseManagementFeatureDetails
object
The details required to disable Database Management features for an Oracle cloud database.
2 properties
1 required
CloudDbSystemDiscovery
object
The details of a cloud DB system discovery.
16 properties
9 required
CreateExternalDbSystemDetails
object
The details required to create an external DB system.
7 properties
2 required
CloudDbSystemDiscoveryCollection
object
A collection of cloud DB system discovery summaries.
1 property
1 required
AwrDbReport
object
The result of the AWR report.
CloudClusterInstance
object
The details of a cloud cluster instance.
20 properties
7 required
AdvisorRule
object
The details of the Optimizer Statistics Advisor rule.
3 properties
3 required
ChangeExternalDbSystemCompartmentDetails
object
The details required to change the compartment of an external DB system.
1 property
1 required
UpdateCloudAsmInstanceDetails
object
The details required to update a cloud ASM instance.
2 properties
UpdateCloudExadataStorageConnectorDetails
object
The connector details of the Exadata storage server to be updated.
5 properties
ExternalDbSystemConnector
object
The details of an external DB system connector.
12 properties
8 required
ExternalListenerServiceCollection
object
A collection of external listener services.
1 property
1 required
TablespaceCollection
object
A collection of tablespaces for a specific Managed Database.
1 property
1 required
WorkRequestErrorCollection
object
The results of a work request error search. This contains WorkRequestError items and other data.
1 property
1 required
CloudListenerEndpoint
object
The protocol address that a cloud listener is configured to listen on.
2 properties
1 required
PreferredCredential
object
The details of the preferred credential.
4 properties
ChangeDbManagementPrivateEndpointCompartmentDetails
object
The details used to move the Database Management private endpoint to another compartment.
1 property
CloudExadataStorageConnectorCollection
object
The Exadata storage server connector list.
1 property
1 required
CloudClusterScanListenerConfiguration
object
The details of a SCAN listener in a cloud cluster.
4 properties
ImplementOptimizerStatisticsAdvisorRecommendationsJob
object
The job request details to implement the Optimizer Statistics Advisor task recommendations.
6 properties
3 required
UpdateCloudExadataStorageGridDetails
object
The details required to update an Exadata storage server grid.
2 properties
ExternalClusterVipConfiguration
object
The details of the Virtual IP (VIP) address for a node in an external cluster.
3 properties
UpdateCloudDbSystemDiscoveryDetails
object
The details required to update a cloud DB system discovery resource.
3 properties
TimeSeriesMetricDataPoint
object
The metric values with dimension details.
4 properties
3 required
CloudAsmServicedDatabase
The details of a database serviced by a cloud ASM.
LoadSqlPlanBaselinesFromCursorCacheDetails
object
The details of SQL statements and plans to be loaded from cursor cache. You can specify the plans to load using SQL ID, plan identifier, or filterName and filt…
12 properties
1 required
CloudDbSystem
object
The details of a cloud DB system.
19 properties
8 required
CloudExadataInfrastructure
object
The details of the Exadata infrastructure.
CloudDbSystemCollection
object
A collection of cloud DB systems.
1 property
1 required
DatabaseManagementConfig
object
The configuration of the Database Management service.
3 properties
2 required
ExternalDbSystemDiscovery
object
The details of an external DB system discovery.
14 properties
7 required
ExadataFleetMetricSummaryDefinition
object
A summary of the fleet metrics, which provides the metric aggregated value of the Exadata infrastructures in the fleet.
6 properties
ManagedDatabaseGroupSummary
object
A group of Managed Databases that will be managed together.
10 properties
6 required
ExternalPluggableDatabaseFeatureDetails
object
The details required to enable the specified Database Management feature.
2 properties
2 required
ManagedDatabaseCredential
object
The credential used to connect to the Managed Database and obtain the details of the optimizer statistics tasks.
3 properties
3 required
CloudExadataInfraBasicInfo
object
The basic information about a Cloud Exadata Infrastructure.
3 properties
3 required
WorkRequestLogEntry
object
A log message from the execution of a work request.
4 properties
4 required
CreateExternalMySqlDatabaseDetails
object
Details for creating an external database. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
2 properties
2 required
MetricDimensionDefinition
object
The metric dimension details.
2 properties
JobExecution
object
The details of a job execution.
24 properties
10 required
CloudAsmUserSummary
object
The summary of an ASM user.
3 properties
2 required
CloudAsmInstanceCollection
object
A collection of cloud ASM instances.
1 property
1 required
TableStatisticSummary
object
The summary of table statistics statuses, which includes status categories such as Stale, Not Stale, and No Stats, the number of table statistics grouped by st…
3 properties
3 required
ModifyDatabaseManagementFeatureDetails
object
The details required to modify a Database Management feature for an Oracle cloud database.
1 property
1 required
EnableExternalDbSystemStackMonitoringDetails
The details required to enable Stack Monitoring for an external DB system.
ExadataInfrastructureFleetStatusByCategory
object
The number of Exadata infrastructures in the fleet, grouped by deployment type and rack-size.
3 properties
DisableAutomaticSpmEvolveAdvisorTaskDetails
object
The details required to disable Automatic SPM Evolve Advisor task. It takes either credentials or databaseCredential. It's recommended to provide databaseCrede…
2 properties
ProxiedForUserCollection
object
A collection of users on whose behalf the current user acts as proxy.
1 property
1 required
CreateTablespaceDetails
object
The details required to create a tablespace. It takes either credentialDetails or databaseCredential. It's recommended to provide databaseCredential
22 properties
1 required
HistoricAddmResult
object
The details of the historic ADDM task.
13 properties
2 required
UpdateExternalAsmDetails
object
The details required to update an external ASM.
3 properties
MetricsAggregationRange
object
The set of aggregated data returned for a metric.
4 properties
ModifyAutonomousDatabaseManagementFeatureDetails
object
The details required to modify a Database Management feature for an Autonomous Database.
1 property
1 required
DatabasePlan
object
The resource allocation directives must all use the share attribute, or they must all use the level and allocation attributes. If you use the share attribute t…
1 property
1 required
EnableExternalPluggableDatabaseManagementFeatureDetails
object
The details required to enable a Database Management feature for an external pluggable database.
1 property
1 required
ClusterCacheMetric
object
The response containing the cluster cache metrics for the Oracle Real Application Clusters (Oracle RAC) database.
1 property
1 required
ExternalAsmDiskGroupCollection
object
A collection of external ASM disk groups.
1 property
1 required
UpdateCloudDbNodeDetails
object
The details required to update a cloud DB node.
3 properties
WorkRequest
object
A description of the work request status.
9 properties
7 required
CloudDbSystemConnectorSummary
object
The summary of a cloud DB system connector.
13 properties
9 required
RestCredential
object
The user credential information.
5 properties
2 required
ExternalDatabaseSystemDiscoverySummary
object
The summary of the DB system discovery.
CreateMySqlDatabaseConnectorDetails
object
Create Details of external database connector. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
8 properties
8 required
DatabaseBackupSummary
object
The summary of the High Availability (HA) and backup for a database.
6 properties
6 required
AwrDbSysstatCollection
object
The AWR SYSSTAT time series summary data.
CreateManagedDatabaseGroupDetails
object
The details required to create a Managed Database Group.
5 properties
2 required
OptimizerStatisticsOperationTask
object
The details of the Optimizer Statistics Collection task.
5 properties
5 required
AllowedParameterValue
object
A valid value for a database parameter.
3 properties
ExternalAsmInstance
object
The details of an external ASM instance.
16 properties
7 required
CloudDbHome
object
The details of a cloud database home.
15 properties
7 required
EnableExternalContainerDatabaseManagementFeatureDetails
object
The details required to enable a Database Management feature for an external container database.
1 property
1 required
CloudIormPlan
object
The IORM plan from an Exadata storage server.
3 properties
2 required
WorkRequestSubResource
object
The resource that is created or operated on by a work request.
6 properties
3 required
ExternalDbSystemConnectorCollection
object
A collection of external DB system connectors.
1 property
1 required
AwrDbWaitEventBucketCollection
object
The percentage distribution of waits in the AWR wait event buckets.
SqlPlanBaseline
object
The details of a SQL plan baseline.
16 properties
5 required
DropSqlPlanBaselinesDetails
object
The details required to drop SQL plan baselines. It takes either credentials or databaseCredential. It's recommended to provide databaseCredential
4 properties
ProxyUserSummary
object
A summary of the proxy user.
3 properties
PerformanceMetricsData
object
The list of Data Guard performance metrics for Managed Databases.
10 properties
DatabaseCredentials
object
The database credentials used to perform management activity. Provide one of the following attribute set. (userName, password, role) OR (userName, secretId, ro…
4 properties
Recommendation
object
The details of the Optimizer Statistics Advisor findings and recommendations.
3 properties
1 required
FleetStatusByCategory
object
The number of databases in the fleet, grouped by database type and sub type.
4 properties
MetricsAggregationRangeCollection
object
The collection of metrics.
3 properties
1 required
CloudDbSystemDiscoverySummary
object
The summary of a cloud DB system.
13 properties
9 required
SchemaDefinition
object
The schema object details.
2 properties
1 required
ExternalServicedDatabase
object
The details of a database serviced by an external DB system component such as a listener or ASM.
7 properties
2 required
UpdateExternalDbSystemDetails
object
The details required to update an external DB system.
3 properties
WorkRequestResource
object
The resource that is created or operated on by a work request.
6 properties
3 required
DatabaseFleetHealthMetrics
object
The details of the fleet health metrics.
5 properties
3 required
ExternalDbSystemBasicInfo
object
The basic information about an external DB system.
4 properties
3 required
ExternalExadataInfrastructure
object
The details of the Exadata infrastructure.
DisableExternalPluggableDatabaseManagementFeatureDetails
object
The details required to disable a Database Management feature for an external pluggable database.
1 property
1 required
DataAccessContainerCollection
object
A collection of specific containers for the current user. This is only applicable if ALLCONTAINERS !='Y'.
1 property
1 required
ExternalDatabaseInstance
object
The details of an external database instance.
3 properties
3 required
DataguardPerformanceMetrics
object
A summary of Data Guard performance metrics for Managed Databases.
1 property
1 required
CloudClusterInstanceSummary
object
The summary of a cloud cluster instance.
20 properties
7 required
EnableExternalNonContainerDatabaseManagementFeatureDetails
object
The details required to enable a Database Management feature for an external non-container database.
1 property
1 required
DisableAutonomousDatabaseManagementFeatureDetails
object
The details required to disable a Database Management feature for an Autonomous Database.
1 property
1 required
ManagedDatabase
object
The details of a Managed Database.
28 properties
7 required
SpmEvolveTaskParameters
object
The set of parameters used in an SPM evolve task.
5 properties
CloudServicedDatabase
object
The details of a database serviced by a cloud DB system component such as a listener or ASM.
8 properties
3 required
UpdateCloudDbHomeDetails
object
The details required to update a cloud DB home.
2 properties
AwrDbMetricCollection
object
The AWR metrics time series summary data.
MetricDataPoint
object
The metric values with dimension details.
3 properties
ExternalDatabaseFeatureDetails
object
The details required to enable the specified Database Management feature.
2 properties
2 required
DataguardMetrics
The Data Guard usage metrics for a single database.
SqlPlanBaselineJobCollection
object
A collection of database jobs used for loading and evolving SQL plan baselines.
1 property
1 required
ExadataFleetMetricDefinition
object
The Exadata infrastructure metric details.
7 properties
CloudExadataStorageServerSummary
object
The Exadata storage server of the Exadata infrastructure.
VMClusterDiscoverySummary
object
The summary of the VM Cluster discovery.
RuleFinding
object
The summary of the Optimizer Statistics Advisor findings and recommendations.
3 properties
3 required
UpdateCloudDbSystemConnectorDetails
object
The details required to update a cloud DB system connector.
1 property
1 required
MySqlConnectorCollection
object
The collection of external MySQL Database connectors. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
1 property
1 required
ConsumerGroupPrivilegeSummary
object
A summary of consumer group privileges.
3 properties
NamedCredential
object
The details of a named credential.
15 properties
5 required
JobInBind
object
The details of the job in-bind variable.
4 properties
3 required
CloudListenerServicedDatabase
The details of a database serviced by a cloud listener.
RoleCollection
object
A collection of roles granted to the current User.
1 property
1 required
UpdateCloudExadataStorageServerDetails
object
The details required to update an Exadata storage server.
2 properties
ExternalClusterScanListenerConfiguration
object
The details of a SCAN listener in an external cluster.
4 properties
SqlPlanBaselineJobSummary
object
A summary of the database job used for loading and evolving SQL plan baselines.
4 properties
3 required
DbManagementPrivateEndpointSummary
object
The summary of a Database Management private endpoint.
12 properties
5 required
CloudAsmDiskGroupSummary
object
The summary of a cloud ASM disk group.
9 properties
1 required
EnableAutomaticInitialPlanCaptureDetails
object
The details required to enable automatic initial plan capture. It takes either credentials or databaseCredential. It's recommended to provide databaseCredential
2 properties
StatementsAggregateMetrics
object
The queued and running statement metrics for Autonomous Databases.
2 properties
ObjectPrivilegeSummary
object
A summary of object privileges.
9 properties
AssociatedDatabaseCollection
object
A collection of databases using a Database Management private endpoint.
1 property
1 required
ExternalServicedAsm
object
The details of ASM serviced by an external listener.
3 properties
2 required
AwrDbParameterChangeSummary
object
A summary of the changes made to a single AWR database parameter.
8 properties
1 required
ExternalStorageServerDiscoverySummary
object
The summary of the Exadata storage server discovery.
DatabasePlanDirective
object
Manages resource allocation among databases. Besides the name, at least one other property must be available.
18 properties
1 required
ExternalExadataStorageServerSummary
object
The Exadata storage server of the Exadata infrastructure.
DisableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetails
object
The details required to disable high frequency Automatic SPM Evolve Advisor task. It takes either credentials or databaseCredential. It's recommended to provid…
2 properties
ExternalClusterInstance
object
The details of an external cluster instance.
19 properties
7 required
PreferredCredentialSummary
object
The summary of preferred credentials.
7 properties
3 required
JobSummary
object
A summary of the job.
18 properties
8 required
ExternalDbSystemConnectorSummary
object
The summary of an external DB system connector.
13 properties
9 required
CloudAsmInstanceParameters
object
The initialization parameters for an ASM instance.
6 properties
6 required
CloudDbSystemSummary
object
The summary of a cloud DB system.
15 properties
8 required
UpdateExternalDbHomeDetails
object
The details required to update an external DB home.
2 properties
UpdateExternalListenerDetails
object
The details required to update an external listener.
3 properties
TablespaceStorageSize
object
Storage size.
2 properties
1 required
CloudDbNode
object
The details of a cloud DB node.
19 properties
8 required
ConfigureAutomaticSpmEvolveAdvisorTaskDetails
object
The configuration details of the Automatic SPM Evolve Advisor task. It takes either credentials or databaseCredential. It's recommended to provide databaseCred…
3 properties
1 required
CloudListener
object
The details of a cloud listener.
29 properties
8 required
TestNamedCredentialDetails
object
The The [OCID](/Content/General/Concepts/identifiers.htm) of the database against which the credential is to be tested.
1 property
ProxyUserCollection
object
A collection of proxy users for the current user.
1 property
1 required
HaMetricDefinition
object
The metric definition for HA and backup metrics.
5 properties
5 required
DatabaseParametersCollection
object
A collection of database parameters.
5 properties
5 required
ChangeJobCompartmentDetails
object
The details required to change the compartment of a job.
1 property
1 required
EnableSqlPlanBaselinesUsageDetails
object
The details required to enable SQL plan baseline usage. It takes either credentials or databaseCredential. It's recommended to provide databaseCredential
2 properties
Datafile
object
The details of a data file.
15 properties
1 required
WorkRequestError
object
An error encountered while executing a work request.
6 properties
5 required
ExternalClusterCollection
object
A collection of external clusters.
1 property
1 required
OpenAlertSummary
object
An alert from the Exadata storage server.
4 properties
ExternalListenerSummary
object
The summary of an external listener.
15 properties
8 required
CreateExternalExadataStorageConnectorDetails
object
The details required to create the connector to the Exadata storage server.
7 properties
5 required
RunHistoricAddmDetails
object
The details of the ADDM task, which include the beginning and ending AWR snapshot IDs.
2 properties
2 required
MySqlDatabaseConnectorSummary
object
Details of external database connector. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
18 properties
1 required
PdbStatusDetails
object
The number and status of PDBs in a Container Database.
2 properties
CloudExadataStorageGrid
object
The details of the Exadata storage server grid.
JobInBindsDetails
object
A collection of job in-bind variables.
1 property
1 required
ExternalExadataStorageGrid
object
The details of the Exadata storage server grid.
CloudDatabaseSummary
object
The summary of a cloud database.
19 properties
5 required
DatabaseFleetBackupMetrics
object
The details of the backup metrics for the fleet of databases.
1 property
1 required
CloudAsmConfiguration
object
The configuration details of an ASM.
1 property
1 required
JobExecutionResultDetails
object
The job execution result details.
1 property
1 required
ExternalDbNodeCollection
object
A collection of external database nodes.
1 property
1 required
DatabaseConnectionCredentials
object
The credentials used to connect to the database. Currently only the DETAILS type is supported for creating MACS connector credentials.
1 property
UpdateDatabaseParametersResult
object
The results of database parameter update.
1 property
1 required
ExternalExadataInfrastructureCollection
object
A list of the Exadata infrastructure resources.
1 property
1 required
CloudExadataStorageConnector
object
The details of the Exadata storage server connector.
SqlPlanBaselineAggregation
object
A summary of SQL plan baselines.
2 properties
1 required
CloudDbSystemConnector
object
The details of a cloud DB system connector.
12 properties
8 required
ChangeDatabaseParameterDetails
object
The value of a database parameter to change.
3 properties
2 required
UpdateExternalMySqlDatabaseConnectorDetails
object
Details required for updating an external MySQL database connector. MySQL support within OCI Database Management service has been deprecated as of January 29,…
2 properties
1 required
CloudDbNodeSummary
object
The summary of a cloud DB node.
15 properties
8 required
ChangeNamedCredentialCompartmentDetails
object
The details required to change the compartment of a named credential.
1 property
1 required
AwrDbMetricSummary
object
The summary of the AWR metric data for a particular metric at a specific time.
5 properties
1 required
AwrDbParameterChangeCollection
object
The AWR database parameter change history.
ExternalListenerServiceSummary
object
The summary of a service registered with an external listener.
3 properties
1 required
OptimizerStatisticsAdvisorExecutionScript
object
The Oracle system-generated script for the Optimizer Statistics Advisor execution.
1 property
1 required
UpdateExternalExadataInfrastructureDetails
object
The details required to update the external Exadata infrastructure.
8 properties
1 required
DatabaseBackupMetrics
The details of the backup metrics for a single database.
CloudExadataInfrastructureCollection
object
A list of the Exadata infrastructure resources.
1 property
1 required
PeerDatabaseMetrics
object
The summary of resource usage metrics for the peer database.
1 property
1 required
CreateCloudDbSystemDiscoveryDetails
object
The details required to create a cloud DB system discovery resource.
7 properties
4 required
AwrDbParameterSummary
object
The summary of the AWR change history data for a single database parameter.
7 properties
1 required
DatabaseTimeAggregateMetrics
object
The database time metric details.
5 properties
JobExecutionsStatusSummaryCollection
object
A collection of job execution status summary objects.
1 property
1 required
CloudDbSystemBasicInfo
object
The basic information about a cloud DB system.
4 properties
3 required
ExternalExadataStorageConnectorSummary
object
The connector of the Exadata storage server.
ExternalMySqlDatabaseConnector
object
Details of external database connector. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
20 properties
1 required
TimeSeriesMetricDefinition
object
The response object representing time series metric details for a specific Managed Database at a particular time.
2 properties
2 required
SqlPlanBaselineAggregationCollection
object
A collection of SQL plan baseline aggregations.
1 property
1 required
DisableExternalContainerDatabaseManagementFeatureDetails
object
The details required to disable a Database Management feature for an external container database.
2 properties
1 required
EnableExternalExadataInfrastructureManagementDetails
object
The details required to enable Database Management on the Exadata infrastructure.
1 property
1 required
CloudDbHomeCollection
object
A collection of cloud database homes.
1 property
1 required
ExternalDbSystemSummary
object
The summary of an external DB system.
13 properties
6 required
EnableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetails
object
The details required to enable high frequency Automatic SPM Evolve Advisor task. It takes either credentials or databaseCredential. It's recommended to provide…
2 properties
CloudDbNodeCollection
object
A collection of cloud DB nodes.
1 property
1 required
CloudAsm
object
The details of a cloud ASM.
20 properties
8 required
EnableExternalDbSystemDatabaseManagementDetails
object
The details required to enable Database Management for an external DB system.
1 property
1 required
SqlPlanBaselineSummary
object
The summary of a SQL plan baseline.
13 properties
4 required
SqlPlanBaselineJob
object
The details of the database job used for loading and evolving SQL plan baselines.
4 properties
3 required
ExternalExadataStorageGridSummary
object
The Exadata storage server grid of the Exadata infrastructure.
CreateExternalExadataInfrastructureDetails
object
The details required to create the external Exadata infrastructure.
8 properties
3 required
ExternalClusterInstanceCollection
object
A collection of external cluster instances.
1 property
1 required
DbManagementPrivateEndpointCollection
object
A collection of Database Management private endpoint objects.
1 property
1 required
UpdateExternalDbNodeDetails
object
The details required to update an external DB node.
3 properties
DisableExternalNonContainerDatabaseManagementFeatureDetails
object
The details required to disable a Database Management feature for an external non-container database.
1 property
1 required
ManagedDatabaseSummary
object
A summary of the Managed Database.
19 properties
7 required
TablespaceAdminCredentialDetails
object
The credential to connect to the database to perform tablespace administration tasks.
3 properties
3 required
CloudExadataInfrastructureSummary
object
The Exadata infrastructure.
ExternalExadataDatabaseSystemSummary
object
The DB systems of the Exadata infrastructure.
FleetSummary
object
A summary of the inventory count grouped by database type and subtype, and the metrics that describe the aggregated usage of CPU, storage, and so on of all the…
2 properties
ManagedDatabaseGroup
object
The details of a Managed Database Group.
11 properties
6 required
FleetMetricDefinition
object
The database metric details.
7 properties
CreateExternalDbSystemConnectorDetails
object
The details required to create an external DB system connector.
3 properties
2 required
CloudAsmCollection
object
A collection of cloud ASMs.
1 property
1 required
CloudClusterCollection
object
A collection of cloud clusters.
1 property
1 required
AssociatedComponent
object
The details of the associated component.
3 properties
2 required
DatabaseFleetHaOverviewMetrics
object
The details of the HA metrics for the fleet of databases.
1 property
1 required
SystemPrivilegeCollection
object
A collection of system privileges granted to the current user.
1 property
1 required
DatabaseFeatureConfiguration
object
The details of an external database feature configuration.
4 properties
2 required
EnablePluggableDatabaseManagementFeatureDetails
object
The details required to enable a Database Management feature for an Oracle cloud pluggable database.
1 property
1 required
CloudAsmSummary
object
The summary of a cloud ASM.
14 properties
8 required
JobExecutionCollection
object
A collection of job execution objects.
1 property
1 required
DiscoverExternalExadataInfrastructureDetails
object
The connection details and the discovery options for the Exadata discovery.
4 properties
3 required
ProxiedForUserSummary
A summary of users on whose behalf the current user acts as proxy.
CloudServicedAsm
object
The details of ASM serviced by a cloud listener.
3 properties
2 required
WorkRequestSummary
object
A Summary of the work request.
9 properties
7 required
ExternalExadataInfrastructureSummary
object
The Exadata infrastructure.
CreateExternalMySqlDatabaseConnectorDetails
object
Details for creating an external database connector. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
2 properties
2 required
ExternalAsmSummary
object
The summary of an external ASM.
13 properties
8 required
CloudExadataStorageServer
object
The details of the Exadata storage server.
CloudAsmInstanceSummary
object
The summary of a cloud ASM instance.
17 properties
7 required
ChangePlanRetentionDetails
object
The details required to change the plan retention period. It takes either credentials or databaseCredential. It's recommended to provide databaseCredential
3 properties
1 required
ConfigureAutomaticCaptureFiltersDetails
object
The details required to configure automatic capture filters. It takes either credentials or databaseCredential. It's recommended to provide databaseCredential
3 properties
1 required
ExternalDbHomeCollection
object
A collection of external database homes.
1 property
1 required
JobExecutionResultLocation
object
The location of the job execution result.
1 property
1 required
ExternalAsm
object
The details of an external ASM.
19 properties
8 required
UpdateCloudListenerDetails
object
The details required to update a cloud listener.
3 properties
TablespaceSummary
object
The summary of a tablespace.
39 properties
2 required
ChangeSqlPlanBaselinesAttributesDetails
object
The details required to change SQL plan baseline attributes. It takes either credentials or databaseCredential. It's recommended to provide databaseCredential
7 properties
CloudListenerSummary
object
The summary of a cloud listener.
16 properties
8 required
StandByDatabaseDataguardMetrics
object
The standby database details.
7 properties
5 required
DatabaseFleetDataguardMetrics
object
The list of Oracle Data Guard-enabled databases in the fleet.
1 property
1 required
ExternalDatabaseSummary
object
The summary of an external database.
19 properties
5 required
DatabaseStorageAggregateMetrics
object
The database storage metric values.
3 properties
CloudAsmDiskGroupCollection
object
A collection of cloud ASM disk groups.
1 property
1 required
WorkRequestCollection
object
Lists all work requests in a specific compartment. This contains WorkRequestSummary items.
1 property
1 required
UpdateTablespaceDetails
object
The details required to update a tablespace. It takes either credentialDetails or databaseCredential. It's recommended to provide databaseCredential
11 properties
ExternalDbHomeSummary
object
The summary of an external database home.
13 properties
7 required
DatabaseConnectionStringDetails
object
The details of the Oracle Database connection string.
1 property
1 required
ExternalAsmInstanceSummary
object
The summary of an external ASM instance.
16 properties
7 required
InstanceDetails
object
The details of the Oracle Real Application Clusters (Oracle RAC) database instance.
4 properties
4 required
PdbMetrics
object
The summary of Pluggable Databases (PDBs) and their resource usage metrics, within a specific Container Database (CDB).
1 property
1 required
RecommendationExampleLine
object
An example line of the recommendation
2 properties
JobExecutionSummary
object
A summary of a job execution on a Managed Database.
16 properties
9 required
Tablespace
The details of a tablespace.
DropTablespaceDetails
object
The details required to drop a tablespace. It takes either credentialDetails or databaseCredential. It's recommended to provide databaseCredential
5 properties
ExadataMetricDimensionDefinition
object
The metric dimension details.
2 properties
RoleSummary
object
A summary of each role.
6 properties
UpdateExternalClusterDetails
object
The details required to update an external cluster.
3 properties
AwrDbSnapshotCollection
object
The list of AWR snapshots for one database.
ManagedDatabaseGroupCollection
object
A collection of Managed Database Group resources.
1 property
1 required
ExternalListenerCollection
object
A collection of external listeners.
1 property
1 required
ExternalExadataStorageServerCollection
object
The Exadata storage server list.
1 property
1 required
OptimizerStatisticsAdvisorExecutionReport
object
A report that includes the rules, findings, recommendations, and actions discovered during the execution of the Optimizer Statistics Advisor.
2 properties
2 required
UpdateExternalMySqlDatabaseDetails
object
Details for updating an external MySQL database. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
1 property
1 required
UpdateExternalAsmInstanceDetails
object
The details required to update an external ASM instance.
2 properties
ExternalExadataInfraBasicInfo
object
The basic information about an external Exadata Infrastructure.
3 properties
3 required
ExternalClusterInstanceSummary
object
The summary of an external cluster instance.
19 properties
7 required
ParentGroup
object
The parent Managed Database Group of a Managed Database.
3 properties
3 required
ExternalExadataStorageConnector
object
The details of the Exadata storage server connector.
OptimizerStatisticsCollectionOperation
The summary of the Optimizer Statistics Collection tasks, which includes details of the Managed Database and the execution.
UserSummary
object
The summary of a specific User.
8 properties
6 required
ObjectPrivilegeCollection
object
A collection of object privileges granted to the current user.
1 property
1 required
CreateNamedCredentialDetails
object
The details required to create a named credential.
9 properties
5 required
ExternalMySqlDatabaseCollection
object
The collection of external MySQL Databases. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
1 property
1 required
TestPreferredCredentialStatus
object
The status of the preferred credential test. The status is 'SUCCEEDED' if the preferred credential is working else the status is 'FAILED'.
3 properties
DisableAutomaticInitialPlanCaptureDetails
object
The details required to disable automatic initial plan capture. It takes either credentials or databaseCredential. It's recommended to provide databaseCredenti…
2 properties
JobOutBind
object
The details of the job out-bind variable.
2 properties
2 required
CloudClusterVipConfiguration
object
The details of the Virtual IP (VIP) address for a node in a cloud cluster.
3 properties
ExternalExadataStorageConnectorCollection
object
The Exadata storage server connector list.
1 property
1 required
BaseDatabaseHaDetails
object
The common database details used by all HA metrics.
11 properties
7 required
CreateCloudDbSystemConnectorDetails
object
The details required to create a cloud DB system connector.
3 properties
2 required
AssociatedDatabaseSummary
object
The summary of a database currently using a Database Management private endpoint.
4 properties
4 required
AwrQueryResult
object
The AWR query result.
5 properties
2 required
ExternalAsmCollection
object
A collection of external ASMs.
1 property
1 required
DatabaseParameterSummary
object
A summary of the database parameter.
23 properties
4 required
CreateCloudExadataInfrastructureDetails
object
The details required to create the Exadata infrastructure.
8 properties
2 required
ExternalExadataStorageConnectorStatus
object
The status of an Exadata storage server connector.
3 properties
1 required
ExternalAsmUserSummary
object
The summary of an ASM user.
3 properties
2 required
EnableCloudDbSystemDatabaseManagementDetails
The details required to enable Database Management for a cloud DB system.
CloudClusterNetworkConfiguration
object
The details of a network address configuration in a cloud cluster.
3 properties
PreferredCredentialCollection
object
A collection of preferred credential attributes.
1 property
1 required
CreateDbManagementPrivateEndpointDetails
object
The details used to create a new Database Management private endpoint.
10 properties
3 required
CloudAsmInstance
object
The details of a cloud ASM instance.
17 properties
7 required
DbManagementPrivateEndpoint
object
A Database Management private endpoint allows Database Management to connect to databases in a Virtual Cloud Network (VCN).
16 properties
5 required
ExternalExadataStorageServer
object
The details of the Exadata storage server.
ModifyPluggableDatabaseManagementFeatureDetails
object
The details required to modify a Database Management feature for an Oracle cloud pluggable database.
1 property
1 required
RecommendationExample
object
An example of the recommendation.
1 property
DiscoveredExternalDbSystemComponent
object
The details of an external DB system component.
8 properties
4 required
ChangeCloudExadataInfrastructureCompartmentDetails
object
The details required to change the compartment of the Exadata infrastructure.
1 property
1 required
AwrDbWaitEventSummary
object
The summary of the AWR wait event time series data for one event.
7 properties
1 required
StorageGridDiscoverySummary
object
The summary of the Exadata storage server grid discovery.
UpdateExternalClusterInstanceDetails
object
The details required to update an external cluster instance.
3 properties
DatabaseParameterUpdateStatus
object
The result of database parameter update.
3 properties
JobScheduleDetails
object
The details of the job schedule.
4 properties
EnableAutomaticSpmEvolveAdvisorTaskDetails
object
The details required to enable Automatic SPM Evolve Advisor task. It takes either credentials or databaseCredential. It's recommended to provide databaseCreden…
2 properties
ActivityTimeSeriesMetrics
object
The response object representing activityMetric details for a specific Managed Database at a particular time.
6 properties
CloudListenerServiceCollection
object
A collection of cloud listener services.
1 property
1 required
DiscoveredCloudDbSystemComponent
object
The details of a cloud DB system component.
9 properties
4 required
TableStatisticsCollection
object
A collection of table statistics, which are grouped by status.
1 property
1 required
OptimizerStatisticsCollectionOperationsCollection
object
The details of each statistics collection operation.
1 property
1 required
AwrDbSnapshotSummary
object
The AWR snapshot summary of one snapshot.
7 properties
2 required
EntityDiscovered
object
The details of the base entity discovery.
11 properties
2 required
CreateJobDetails
object
The details required to create a job.
11 properties
4 required
AwrDbSnapshotRangeCollection
object
The AWR snapshot range list.
ExternalExadataInfrastructureDiscovery
object
The result of the Exadata infrastructure discovery.
ExternalDbSystemDiscoveryCollection
object
A collection of external DB system discovery summaries.
1 property
1 required
ExternalMySqlDatabase
object
External database. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
4 properties
2 required
DbManagementAnalyticsMetric
object
The metric details of a Database Management resource.
6 properties
ExternalDbSystem
object
The details of an external DB system.
17 properties
6 required
CursorCacheStatementSummary
object
The summary of a SQL statement in the cursor cache.
3 properties
3 required
JobRun
object
The details of a specific job run.
10 properties
8 required
ExternalClusterNetworkConfiguration
object
The details of a network address configuration in an external cluster.
3 properties
ExternalDbSystemStackMonitoringConfigDetails
The configuration details of Stack Monitoring for an external DB system.
WorkRequestLogEntryCollection
object
The results of a work request log search. This contains WorkRequestLog items and other data.
1 property
1 required
OptimizerStatisticsAdvisorExecutionsCollection
object
The details of each Optimizer Statistics Advisor execution.
1 property
1 required
AddDataFilesDetails
object
The details required to add data files or temp files to the tablespace. lease provide either credentialDetails or databaseCredential. It's recommended to provi…
11 properties
1 required
ResetDatabaseParametersDetails
object
The details required to reset database parameter values. It takes either credentials or databaseCredential. It's recommended to provide databaseCredential
4 properties
2 required
UpdateManagedDatabaseGroupDetails
object
The details required to update a Managed Database Group.
3 properties
AwrDbSqlReport
object
The result of the AWR SQL report.
StorageServerDiscoverySummary
object
The summary of the Exadata storage server discovery.
DatabaseHomeMetrics
object
The response containing the metric collection for a specific Managed Database.
2 properties
1 required
OptimizerStatisticsAdvisorExecutionSummary
object
The summary of the Optimizer Statistics Advisor execution.
8 properties
5 required
AutonomousDatabaseFeatureDetails
object
The details required to enable the specified Database Management feature for an Autonomous Database.
3 properties
2 required
OptimizerStatisticsAdvisorExecution
The summary of the Optimizer Statistics Advisor execution, which includes information about the Managed Database and a comprehensive execution report.
UpdateCloudExadataInfrastructureDetails
object
The details required to update the Exadata infrastructure.
7 properties
DatabaseHaMetrics
The details of the HA metrics for a single database.
ExternalAsmDiskGroupSummary
object
The summary of an external ASM disk group.
9 properties
1 required
EnableExternalDatabaseManagementDetails
object
Detail to enable or disable database management. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
1 property
1 required
TopSqlCpuActivity
object
A list of SQL IDs with most CPU activity.
1 property
1 required
DisablePluggableDatabaseManagementFeatureDetails
object
The details required to disable a Database Management feature for an Oracle cloud pluggable database.
1 property
1 required
Error
object
Error Information.
2 properties
2 required
AwrDbSnapshotRangeSummary
object
The summary data for a range of AWR snapshots.
DataAccessContainerSummary
object
A summary of the ContainerDataAccess user.
1 property
UpdateCloudClusterInstanceDetails
object
The details required to update a cloud cluster instance.
3 properties
UpdateNamedCredentialDetails
object
The details required to update a named credential.
6 properties
FindingSchemaOrOperation
object
The findings of the Optimizer Statistics Advisor.
2 properties
ConnectorDetails
object
The connector details required to connect to an Oracle cloud database.
1 property
1 required
ExadataVmClusterSummary
object
The VM Clusters of the Exadata infrastructure.
PerformanceMetrics
object
The Data Guard performance metric details.
4 properties
DatabaseHaBackupDetails
The database HA and backup details.
CloudDbSystemConnectorCollection
object
A collection of cloud DB system connectors.
1 property
1 required
CloudListenerCollection
object
A collection of cloud listeners.
1 property
1 required
AssociatedServiceDetails
object
The details of the associated service that will be enabled or disabled for an external DB System.
2 properties
1 required
ExadataInfrastructureFleetSummary
object
A summary of the inventory count grouped by Exadata infrastructure deployment type, and the metrics that describe the aggregated usage of CPU, storage, and so…
2 properties
MetricStatisticsDefinition
object
The metric statistics values with dimension details.
7 properties
ExternalStorageGridDiscoverySummary
object
The summary of the Exadata storage server grid discovery.
LoadSqlPlanBaselinesFromAwrDetails
object
The details required to load plans from Automatic Workload Repository (AWR). It takes either credentials or databaseCredential. It's recommended to provide dat…
9 properties
3 required
DisableSqlPlanBaselinesUsageDetails
object
The details required to disable SQL plan baseline usage. It takes either credentials or databaseCredential. It's recommended to provide databaseCredential
2 properties
CpuUtilizationAggregateMetrics
object
The CPU utilization metrics for Autonomous Databases.
2 properties
CreateCloudDbSystemDetails
object
The details required to create a cloud DB system.
7 properties
2 required
ExternalClusterSummary
object
The summary of an external cluster.
13 properties
8 required
AddManagedDatabaseToManagedDatabaseGroupDetails
object
The Managed Database details required to add it to a Managed Database Group.
1 property
1 required
JobExecutionsStatusSummary
object
A summary of the status of the job executions.
2 properties
2 required
DatabaseHomeMetricDefinition
object
The response containing the CPU, Storage, Wait, DB Time, and Memory metrics for a specific Managed Database.
8 properties
5 required
AwrDbParameterCollection
object
The AWR database parameter data.
FleetMetricSummaryDefinition
object
A summary of the fleet metrics, which provides the metric aggregated value of the databases in the fleet.
6 properties
AwrDbSummary
object
The AWR summary for a database.
16 properties
2 required
ImplementOptimizerStatisticsAdvisorRecommendationsDetails
object
The request details object to implement the Optimizer Statistics Advisor task recommendations.
2 properties
2 required
RemoveManagedDatabaseFromManagedDatabaseGroupDetails
object
The Managed Database details required to remove it from a Managed Database Group.
1 property
1 required
OptimizerStatisticsCollectionOperationSummary
object
The summary of the Optimizer Statistics Collection operation.
13 properties
8 required
CloudExadataInfrastructureDiscovery
object
The result of the Exadata infrastructure discovery.
Job
object
The details of the job.
17 properties
8 required
UpdateCloudClusterDetails
object
The details required to update a cloud cluster.
3 properties
CloudDbSystemStackMonitoringConfigDetails
The configuration details of Stack Monitoring for a cloud DB system.
DatabaseInstanceHomeMetricsDefinition
object
The response containing the CPU, Wait, DB Time, and Memory metrics for a specific Oracle Real Application Clusters (Oracle RAC) database instance.
7 properties
6 required
ExternalListenerServicedDatabase
The details of a database serviced by an external listener.
DiscoverCloudExadataInfrastructureDetails
object
The connection details and the discovery options for the Exadata discovery.
4 properties
3 required
ExternalDbSystemCollection
object
A collection of external DB systems.
1 property
1 required
UpdateExternalDbSystemConnectorDetails
object
The details required to update an external DB system connector.
1 property
1 required
UserCollection
object
A collection of users for a specific Managed Database.
1 property
1 required
CreateExternalDbSystemDiscoveryDetails
object
The details required to create an external DB system discovery resource.
5 properties
2 required
ChangeExternalExadataInfrastructureCompartmentDetails
object
The details required to change the compartment of the Exadata infrastructure.
1 property
1 required
DatabaseCredentialDetails
object
The credential to connect to the database to perform tablespace administration tasks.
1 property
1 required
ExternalDbSystemDatabaseManagementConfigDetails
object
The details required to enable Database Management for an external DB system.
1 property
1 required
ExternalCluster
object
The details of an external cluster.
21 properties
8 required
AwrDbCpuUsageCollection
object
The AWR CPU usage data.
ExadataInfrastructureFleetHealthMetrics
object
The details of the fleet health metrics.
5 properties
3 required
SqlPlanBaselineDimensions
object
The details of the SQL plan baseline dimensions.
2 properties
2 required
ChildDatabase
object
The child Managed Database of a Managed Database Group.
11 properties
4 required
ExternalMySqlDatabaseSummary
object
External database summary record. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
8 properties
2 required
CloudExadataStorageGridSummary
object
The Exadata storage server grid of the Exadata infrastructure.
CloudListenerServiceSummary
object
The summary of a service registered with a cloud listener.
3 properties
1 required
CloudDatabaseCollection
object
A collection of cloud databases.
1 property
1 required
CloudAsmUserCollection
object
A collection of cloud ASM users.
1 property
1 required
DatabaseIOAggregateMetrics
object
The database Input/Output metric details.
4 properties
CursorCacheStatementCollection
object
The list of SQL statements in the cursor cache.
1 property
1 required
UpdateCloudAsmDetails
object
The details required to update a cloud ASM.
3 properties
ResizeDataFileDetails
object
The details required to resize a data file or temp file within the tablespace. It takes either credentialDetails or databaseCredential. It's recommended to pro…
9 properties
2 required
FailedConnectionsAggregateMetrics
object
The failed connection metrics for Autonomous Databases on Shared Exadata Infrastructure.
1 property
AutomaticCaptureFilterDetails
object
The details of a capture filter used to include or exclude SQL statements in the initial automatic plan capture.
3 properties
1 required
NamedCredentialCollection
object
A collection of named credential summary.
1 property
1 required
CloudClusterSummary
object
The summary of a cloud cluster.
14 properties
8 required
AwrDbWaitEventCollection
object
The AWR wait event data.
UpdateExternalExadataStorageServerDetails
object
The details required to update an Exadata storage server.
2 properties
ExternalAsmInstanceParameters
object
The initialization parameters for an ASM instance.
6 properties
6 required
ConsumerGroupPrivilegeCollection
object
A collection of consumer group privileges granted to the current user.
1 property
1 required
CreateCloudExadataStorageConnectorDetails
object
The details required to create the connector to the Exadata storage server.
7 properties
4 required
JobOutBindsDetails
object
A collection of job out-bind variables.
1 property
1 required
OptimizerStatisticsCollectionAggregationsCollection
object
The number of times optimizer statistics are collected each hour, grouped by task status.
1 property
1 required
PatchExternalDbSystemDiscoveryDetails
object
The details required to update an external DB system discovery resource.
1 property
NamedCredentialContent
object
The details of the named credential.
1 property
1 required
OptimizerDatabase
object
The subset information of the Managed Database resource, which is used by Optimizer Statistics.
7 properties
7 required
EnableCloudExadataInfrastructureManagementDetails
object
The details required to enable Database Management on the Exadata infrastructure.
1 property
1 required
TestNamedCredentialStatus
object
The status of the named credential test. The status is 'SUCCEEDED' if the named credential is working or else the status is 'FAILED'.
3 properties
1 required
CloudDbHomeSummary
object
The summary of a cloud database home.
14 properties
7 required
UpdateExternalDbSystemDiscoveryDetails
object
The details required to update an external DB system discovery resource.
3 properties
EnableDatabaseManagementFeatureDetails
object
The details required to enable Database Management features for an Oracle cloud database.
1 property
1 required
CloudExadataStorageServerCollection
object
The Exadata storage server list.
1 property
1 required
CloudExadataStorageConnectorStatus
object
The status of an Exadata storage server connector.
3 properties
1 required
ChangeDatabaseParametersDetails
object
The details required to change database parameter values. It takes either credentials or databaseCredential. It's recommended to provide databaseCredential
4 properties
2 required
JobCollection
object
A collection of job objects.
1 property
1 required
UpdateJobDetails
object
The details required to update a job.
5 properties
AutomaticCaptureFilter
object
An automatic capture filter that enables you to capture only those SQL statements that you want, and exclude noncritical statements.
5 properties
JobDatabase
object
The Managed Database on which the job is executed.
7 properties
2 required
DatabaseFeatureDetails
object
The details required to enable the specified Database Management feature.
3 properties
3 required
ExternalAsmConfiguration
object
The configuration details of an ASM.
1 property
1 required
ExternalDatabaseCollection
object
A collection of external databases.
1 property
1 required
AwrDbWaitEventBucketSummary
object
A summary of the AWR wait event bucket and waits percentage.
2 properties
2 required
ExadataInfrastructureUsageMetrics
object
The list of aggregated metrics for Exadata infrastructures in the fleet.
9 properties
OptimizerStatisticsCollectionAggregationSummary
object
The summary of the Optimizer Statistics Collection, which includes the aggregated number of tasks grouped by status.
11 properties
1 required
User
object
The summary of a specific user resource.
24 properties
6 required
ExternalDbHome
object
The details of an external database home.
14 properties
7 required
AsmPropertySummary
object
The summary of ASM properties.
1 property
1 required
CloudClusterInstanceCollection
object
A collection of cloud cluster instances.
1 property
1 required
AwrDbSysstatSummary
object
The summary of the AWR SYSSTAT data.
6 properties
1 required
DatabaseConnectionDetails
object
The connection details required to connect to the database.
2 properties
2 required
AwrDbTopWaitEventCollection
object
The AWR top wait event data.
ExternalAsmInstanceCollection
object
A collection of external ASM instances.
1 property
1 required
AssociatedCloudComponent
object
The details of the associated component.
3 properties
2 required
UpdateExternalExadataStorageGridDetails
object
The details required to update an Exadata storage server grid.
2 properties
NamedCredentialSummary
object
A summary of the named credential.
13 properties
10 required
ChangeManagedDatabaseGroupCompartmentDetails
object
The details required to change the compartment of a Managed Database Group.
1 property
1 required
SqlPlanBaselineConfiguration
object
The configuration details of SQL plan baselines. The details include: - whether automatic initial plan capture is enabled or disabled - whether use of SQL plan…
10 properties
6 required
ExternalDbNodeSummary
object
The summary of an external database node.
14 properties
8 required
DataPoints
object
The aggregated datapoints of the metric.
2 properties
DatabaseUsageMetrics
object
The list of aggregated metrics for Managed Databases in the fleet.
15 properties
UpdateManagedDatabaseDetails
object
The details required to update a Managed Database.
2 properties
EnableCloudDbSystemStackMonitoringDetails
The details required to enable Stack Monitoring for a cloud DB system.
CloudOpenAlertHistory
object
The existing open alerts in the Exadata storage server.
1 property
1 required
ChangeSpaceBudgetDetails
object
The details required to change the disk space limit for the SQL Management Base. It takes either credentials or databaseCredential. It's recommended to provide…
3 properties
1 required
JobRunCollection
object
A collection of job run objects.
1 property
1 required
ManagedDatabaseCollection
object
A collection of Managed Database objects.
1 property
1 required
JobRunSummary
object
A summary of a specific job run.
10 properties
8 required
CloudDbSystemDatabaseManagementConfigDetails
The configuration details of Database Management for a cloud DB system.
AddmTaskSummary
object
The object containing the ADDM task metadata.
12 properties
2 required
ExternalDbSystemDiscoverySummary
object
The summary of an external DB system.
11 properties
7 required
UpdateDbManagementPrivateEndpointDetails
object
The details used to update a Database Management private endpoint.
6 properties
TestPreferredCredentialDetails
object
The status of the preferred credential test. The status is 'SUCCEEDED' if the preferred credential is working else the status is 'FAILED'.
1 property
1 required
TablespaceAdminStatus
object
The status of a tablespace admin action.
3 properties
1 required
UpdateExternalExadataStorageConnectorDetails
object
The connector details of the Exadata storage server to be updated.
5 properties
ExternalListener
object
The details of an external listener.
28 properties
8 required
AddmTasksCollection
object
The list of ADDM task metadata.
2 properties
2 required
DbmResource
object
The base Exadata resource.
11 properties
3 required
PatchInstruction
object
A single instruction to be included as part of Patch request content.
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
Other APIs Oracle publishes across the network.
Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
#dbManagement
Where this information came from
This is an independent, third-party profile of Oracle Db Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.