Database Management Functions

ADD_DATA_FILES Function

Adds data files or temp files to the tablespace.

Syntax

FUNCTION add_data_files (
  managed_database_id varchar2,
  tablespace_name varchar2,
  add_data_files_details dbms_cloud_oci_database_management_add_data_files_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_add_data_files_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`tablespace_name`	(required) The name of the tablespace.
`add_data_files_details`	(required) The details required to add data files or temp files to the tablespace.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_MANAGED_DATABASE_TO_MANAGED_DATABASE_GROUP Function

Adds a Managed Database to a specific Managed Database Group. After the database is added, it will be included in the management activities performed on the Managed Database Group.

Syntax

FUNCTION add_managed_database_to_managed_database_group (
  managed_database_group_id varchar2,
  add_managed_database_to_managed_database_group_details dbms_cloud_oci_database_management_add_managed_database_to_managed_database_group_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_add_managed_database_to_managed_database_group_response_t;

Parameters

Parameter	Description
`managed_database_group_id`	(required) The OCID of the Managed Database Group.
`add_managed_database_to_managed_database_group_details`	(required) The Managed Database details required to add the Managed Database to a Managed Database Group.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADDM_TASKS Function

Lists the metadata for each ADDM task who's end snapshot time falls within the provided start and end time. Details include the name of the ADDM task, description, user, status and creation date time.

Syntax

FUNCTION addm_tasks (
  managed_database_id varchar2,
  time_start timestamp with time zone,
  time_end timestamp with time zone,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_addm_tasks_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`time_start`	(required) The beginning of the time range to search for ADDM tasks as defined by date-time RFC3339 format.
`time_end`	(required) The end of the time range to search for ADDM tasks as defined by date-time RFC3339 format.
`opc_request_id`	(optional) Unique identifier for the request.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The option to sort the list of ADDM tasks. Allowed values are: 'TASK_NAME', 'TASK_ID', 'DESCRIPTION', 'DB_USER', 'STATUS', 'TIME_CREATED', 'BEGIN_TIME', 'END_TIME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DATABASE_PARAMETERS Function

Changes database parameter values. There are two kinds of database parameters: - Dynamic parameters: They can be changed for the current Oracle Database instance. The changes take effect immediately. - Static parameters: They cannot be changed for the current instance. You must change these parameters and then restart the database before changes take effect. **Note:** If the instance is started using a text initialization parameter file, the parameter changes are applicable only for the current instance. You must update them manually to be passed to a future instance.

Syntax

FUNCTION change_database_parameters (
  managed_database_id varchar2,
  change_database_parameters_details dbms_cloud_oci_database_management_change_database_parameters_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_change_database_parameters_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`change_database_parameters_details`	(required) The details required to change database parameter values.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DB_MANAGEMENT_PRIVATE_ENDPOINT_COMPARTMENT Function

Moves the Database Management private endpoint and its dependent resources to the specified compartment.

Syntax

FUNCTION change_db_management_private_endpoint_compartment (
  db_management_private_endpoint_id varchar2,
  change_db_management_private_endpoint_compartment_details dbms_cloud_oci_database_management_change_db_management_private_endpoint_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_change_db_management_private_endpoint_compartment_response_t;

Parameters

Parameter	Description
`db_management_private_endpoint_id`	(required) The OCID of the Database Management private endpoint.
`change_db_management_private_endpoint_compartment_details`	(required) The details used to move the Database Management private endpoint to another compartment.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_EXTERNAL_DB_SYSTEM_COMPARTMENT Function

Moves the external DB system and its related resources (excluding databases) to the specified compartment.

Syntax

FUNCTION change_external_db_system_compartment (
  external_db_system_id varchar2,
  change_external_db_system_compartment_details dbms_cloud_oci_database_management_change_external_db_system_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_change_external_db_system_compartment_response_t;

Parameters

Parameter	Description
`external_db_system_id`	(required) The OCID of the external DB system.
`change_external_db_system_compartment_details`	(required) The OCID of the compartment to which the external DB system should be moved.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_EXTERNAL_EXADATA_INFRASTRUCTURE_COMPARTMENT Function

Moves the Exadata infrastructure and its related resources (Exadata storage server, Exadata storage server connectors and Exadata storage server grid) to the specified compartment.

Syntax

FUNCTION change_external_exadata_infrastructure_compartment (
  external_exadata_infrastructure_id varchar2,
  change_external_exadata_infrastructure_compartment_details dbms_cloud_oci_database_management_change_external_exadata_infrastructure_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_change_external_exadata_infrastructure_compartment_response_t;

Parameters

Parameter	Description
`external_exadata_infrastructure_id`	(required) The OCID of the Exadata infrastructure.
`change_external_exadata_infrastructure_compartment_details`	(required) The details required to move the Exadata infrastructure from one compartment to another.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_JOB_COMPARTMENT Function

Moves a job.

Syntax

FUNCTION change_job_compartment (
  job_id varchar2,
  change_job_compartment_details dbms_cloud_oci_database_management_change_job_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_change_job_compartment_response_t;

Parameters

Parameter	Description
`job_id`	(required) The identifier of the job.
`change_job_compartment_details`	(required) The OCID of the compartment to move the job to.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_MANAGED_DATABASE_GROUP_COMPARTMENT Function

Moves a Managed Database Group to a different compartment. The destination compartment must not have a Managed Database Group with the same name.

Syntax

FUNCTION change_managed_database_group_compartment (
  managed_database_group_id varchar2,
  change_managed_database_group_compartment_details dbms_cloud_oci_database_management_change_managed_database_group_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_change_managed_database_group_compartment_response_t;

Parameters

Parameter	Description
`managed_database_group_id`	(required) The OCID of the Managed Database Group.
`change_managed_database_group_compartment_details`	(required) The OCID of the compartment to move the Managed Database Group to.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_PLAN_RETENTION Function

Changes the retention period of unused plans. The period can range between 5 and 523 weeks. The database purges plans that have not been used for longer than the plan retention period.

Syntax

FUNCTION change_plan_retention (
  managed_database_id varchar2,
  change_plan_retention_details dbms_cloud_oci_database_management_change_plan_retention_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_change_plan_retention_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`change_plan_retention_details`	(required) The details required to change the plan retention period.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SPACE_BUDGET Function

Changes the disk space limit for the SQL Management Base. The allowable range for this limit is between 1% and 50%.

Syntax

FUNCTION change_space_budget (
  managed_database_id varchar2,
  change_space_budget_details dbms_cloud_oci_database_management_change_space_budget_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_change_space_budget_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`change_space_budget_details`	(required) The details required to change the disk space limit for the SQL Management Base.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SQL_PLAN_BASELINES_ATTRIBUTES Function

Changes one or more attributes of a single plan or all plans associated with a SQL statement.

Syntax

FUNCTION change_sql_plan_baselines_attributes (
  managed_database_id varchar2,
  change_sql_plan_baselines_attributes_details dbms_cloud_oci_database_management_change_sql_plan_baselines_attributes_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_change_sql_plan_baselines_attributes_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`change_sql_plan_baselines_attributes_details`	(required) The details required to change SQL plan baseline attributes.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHECK_EXTERNAL_DB_SYSTEM_CONNECTOR_CONNECTION_STATUS Function

Checks the status of the external DB system component connection specified in this connector. This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.

Syntax

FUNCTION check_external_db_system_connector_connection_status (
  external_db_system_connector_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_check_external_db_system_connector_connection_status_response_t;

Parameters

Parameter	Description
`external_db_system_connector_id`	(required) The OCID of the external connector.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHECK_EXTERNAL_EXADATA_STORAGE_CONNECTOR Function

Checks the status of the Exadata storage server connection specified by exadataStorageConnectorId.

Syntax

FUNCTION check_external_exadata_storage_connector (
  external_exadata_storage_connector_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_check_external_exadata_storage_connector_response_t;

Parameters

Parameter	Description
`external_exadata_storage_connector_id`	(required) The OCID of the connector to the Exadata storage server.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CONFIGURE_AUTOMATIC_CAPTURE_FILTERS Function

Configures automatic capture filters to capture only those statements that match the filter criteria.

Syntax

FUNCTION configure_automatic_capture_filters (
  managed_database_id varchar2,
  configure_automatic_capture_filters_details dbms_cloud_oci_database_management_configure_automatic_capture_filters_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_configure_automatic_capture_filters_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`configure_automatic_capture_filters_details`	(required) The details required to configure automatic capture filters.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CONFIGURE_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function

Configures the Automatic SPM Evolve Advisor task `SYS_AUTO_SPM_EVOLVE_TASK` by specifying task parameters. As the task is owned by `SYS`, only `SYS` can set task parameters.

Syntax

FUNCTION configure_automatic_spm_evolve_advisor_task (
  managed_database_id varchar2,
  configure_automatic_spm_evolve_advisor_task_details dbms_cloud_oci_database_management_configure_automatic_spm_evolve_advisor_task_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_configure_automatic_spm_evolve_advisor_task_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`configure_automatic_spm_evolve_advisor_task_details`	(required) The configuration details of the Automatic SPM Evolve Advisor task.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DB_MANAGEMENT_PRIVATE_ENDPOINT Function

Creates a new Database Management private endpoint.

Syntax

FUNCTION create_db_management_private_endpoint (
  create_db_management_private_endpoint_details dbms_cloud_oci_database_management_create_db_management_private_endpoint_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_create_db_management_private_endpoint_response_t;

Parameters

Parameter	Description
`create_db_management_private_endpoint_details`	(required) Details used to create a new Database Management private endpoint.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_EXTERNAL_DB_SYSTEM Function

Creates an external DB system and its related resources.

Syntax

FUNCTION create_external_db_system (
  create_external_db_system_details dbms_cloud_oci_database_management_create_external_db_system_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_create_external_db_system_response_t;

Parameters

Parameter	Description
`create_external_db_system_details`	(required) The details required to create an external DB system.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_EXTERNAL_DB_SYSTEM_CONNECTOR Function

Creates a new external connector.

Syntax

FUNCTION create_external_db_system_connector (
  create_external_db_system_connector_details dbms_cloud_oci_database_management_create_external_db_system_connector_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_create_external_db_system_connector_response_t;

Parameters

Parameter	Description
`create_external_db_system_connector_details`	(required) The details required to create an external connector.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_EXTERNAL_DB_SYSTEM_DISCOVERY Function

Creates an external DB system discovery resource and initiates the discovery process.

Syntax

FUNCTION create_external_db_system_discovery (
  create_external_db_system_discovery_details dbms_cloud_oci_database_management_create_external_db_system_discovery_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_create_external_db_system_discovery_response_t;

Parameters

Parameter	Description
`create_external_db_system_discovery_details`	(required) The details required to create an external DB system discovery.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_EXTERNAL_EXADATA_INFRASTRUCTURE Function

Creates an OCI resource for the Exadata infrastructure and enables the Monitoring service for the Exadata infrastructure. The following resource/subresources are created: Infrastructure Storage server connectors Storage servers Storage grids

Syntax

FUNCTION create_external_exadata_infrastructure (
  create_external_exadata_infrastructure_details dbms_cloud_oci_database_management_create_external_exadata_infrastructure_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_create_external_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`create_external_exadata_infrastructure_details`	(required) The details required to create the managed Exadata infrastructure resources.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_EXTERNAL_EXADATA_STORAGE_CONNECTOR Function

Creates the Exadata storage server connector after validating the connection information.

Syntax

FUNCTION create_external_exadata_storage_connector (
  create_external_exadata_storage_connector_details dbms_cloud_oci_database_management_create_external_exadata_storage_connector_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_create_external_exadata_storage_connector_response_t;

Parameters

Parameter	Description
`create_external_exadata_storage_connector_details`	(required) The details required to add connections to the Exadata storage servers.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_JOB Function

Creates a job to be executed on a Managed Database or Managed Database Group. Only one of the parameters, managedDatabaseId or managedDatabaseGroupId should be provided as input in CreateJobDetails resource in request body.

Syntax

FUNCTION create_job (
  create_job_details dbms_cloud_oci_database_management_create_job_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_create_job_response_t;

Parameters

Parameter	Description
`create_job_details`	(required) The details required to create a job.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MANAGED_DATABASE_GROUP Function

Creates a Managed Database Group. The group does not contain any Managed Databases when it is created, and they must be added later.

Syntax

FUNCTION create_managed_database_group (
  create_managed_database_group_details dbms_cloud_oci_database_management_create_managed_database_group_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_create_managed_database_group_response_t;

Parameters

Parameter	Description
`create_managed_database_group_details`	(required) The details required to create a Managed Database Group.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_TABLESPACE Function

Creates a tablespace within the Managed Database specified by managedDatabaseId.

Syntax

FUNCTION create_tablespace (
  managed_database_id varchar2,
  create_tablespace_details dbms_cloud_oci_database_management_create_tablespace_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_create_tablespace_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`create_tablespace_details`	(required) The details required to create a tablespace.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DB_MANAGEMENT_PRIVATE_ENDPOINT Function

Deletes a specific Database Management private endpoint.

Syntax

FUNCTION delete_db_management_private_endpoint (
  db_management_private_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_delete_db_management_private_endpoint_response_t;

Parameters

Parameter	Description
`db_management_private_endpoint_id`	(required) The OCID of the Database Management private endpoint.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_EXTERNAL_DB_SYSTEM Function

Deletes the external DB system specified by `externalDbSystemId`.

Syntax

FUNCTION delete_external_db_system (
  external_db_system_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_delete_external_db_system_response_t;

Parameters

Parameter	Description
`external_db_system_id`	(required) The OCID of the external DB system.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_EXTERNAL_DB_SYSTEM_CONNECTOR Function

Deletes the external connector specified by `externalDbSystemConnectorId`.

Syntax

FUNCTION delete_external_db_system_connector (
  external_db_system_connector_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_delete_external_db_system_connector_response_t;

Parameters

Parameter	Description
`external_db_system_connector_id`	(required) The OCID of the external connector.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_EXTERNAL_DB_SYSTEM_DISCOVERY Function

Deletes the external DB system discovery resource specified by `externalDbSystemDiscoveryId`.

Syntax

FUNCTION delete_external_db_system_discovery (
  external_db_system_discovery_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_delete_external_db_system_discovery_response_t;

Parameters

Parameter	Description
`external_db_system_discovery_id`	(required) The OCID of the external DB system discovery.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_EXTERNAL_EXADATA_INFRASTRUCTURE Function

Deletes the Exadata infrastructure specified by externalExadataInfrastructureId.

Syntax

FUNCTION delete_external_exadata_infrastructure (
  external_exadata_infrastructure_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_delete_external_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`external_exadata_infrastructure_id`	(required) The OCID of the Exadata infrastructure.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_EXTERNAL_EXADATA_STORAGE_CONNECTOR Function

Deletes the Exadata storage server connector specified by exadataStorageConnectorId.

Syntax

FUNCTION delete_external_exadata_storage_connector (
  external_exadata_storage_connector_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_delete_external_exadata_storage_connector_response_t;

Parameters

Parameter	Description
`external_exadata_storage_connector_id`	(required) The OCID of the connector to the Exadata storage server.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_JOB Function

Deletes the job specified by jobId.

Syntax

FUNCTION delete_job (
  job_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_delete_job_response_t;

Parameters

Parameter	Description
`job_id`	(required) The identifier of the job.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_MANAGED_DATABASE_GROUP Function

Deletes the Managed Database Group specified by managedDatabaseGroupId. If the group contains Managed Databases, then it cannot be deleted.

Syntax

FUNCTION delete_managed_database_group (
  managed_database_group_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_delete_managed_database_group_response_t;

Parameters

Parameter	Description
`managed_database_group_id`	(required) The OCID of the Managed Database Group.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_PREFERRED_CREDENTIAL Function

Deletes the preferred credential based on the credentialName.

Syntax

FUNCTION delete_preferred_credential (
  managed_database_id varchar2,
  l_credential_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_delete_preferred_credential_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`l_credential_name`	(required) The name of the preferred credential.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISABLE_AUTOMATIC_INITIAL_PLAN_CAPTURE Function

Disables automatic initial plan capture.

Syntax

FUNCTION disable_automatic_initial_plan_capture (
  managed_database_id varchar2,
  disable_automatic_initial_plan_capture_details dbms_cloud_oci_database_management_disable_automatic_initial_plan_capture_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_disable_automatic_initial_plan_capture_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`disable_automatic_initial_plan_capture_details`	(required) The details required to disable automatic initial plan capture.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISABLE_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function

Disables the Automatic SPM Evolve Advisor task. One client controls both Automatic SQL Tuning Advisor and Automatic SPM Evolve Advisor. Thus, the same task enables or disables both.

Syntax

FUNCTION disable_automatic_spm_evolve_advisor_task (
  managed_database_id varchar2,
  disable_automatic_spm_evolve_advisor_task_details dbms_cloud_oci_database_management_disable_automatic_spm_evolve_advisor_task_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_disable_automatic_spm_evolve_advisor_task_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`disable_automatic_spm_evolve_advisor_task_details`	(required) The details required to disable Automatic SPM Evolve Advisor task.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISABLE_EXTERNAL_DB_SYSTEM_DATABASE_MANAGEMENT Function

Disables Database Management service for all the components of the specified external DB system (except databases).

Syntax

FUNCTION disable_external_db_system_database_management (
  external_db_system_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_disable_external_db_system_database_management_response_t;

Parameters

Parameter	Description
`external_db_system_id`	(required) The OCID of the external DB system.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISABLE_EXTERNAL_DB_SYSTEM_STACK_MONITORING Function

Disables Stack Monitoring for all the components of the specified external DB system (except databases).

Syntax

FUNCTION disable_external_db_system_stack_monitoring (
  external_db_system_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_disable_external_db_system_stack_monitoring_response_t;

Parameters

Parameter	Description
`external_db_system_id`	(required) The OCID of the external DB system.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISABLE_EXTERNAL_EXADATA_INFRASTRUCTURE_MANAGEMENT Function

Disables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId. It covers the following components: - Exadata infrastructure - Exadata storage grid - Exadata storage server Note that Database Management will not be disabled for the DB systems within the Exadata infrastructure and should be disabled explicitly, if required.

Syntax

FUNCTION disable_external_exadata_infrastructure_management (
  external_exadata_infrastructure_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_disable_external_exadata_infrastructure_management_response_t;

Parameters

Parameter	Description
`external_exadata_infrastructure_id`	(required) The OCID of the Exadata infrastructure.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISABLE_HIGH_FREQUENCY_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function

Disables the high-frequency Automatic SPM Evolve Advisor task. It is available only on Oracle Exadata Database Machine, Oracle Database Exadata Cloud Service (ExaCS) and Oracle Database Exadata Cloud@Customer (ExaCC).

Syntax

FUNCTION disable_high_frequency_automatic_spm_evolve_advisor_task (
  managed_database_id varchar2,
  disable_high_frequency_automatic_spm_evolve_advisor_task_details dbms_cloud_oci_database_management_disable_high_frequency_automatic_spm_evolve_advisor_task_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_disable_high_frequency_automatic_spm_evolve_advisor_task_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`disable_high_frequency_automatic_spm_evolve_advisor_task_details`	(required) The details required to disable high frequency Automatic SPM Evolve Advisor task.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISABLE_SQL_PLAN_BASELINES_USAGE Function

Disables the use of SQL plan baselines stored in SQL Management Base. When disabled, the optimizer does not use any SQL plan baselines.

Syntax

FUNCTION disable_sql_plan_baselines_usage (
  managed_database_id varchar2,
  disable_sql_plan_baselines_usage_details dbms_cloud_oci_database_management_disable_sql_plan_baselines_usage_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_disable_sql_plan_baselines_usage_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`disable_sql_plan_baselines_usage_details`	(required) The details required to disable SQL plan baseline usage.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISCOVER_EXTERNAL_EXADATA_INFRASTRUCTURE Function

Completes the Exadata system prechecking on the following: - Verifies if the DB systems are valid RAC DB systems or return 400 status code with NON_RAC_DATABASE_SYSTEM error code. - Verifies if the ASM connector defined for each DB system or return 400 status code with CONNECTOR_NOT_DEFINED error code. - Verifies if the agents associated with ASM are valid and could be used for the Exadata storage servers or return 400 status code with INVALID_AGENT error code. - Verifies if it is an Exadata system or return 400 status code with INVALID_EXADATA_SYSTEM error code. Starts the discovery process for the Exadata system infrastructure. The following resources/components are discovered - Exadata storage servers from each DB systems - Exadata storage grid for all Exadata storage servers - Exadata infrastructure The same API covers both new discovery and rediscovery cases. For the new discovery case, new managed resources/sub-resources are created or the existing ones are overridden. For rediscovery case, the existing managed resources/sub-resources are checked to find out which ones should be added or which ones should be removed based on the unique key defined for each resource/sub-resource.

Syntax

FUNCTION discover_external_exadata_infrastructure (
  discover_external_exadata_infrastructure_details dbms_cloud_oci_database_management_discover_external_exadata_infrastructure_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_discover_external_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`discover_external_exadata_infrastructure_details`	(required) The details required to discover and monitor the Exadata infrastructure.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DROP_SQL_PLAN_BASELINES Function

Drops a single plan or all plans associated with a SQL statement.

Syntax

FUNCTION drop_sql_plan_baselines (
  managed_database_id varchar2,
  drop_sql_plan_baselines_details dbms_cloud_oci_database_management_drop_sql_plan_baselines_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_drop_sql_plan_baselines_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`drop_sql_plan_baselines_details`	(required) The details required to drop SQL plan baselines.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DROP_TABLESPACE Function

Drops the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.

Syntax

FUNCTION drop_tablespace (
  managed_database_id varchar2,
  tablespace_name varchar2,
  drop_tablespace_details dbms_cloud_oci_database_management_drop_tablespace_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_drop_tablespace_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`tablespace_name`	(required) The name of the tablespace.
`drop_tablespace_details`	(required) The details required to drop a tablespace.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_AUTOMATIC_INITIAL_PLAN_CAPTURE Function

Enables automatic initial plan capture. When enabled, the database checks whether executed SQL statements are eligible for automatic capture. It creates initial plan baselines for eligible statements. By default, the database creates a SQL plan baseline for every eligible repeatable statement, including all recursive SQL and monitoring SQL. Thus, automatic capture may result in the creation of an extremely large number of plan baselines. To limit the statements that are eligible for plan baselines, configure filters.

Syntax

FUNCTION enable_automatic_initial_plan_capture (
  managed_database_id varchar2,
  enable_automatic_initial_plan_capture_details dbms_cloud_oci_database_management_enable_automatic_initial_plan_capture_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_enable_automatic_initial_plan_capture_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`enable_automatic_initial_plan_capture_details`	(required) The details required to enable automatic initial plan capture.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function

Enables the Automatic SPM Evolve Advisor task. By default, the automatic task `SYS_AUTO_SPM_EVOLVE_TASK` runs every day in the scheduled maintenance window. The SPM Evolve Advisor performs the following tasks: - Checks AWR for top SQL - Looks for alternative plans in all available sources - Adds unaccepted plans to the plan history - Tests the execution of as many plans as possible during the maintenance window - Adds the alternative plan to the baseline if it performs better than the current plan One client controls both Automatic SQL Tuning Advisor and Automatic SPM Evolve Advisor. Thus, the same task enables or disables both.

Syntax

FUNCTION enable_automatic_spm_evolve_advisor_task (
  managed_database_id varchar2,
  enable_automatic_spm_evolve_advisor_task_details dbms_cloud_oci_database_management_enable_automatic_spm_evolve_advisor_task_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_enable_automatic_spm_evolve_advisor_task_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`enable_automatic_spm_evolve_advisor_task_details`	(required) The details required to enable Automatic SPM Evolve Advisor task.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_EXTERNAL_DB_SYSTEM_DATABASE_MANAGEMENT Function

Enables Database Management service for all the components of the specified external DB system (except databases).

Syntax

FUNCTION enable_external_db_system_database_management (
  external_db_system_id varchar2,
  enable_external_db_system_database_management_details dbms_cloud_oci_database_management_enable_external_db_system_database_management_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_enable_external_db_system_database_management_response_t;

Parameters

Parameter	Description
`external_db_system_id`	(required) The OCID of the external DB system.
`enable_external_db_system_database_management_details`	(required) The details required to enable Database Management for an external DB system.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_EXTERNAL_DB_SYSTEM_STACK_MONITORING Function

Enables Stack Monitoring for all the components of the specified external DB system (except databases).

Syntax

FUNCTION enable_external_db_system_stack_monitoring (
  external_db_system_id varchar2,
  enable_external_db_system_stack_monitoring_details dbms_cloud_oci_database_management_enable_external_db_system_stack_monitoring_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_enable_external_db_system_stack_monitoring_response_t;

Parameters

Parameter	Description
`external_db_system_id`	(required) The OCID of the external DB system.
`enable_external_db_system_stack_monitoring_details`	(required) The details required to enable Stack Monitoring for an external DB system.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_EXTERNAL_EXADATA_INFRASTRUCTURE_MANAGEMENT Function

Enables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId. It covers the following components: - Exadata infrastructure - Exadata storage grid - Exadata storage server

Syntax

FUNCTION enable_external_exadata_infrastructure_management (
  external_exadata_infrastructure_id varchar2,
  enable_external_exadata_infrastructure_management_details dbms_cloud_oci_database_management_enable_external_exadata_infrastructure_management_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_enable_external_exadata_infrastructure_management_response_t;

Parameters

Parameter	Description
`external_exadata_infrastructure_id`	(required) The OCID of the Exadata infrastructure.
`enable_external_exadata_infrastructure_management_details`	(required) The details required to enable management for the Exadata infrastructure.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_HIGH_FREQUENCY_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function

Enables the high-frequency Automatic SPM Evolve Advisor task. The high-frequency task runs every hour and runs for no longer than 30 minutes. These settings are not configurable. The high-frequency task complements the standard Automatic SPM Evolve Advisor task. They are independent and are scheduled through two different frameworks. It is available only on Oracle Exadata Database Machine, Oracle Database Exadata Cloud Service (ExaCS) and Oracle Database Exadata Cloud@Customer (ExaCC).

Syntax

FUNCTION enable_high_frequency_automatic_spm_evolve_advisor_task (
  managed_database_id varchar2,
  enable_high_frequency_automatic_spm_evolve_advisor_task_details dbms_cloud_oci_database_management_enable_high_frequency_automatic_spm_evolve_advisor_task_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_enable_high_frequency_automatic_spm_evolve_advisor_task_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`enable_high_frequency_automatic_spm_evolve_advisor_task_details`	(required) The details required to enable high frequency Automatic SPM Evolve Advisor task.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_SQL_PLAN_BASELINES_USAGE Function

Enables the use of SQL plan baselines stored in SQL Management Base. When enabled, the optimizer uses SQL plan baselines to select plans to avoid potential performance regressions.

Syntax

FUNCTION enable_sql_plan_baselines_usage (
  managed_database_id varchar2,
  enable_sql_plan_baselines_usage_details dbms_cloud_oci_database_management_enable_sql_plan_baselines_usage_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_enable_sql_plan_baselines_usage_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`enable_sql_plan_baselines_usage_details`	(required) The details required to enable SQL plan baseline usage.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GENERATE_AWR_SNAPSHOT Function

Creates an AWR snapshot for the target database.

Syntax

FUNCTION generate_awr_snapshot (
  managed_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_generate_awr_snapshot_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AWR_DB_REPORT Function

Gets the AWR report for the specific database.

Syntax

FUNCTION get_awr_db_report (
  managed_database_id varchar2,
  awr_db_id varchar2,
  inst_nums dbms_cloud_oci_database_management_number_tbl DEFAULT NULL,
  begin_sn_id_greater_than_or_equal_to number DEFAULT NULL,
  end_sn_id_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  report_type varchar2 DEFAULT NULL,
  container_id number DEFAULT NULL,
  report_format varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_awr_db_report_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`awr_db_id`	(required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs
`inst_nums`	(optional) The optional multiple value query parameter to filter the database instance numbers.
`begin_sn_id_greater_than_or_equal_to`	(optional) The optional greater than or equal to filter on the snapshot ID.
`end_sn_id_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the snapshot ID.
`time_greater_than_or_equal_to`	(optional) The optional greater than or equal to query parameter to filter the timestamp.
`time_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the timestamp.
`report_type`	(optional) The query parameter to filter the AWR report types. Allowed values are: 'AWR', 'ASH'
`container_id`	(optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
`report_format`	(optional) The format of the AWR report. Allowed values are: 'HTML', 'TEXT'
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AWR_DB_SQL_REPORT Function

Gets the SQL health check report for one SQL of the specific database.

Syntax

FUNCTION get_awr_db_sql_report (
  managed_database_id varchar2,
  awr_db_id varchar2,
  sql_id varchar2,
  inst_num varchar2 DEFAULT NULL,
  begin_sn_id_greater_than_or_equal_to number DEFAULT NULL,
  end_sn_id_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  report_format varchar2 DEFAULT NULL,
  container_id number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_awr_db_sql_report_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`awr_db_id`	(required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs
`sql_id`	(required) The parameter to filter SQL by ID. Note that the SQL ID is generated internally by Oracle for each SQL statement and can be retrieved from AWR Report API (/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbReport) or Performance Hub API (/internal/managedDatabases/{managedDatabaseId}/actions/retrievePerformanceData)
`inst_num`	(optional) The optional single value query parameter to filter the database instance number.
`begin_sn_id_greater_than_or_equal_to`	(optional) The optional greater than or equal to filter on the snapshot ID.
`end_sn_id_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the snapshot ID.
`time_greater_than_or_equal_to`	(optional) The optional greater than or equal to query parameter to filter the timestamp.
`time_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the timestamp.
`report_format`	(optional) The format of the AWR report. Allowed values are: 'HTML', 'TEXT'
`container_id`	(optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CLUSTER_CACHE_METRIC Function

Gets the metrics related to cluster cache for the Oracle Real Application Clusters (Oracle RAC) database specified by managedDatabaseId.

Syntax

FUNCTION get_cluster_cache_metric (
  managed_database_id varchar2,
  start_time varchar2,
  end_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_cluster_cache_metric_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`start_time`	(required) The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`end_time`	(required) The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DATABASE_FLEET_HEALTH_METRICS Function

Gets the health metrics for a fleet of databases in a compartment or in a Managed Database Group. Either the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the health metrics.

Syntax

FUNCTION get_database_fleet_health_metrics (
  compare_baseline_time varchar2,
  compare_target_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  managed_database_group_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  compare_type varchar2 DEFAULT NULL,
  filter_by_metric_names varchar2 DEFAULT NULL,
  filter_by_database_type varchar2 DEFAULT NULL,
  filter_by_database_sub_type varchar2 DEFAULT NULL,
  filter_by_database_deployment_type varchar2 DEFAULT NULL,
  filter_by_database_version varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_database_fleet_health_metrics_response_t;

Parameters

Parameter	Description
`compare_baseline_time`	(required) The baseline time for metrics comparison.
`compare_target_time`	(required) The target time for metrics comparison.
`opc_request_id`	(optional) The client request ID for tracing.
`managed_database_group_id`	(optional) The OCID of the Managed Database Group.
`compartment_id`	(optional) The OCID of the compartment.
`compare_type`	(optional) The time window used for metrics comparison. Allowed values are: 'HOUR', 'DAY', 'WEEK'
`filter_by_metric_names`	(optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.
`filter_by_database_type`	(optional) The filter used to filter the databases in the fleet by a specific Oracle Database type.
`filter_by_database_sub_type`	(optional) The filter used to filter the databases in the fleet by a specific Oracle Database subtype.
`filter_by_database_deployment_type`	(optional) The filter used to filter the databases in the fleet by a specific Oracle Database deployment type.
`filter_by_database_version`	(optional) The filter used to filter the databases in the fleet by a specific Oracle Database version.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DATABASE_HOME_METRICS Function

Gets a summary of the activity and resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory for a Managed Database.

Syntax

FUNCTION get_database_home_metrics (
  managed_database_id varchar2,
  start_time varchar2,
  end_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_database_home_metrics_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`start_time`	(required) The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`end_time`	(required) The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DB_MANAGEMENT_PRIVATE_ENDPOINT Function

Gets the details of a specific Database Management private endpoint.

Syntax

FUNCTION get_db_management_private_endpoint (
  db_management_private_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_db_management_private_endpoint_response_t;

Parameters

Parameter	Description
`db_management_private_endpoint_id`	(required) The OCID of the Database Management private endpoint.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_ASM Function

Gets the details for the external ASM specified by `externalAsmId`.

Syntax

FUNCTION get_external_asm (
  external_asm_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_asm_response_t;

Parameters

Parameter	Description
`external_asm_id`	(required) The OCID of the external ASM.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_ASM_CONFIGURATION Function

Gets configuration details including disk groups for the external ASM specified by `externalAsmId`.

Syntax

FUNCTION get_external_asm_configuration (
  external_asm_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_asm_configuration_response_t;

Parameters

Parameter	Description
`external_asm_id`	(required) The OCID of the external ASM.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_ASM_INSTANCE Function

Gets the details for the external ASM instance specified by `externalAsmInstanceId`.

Syntax

FUNCTION get_external_asm_instance (
  external_asm_instance_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_asm_instance_response_t;

Parameters

Parameter	Description
`external_asm_instance_id`	(required) The OCID of the external ASM instance.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_CLUSTER Function

Gets the details for the external cluster specified by `externalClusterId`.

Syntax

FUNCTION get_external_cluster (
  external_cluster_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_cluster_response_t;

Parameters

Parameter	Description
`external_cluster_id`	(required) The OCID of the external cluster.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_CLUSTER_INSTANCE Function

Gets the details for the external cluster instance specified by `externalClusterInstanceId`.

Syntax

FUNCTION get_external_cluster_instance (
  external_cluster_instance_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_cluster_instance_response_t;

Parameters

Parameter	Description
`external_cluster_instance_id`	(required) The OCID of the external cluster instance.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_DB_HOME Function

Gets the details for the external DB home specified by `externalDbHomeId`.

Syntax

FUNCTION get_external_db_home (
  external_db_home_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_db_home_response_t;

Parameters

Parameter	Description
`external_db_home_id`	(required) The OCID of the external database home.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_DB_NODE Function

Gets the details for the external DB node specified by `externalDbNodeId`.

Syntax

FUNCTION get_external_db_node (
  external_db_node_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_db_node_response_t;

Parameters

Parameter	Description
`external_db_node_id`	(required) The OCID of the external database node.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_DB_SYSTEM Function

Gets the details for the external DB system specified by `externalDbSystemId`.

Syntax

FUNCTION get_external_db_system (
  external_db_system_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_db_system_response_t;

Parameters

Parameter	Description
`external_db_system_id`	(required) The OCID of the external DB system.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_DB_SYSTEM_CONNECTOR Function

Gets the details for the external connector specified by `externalDbSystemConnectorId`.

Syntax

FUNCTION get_external_db_system_connector (
  external_db_system_connector_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_db_system_connector_response_t;

Parameters

Parameter	Description
`external_db_system_connector_id`	(required) The OCID of the external connector.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_DB_SYSTEM_DISCOVERY Function

Gets the details for the external DB system discovery resource specified by `externalDbSystemDiscoveryId`.

Syntax

FUNCTION get_external_db_system_discovery (
  external_db_system_discovery_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_db_system_discovery_response_t;

Parameters

Parameter	Description
`external_db_system_discovery_id`	(required) The OCID of the external DB system discovery.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_EXADATA_INFRASTRUCTURE Function

Gets the details for the Exadata infrastructure specified by externalExadataInfrastructureId. It includes the DB systems and storage grid within the Exadata infrastructure.

Syntax

FUNCTION get_external_exadata_infrastructure (
  external_exadata_infrastructure_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`external_exadata_infrastructure_id`	(required) The OCID of the Exadata infrastructure.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_EXADATA_STORAGE_CONNECTOR Function

Gets the details for the Exadata storage server connector specified by exadataStorageConnectorId.

Syntax

FUNCTION get_external_exadata_storage_connector (
  external_exadata_storage_connector_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_exadata_storage_connector_response_t;

Parameters

Parameter	Description
`external_exadata_storage_connector_id`	(required) The OCID of the connector to the Exadata storage server.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_EXADATA_STORAGE_GRID Function

Gets the details for the Exadata storage server grid specified by exadataStorageGridId.

Syntax

FUNCTION get_external_exadata_storage_grid (
  external_exadata_storage_grid_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_exadata_storage_grid_response_t;

Parameters

Parameter	Description
`external_exadata_storage_grid_id`	(required) The OCID of the Exadata storage grid.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_EXADATA_STORAGE_SERVER Function

Gets the summary for the Exadata storage server specified by exadataStorageServerId.

Syntax

FUNCTION get_external_exadata_storage_server (
  external_exadata_storage_server_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_exadata_storage_server_response_t;

Parameters

Parameter	Description
`external_exadata_storage_server_id`	(required) The OCID of the Exadata storage server.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_EXTERNAL_LISTENER Function

Gets the details for the external listener specified by `externalListenerId`.

Syntax

FUNCTION get_external_listener (
  external_listener_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_external_listener_response_t;

Parameters

Parameter	Description
`external_listener_id`	(required) The OCID of the external listener.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_IORM_PLAN Function

Get the IORM plan from the specific Exadata storage server.

Syntax

FUNCTION get_iorm_plan (
  external_exadata_storage_server_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_iorm_plan_response_t;

Parameters

Parameter	Description
`external_exadata_storage_server_id`	(required) The OCID of the Exadata storage server.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB Function

Gets the details for the job specified by jobId.

Syntax

FUNCTION get_job (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_job_response_t;

Parameters

Parameter	Description
`job_id`	(required) The identifier of the job.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB_EXECUTION Function

Gets the details for the job execution specified by jobExecutionId.

Syntax

FUNCTION get_job_execution (
  job_execution_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_job_execution_response_t;

Parameters

Parameter	Description
`job_execution_id`	(required) The identifier of the job execution.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB_RUN Function

Gets the details for the job run specified by jobRunId.

Syntax

FUNCTION get_job_run (
  job_run_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_job_run_response_t;

Parameters

Parameter	Description
`job_run_id`	(required) The identifier of the job run.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MANAGED_DATABASE Function

Gets the details for the Managed Database specified by managedDatabaseId.

Syntax

FUNCTION get_managed_database (
  managed_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_managed_database_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MANAGED_DATABASE_GROUP Function

Gets the details for the Managed Database Group specified by managedDatabaseGroupId.

Syntax

FUNCTION get_managed_database_group (
  managed_database_group_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_managed_database_group_response_t;

Parameters

Parameter	Description
`managed_database_group_id`	(required) The OCID of the Managed Database Group.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_OPEN_ALERT_HISTORY Function

Gets the open alerts from the specified Exadata storage server.

Syntax

FUNCTION get_open_alert_history (
  external_exadata_storage_server_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_open_alert_history_response_t;

Parameters

Parameter	Description
`external_exadata_storage_server_id`	(required) The OCID of the Exadata storage server.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_OPTIMIZER_STATISTICS_ADVISOR_EXECUTION Function

Gets a comprehensive report of the Optimizer Statistics Advisor execution, which includes details of the Managed Database, findings, recommendations, rationale, and examples.

Syntax

FUNCTION get_optimizer_statistics_advisor_execution (
  managed_database_id varchar2,
  execution_name varchar2,
  task_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_optimizer_statistics_advisor_execution_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`execution_name`	(required) The name of the Optimizer Statistics Advisor execution.
`task_name`	(required) The name of the optimizer statistics collection execution task.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_OPTIMIZER_STATISTICS_ADVISOR_EXECUTION_SCRIPT Function

Gets the Oracle system-generated script for the specified Optimizer Statistics Advisor execution.

Syntax

FUNCTION get_optimizer_statistics_advisor_execution_script (
  managed_database_id varchar2,
  execution_name varchar2,
  task_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_optimizer_statistics_advisor_execution_script_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`execution_name`	(required) The name of the Optimizer Statistics Advisor execution.
`task_name`	(required) The name of the optimizer statistics collection execution task.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_OPTIMIZER_STATISTICS_COLLECTION_OPERATION Function

Gets a detailed report of the Optimizer Statistics Collection operation for the specified Managed Database.

Syntax

FUNCTION get_optimizer_statistics_collection_operation (
  managed_database_id varchar2,
  optimizer_statistics_collection_operation_id number,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_optimizer_statistics_collection_operation_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`optimizer_statistics_collection_operation_id`	(required) The ID of the Optimizer Statistics Collection operation.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PDB_METRICS Function

Gets a summary of the resource usage metrics such as CPU, User I/O, and Storage for each PDB within a specific CDB. If comparmentId is specified, then the metrics for each PDB (within the CDB) in the specified compartment are retrieved. If compartmentId is not specified, then the metrics for all the PDBs within the CDB are retrieved.

Syntax

FUNCTION get_pdb_metrics (
  managed_database_id varchar2,
  start_time varchar2,
  end_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  compare_type varchar2 DEFAULT NULL,
  filter_by_metric_names varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_pdb_metrics_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`start_time`	(required) The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`end_time`	(required) The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`opc_request_id`	(optional) The client request ID for tracing.
`compartment_id`	(optional) The OCID of the compartment.
`compare_type`	(optional) The time window used for metrics comparison. Allowed values are: 'HOUR', 'DAY', 'WEEK'
`filter_by_metric_names`	(optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PREFERRED_CREDENTIAL Function

Gets the preferred credential details for a Managed Database based on credentialName.

Syntax

FUNCTION get_preferred_credential (
  managed_database_id varchar2,
  l_credential_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_preferred_credential_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`l_credential_name`	(required) The name of the preferred credential.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SQL_PLAN_BASELINE Function

Gets the SQL plan baseline details for the specified planName.

Syntax

FUNCTION get_sql_plan_baseline (
  managed_database_id varchar2,
  plan_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_sql_plan_baseline_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`plan_name`	(required) The plan name of the SQL plan baseline.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SQL_PLAN_BASELINE_CONFIGURATION Function

Gets the configuration details of SQL plan baselines for the specified Managed Database. The details include the settings for the capture and use of SQL plan baselines, SPM Evolve Advisor task, and SQL Management Base.

Syntax

FUNCTION get_sql_plan_baseline_configuration (
  managed_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_sql_plan_baseline_configuration_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TABLESPACE Function

Gets the details of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.

Syntax

FUNCTION get_tablespace (
  managed_database_id varchar2,
  tablespace_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_tablespace_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`tablespace_name`	(required) The name of the tablespace.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TOP_SQL_CPU_ACTIVITY Function

Gets the SQL IDs with the top CPU activity from the Exadata storage server.

Syntax

FUNCTION get_top_sql_cpu_activity (
  external_exadata_storage_server_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_top_sql_cpu_activity_response_t;

Parameters

Parameter	Description
`external_exadata_storage_server_id`	(required) The OCID of the Exadata storage server.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_USER Function

Gets the details of the user specified by managedDatabaseId and userName.

Syntax

FUNCTION get_user (
  managed_database_id varchar2,
  user_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_user_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`user_name`	(required) The name of the user whose details are to be viewed.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Gets the status of the work request with the given Work Request ID

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous work request.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

IMPLEMENT_OPTIMIZER_STATISTICS_ADVISOR_RECOMMENDATIONS Function

Asynchronously implements the findings and recommendations of the Optimizer Statistics Advisor execution.

Syntax

FUNCTION implement_optimizer_statistics_advisor_recommendations (
  managed_database_id varchar2,
  execution_name varchar2,
  implement_optimizer_statistics_advisor_recommendations_details dbms_cloud_oci_database_management_implement_optimizer_statistics_advisor_recommendations_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_implement_optimizer_statistics_advisor_recommendations_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`execution_name`	(required) The name of the Optimizer Statistics Advisor execution.
`implement_optimizer_statistics_advisor_recommendations_details`	(required) The Optimizer Statistics Advisor recommendations implementation request.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ASM_PROPERTIES Function

Gets the list of ASM properties for the specified managedDatabaseId.

Syntax

FUNCTION list_asm_properties (
  managed_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_asm_properties_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`opc_request_id`	(optional) The client request ID for tracing.
`name`	(optional) A filter to return only resources that match the entire name.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ASSOCIATED_DATABASES Function

Gets the list of databases using a specific Database Management private endpoint.

Syntax

FUNCTION list_associated_databases (
  db_management_private_endpoint_id varchar2,
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_associated_databases_response_t;

Parameters

Parameter	Description
`db_management_private_endpoint_id`	(required) The OCID of the Database Management private endpoint.
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The option to sort databases using a specific Database Management private endpoint. Allowed values are: 'timeRegistered'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AWR_DB_SNAPSHOTS Function

Lists AWR snapshots for the specified database in the AWR.

Syntax

FUNCTION list_awr_db_snapshots (
  managed_database_id varchar2,
  awr_db_id varchar2,
  inst_num varchar2 DEFAULT NULL,
  begin_sn_id_greater_than_or_equal_to number DEFAULT NULL,
  end_sn_id_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  container_id number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_awr_db_snapshots_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`awr_db_id`	(required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs
`inst_num`	(optional) The optional single value query parameter to filter the database instance number.
`begin_sn_id_greater_than_or_equal_to`	(optional) The optional greater than or equal to filter on the snapshot ID.
`end_sn_id_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the snapshot ID.
`time_greater_than_or_equal_to`	(optional) The optional greater than or equal to query parameter to filter the timestamp.
`time_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the timestamp.
`container_id`	(optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The option to sort the AWR snapshot summary data. Allowed values are: 'TIME_BEGIN', 'SNAPSHOT_ID'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AWR_DBS Function

Gets the list of databases and their snapshot summary details available in the AWR of the specified Managed Database.

Syntax

FUNCTION list_awr_dbs (
  managed_database_id varchar2,
  name varchar2 DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_awr_dbs_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`name`	(optional) The optional single value query parameter to filter the entity name.
`time_greater_than_or_equal_to`	(optional) The optional greater than or equal to query parameter to filter the timestamp.
`time_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the timestamp.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The option to sort the AWR summary data. Allowed values are: 'END_INTERVAL_TIME', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CONSUMER_GROUP_PRIVILEGES Function

Gets the list of consumer group privileges granted to a specific user.

Syntax

FUNCTION list_consumer_group_privileges (
  managed_database_id varchar2,
  user_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_consumer_group_privileges_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`user_name`	(required) The name of the user whose details are to be viewed.
`opc_request_id`	(optional) The client request ID for tracing.
`name`	(optional) A filter to return only resources that match the entire name.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CURSOR_CACHE_STATEMENTS Function

Lists the SQL statements from shared SQL area, also called the cursor cache.

Syntax

FUNCTION list_cursor_cache_statements (
  managed_database_id varchar2,
  sql_text varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_cursor_cache_statements_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`sql_text`	(optional) A filter to return all the SQL plan baselines that match the SQL text. By default, the search is case insensitive. To run an exact or case-sensitive search, double-quote the search string. You may also use the '%' symbol as a wildcard.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The option to sort the SQL statement summary data. Allowed values are: 'sqlId', 'schema'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DATA_ACCESS_CONTAINERS Function

Gets the list of containers for a specific user. This is only applicable if ALL_CONTAINERS !='Y'.

Syntax

FUNCTION list_data_access_containers (
  managed_database_id varchar2,
  user_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_data_access_containers_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`user_name`	(required) The name of the user whose details are to be viewed.
`opc_request_id`	(optional) The client request ID for tracing.
`name`	(optional) A filter to return only resources that match the entire name.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DATABASE_PARAMETERS Function

Gets the list of database parameters for the specified Managed Database. The parameters are listed in alphabetical order, along with their current values.

Syntax

FUNCTION list_database_parameters (
  managed_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  source varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  is_allowed_values_included number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_database_parameters_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`opc_request_id`	(optional) The client request ID for tracing.
`source`	(optional) The source used to list database parameters. `CURRENT` is used to get the database parameters that are currently in effect for the database instance. `SPFILE` is used to list parameters from the server parameter file. Default is `CURRENT`. Allowed values are: 'CURRENT', 'SPFILE'
`name`	(optional) A filter to return all parameters that have the text given in their names.
`is_allowed_values_included`	(optional) When true, results include a list of valid values for parameters (if applicable).
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `NAME` is ascending and it is case-sensitive. Allowed values are: 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DB_MANAGEMENT_PRIVATE_ENDPOINTS Function

Gets a list of Database Management private endpoints.

Syntax

FUNCTION list_db_management_private_endpoints (
  compartment_id varchar2,
  name varchar2 DEFAULT NULL,
  vcn_id varchar2 DEFAULT NULL,
  is_cluster number DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_db_management_private_endpoints_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`name`	(optional) A filter to return only resources that match the entire name.
`vcn_id`	(optional) The OCID of the VCN.
`is_cluster`	(optional) The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
`lifecycle_state`	(optional) The lifecycle state of a resource. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_ASM_DISK_GROUPS Function

Lists ASM disk groups for the external ASM specified by `externalAsmId`.

Syntax

FUNCTION list_external_asm_disk_groups (
  external_asm_id varchar2,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_asm_disk_groups_response_t;

Parameters

Parameter	Description
`external_asm_id`	(required) The OCID of the external ASM.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `NAME` is ascending and it is case-sensitive. Allowed values are: 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_ASM_INSTANCES Function

Lists the ASM instances in the specified external ASM.

Syntax

FUNCTION list_external_asm_instances (
  compartment_id varchar2 DEFAULT NULL,
  external_asm_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_asm_instances_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment.
`external_asm_id`	(optional) The OCID of the external ASM.
`display_name`	(optional) A filter to only return the resources that match the entire display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending. The `DISPLAYNAME` sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_ASM_USERS Function

Lists ASM users for the external ASM specified by `externalAsmId`.

Syntax

FUNCTION list_external_asm_users (
  external_asm_id varchar2,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_asm_users_response_t;

Parameters

Parameter	Description
`external_asm_id`	(required) The OCID of the external ASM.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `NAME` is ascending and it is case-sensitive. Allowed values are: 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_ASMS Function

Lists the ASMs in the specified external DB system.

Syntax

FUNCTION list_external_asms (
  compartment_id varchar2 DEFAULT NULL,
  external_db_system_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_asms_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment.
`external_db_system_id`	(optional) The OCID of the external DB system.
`display_name`	(optional) A filter to only return the resources that match the entire display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending. The `DISPLAYNAME` sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_CLUSTER_INSTANCES Function

Lists the cluster instances in the specified external cluster.

Syntax

FUNCTION list_external_cluster_instances (
  compartment_id varchar2 DEFAULT NULL,
  external_cluster_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_cluster_instances_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment.
`external_cluster_id`	(optional) The OCID of the external cluster.
`display_name`	(optional) A filter to only return the resources that match the entire display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending. The `DISPLAYNAME` sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_CLUSTERS Function

Lists the clusters in the specified external DB system.

Syntax

FUNCTION list_external_clusters (
  compartment_id varchar2 DEFAULT NULL,
  external_db_system_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_clusters_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment.
`external_db_system_id`	(optional) The OCID of the external DB system.
`display_name`	(optional) A filter to only return the resources that match the entire display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending. The `DISPLAYNAME` sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_DATABASES Function

Lists the external databases in the specified compartment or in the specified DB system.

Syntax

FUNCTION list_external_databases (
  compartment_id varchar2 DEFAULT NULL,
  external_db_system_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_databases_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment.
`external_db_system_id`	(optional) The OCID of the external DB system.
`display_name`	(optional) A filter to only return the resources that match the entire display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending. The `DISPLAYNAME` sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_DB_HOMES Function

Lists the DB homes in the specified external DB system.

Syntax

FUNCTION list_external_db_homes (
  compartment_id varchar2 DEFAULT NULL,
  external_db_system_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_db_homes_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment.
`external_db_system_id`	(optional) The OCID of the external DB system.
`display_name`	(optional) A filter to only return the resources that match the entire display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending. The `DISPLAYNAME` sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_DB_NODES Function

Lists the external DB nodes in the specified external DB system.

Syntax

FUNCTION list_external_db_nodes (
  compartment_id varchar2 DEFAULT NULL,
  external_db_system_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_db_nodes_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment.
`external_db_system_id`	(optional) The OCID of the external DB system.
`display_name`	(optional) A filter to only return the resources that match the entire display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending. The `DISPLAYNAME` sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_DB_SYSTEM_CONNECTORS Function

Lists the external connectors in the specified external DB system.

Syntax

FUNCTION list_external_db_system_connectors (
  compartment_id varchar2 DEFAULT NULL,
  external_db_system_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_db_system_connectors_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment.
`external_db_system_id`	(optional) The OCID of the external DB system.
`display_name`	(optional) A filter to only return the resources that match the entire display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending. The `DISPLAYNAME` sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_DB_SYSTEM_DISCOVERIES Function

Lists the external DB system discovery resources in the specified compartment.

Syntax

FUNCTION list_external_db_system_discoveries (
  compartment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_db_system_discoveries_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`display_name`	(optional) A filter to only return the resources that match the entire display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending. The `DISPLAYNAME` sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_DB_SYSTEMS Function

Lists the external DB systems in the specified compartment.

Syntax

FUNCTION list_external_db_systems (
  compartment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_db_systems_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`display_name`	(optional) A filter to only return the resources that match the entire display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending. The `DISPLAYNAME` sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_EXADATA_INFRASTRUCTURES Function

Lists the Exadata infrastructure resources in the specified compartment.

Syntax

FUNCTION list_external_exadata_infrastructures (
  compartment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_exadata_infrastructures_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`display_name`	(optional) The optional single value query filter parameter on the entity display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_EXADATA_STORAGE_CONNECTORS Function

Lists the Exadata storage server connectors for the specified Exadata infrastructure.

Syntax

FUNCTION list_external_exadata_storage_connectors (
  compartment_id varchar2,
  external_exadata_infrastructure_id varchar2,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_exadata_storage_connectors_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`external_exadata_infrastructure_id`	(required) The OCID of the Exadata infrastructure.
`display_name`	(optional) The optional single value query filter parameter on the entity display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_EXADATA_STORAGE_SERVERS Function

Lists the Exadata storage servers for the specified Exadata infrastructure.

Syntax

FUNCTION list_external_exadata_storage_servers (
  compartment_id varchar2,
  external_exadata_infrastructure_id varchar2,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_exadata_storage_servers_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`external_exadata_infrastructure_id`	(required) The OCID of the Exadata infrastructure.
`display_name`	(optional) The optional single value query filter parameter on the entity display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_LISTENER_SERVICES Function

Lists the database services registered with the specified external listener for the specified Managed Database.

Syntax

FUNCTION list_external_listener_services (
  external_listener_id varchar2,
  managed_database_id varchar2,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_listener_services_response_t;

Parameters

Parameter	Description
`external_listener_id`	(required) The OCID of the external listener.
`managed_database_id`	(required) The OCID of the Managed Database.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `NAME` is ascending and it is case-sensitive. Allowed values are: 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_EXTERNAL_LISTENERS Function

Lists the listeners in the specified external DB system.

Syntax

FUNCTION list_external_listeners (
  compartment_id varchar2 DEFAULT NULL,
  external_db_system_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_external_listeners_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment.
`external_db_system_id`	(optional) The OCID of the external DB system.
`display_name`	(optional) A filter to only return the resources that match the entire display name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending. The `DISPLAYNAME` sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_JOB_EXECUTIONS Function

Gets the job execution for a specific ID or the list of job executions for a job, job run, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, jobRunId, managedDatabaseId or managedDatabaseGroupId should be provided. If none of these parameters is provided, all the job executions in the compartment are listed. Job executions can also be filtered based on the name and status parameters.

Syntax

FUNCTION list_job_executions (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  job_id varchar2 DEFAULT NULL,
  managed_database_id varchar2 DEFAULT NULL,
  managed_database_group_id varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  job_run_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_job_executions_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) The client request ID for tracing.
`id`	(optional) The identifier of the resource.
`job_id`	(optional) The identifier of the job.
`managed_database_id`	(optional) The OCID of the Managed Database.
`managed_database_group_id`	(optional) The OCID of the Managed Database Group.
`status`	(optional) The status of the job execution.
`name`	(optional) A filter to return only resources that match the entire name.
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`job_run_id`	(optional) The identifier of the job run.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_JOB_RUNS Function

Gets the job run for a specific ID or the list of job runs for a job, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided. If none of these parameters is provided, all the job runs in the compartment are listed. Job runs can also be filtered based on name and runStatus parameters.

Syntax

FUNCTION list_job_runs (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  job_id varchar2 DEFAULT NULL,
  managed_database_id varchar2 DEFAULT NULL,
  managed_database_group_id varchar2 DEFAULT NULL,
  run_status varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_job_runs_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) The client request ID for tracing.
`id`	(optional) The identifier of the resource.
`job_id`	(optional) The identifier of the job.
`managed_database_id`	(optional) The OCID of the Managed Database.
`managed_database_group_id`	(optional) The OCID of the Managed Database Group.
`run_status`	(optional) The status of the job run.
`name`	(optional) A filter to return only resources that match the entire name.
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_JOBS Function

Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, managedDatabaseId or managedDatabaseGroupId, should be provided. If none of these parameters is provided, all the jobs in the compartment are listed. Jobs can also be filtered based on the name and lifecycleState parameters.

Syntax

FUNCTION list_jobs (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  managed_database_group_id varchar2 DEFAULT NULL,
  managed_database_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_jobs_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) The client request ID for tracing.
`id`	(optional) The identifier of the resource.
`managed_database_group_id`	(optional) The OCID of the Managed Database Group.
`managed_database_id`	(optional) The OCID of the Managed Database.
`name`	(optional) A filter to return only resources that match the entire name.
`lifecycle_state`	(optional) The lifecycle state of the job.
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MANAGED_DATABASE_GROUPS Function

Gets the Managed Database Group for a specific ID or the list of Managed Database Groups in a specific compartment. Managed Database Groups can also be filtered based on the name parameter. Only one of the parameters, ID or name should be provided. If none of these parameters is provided, all the Managed Database Groups in the compartment are listed.

Syntax

FUNCTION list_managed_database_groups (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_managed_database_groups_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) The client request ID for tracing.
`id`	(optional) The identifier of the resource.
`name`	(optional) A filter to return only resources that match the entire name.
`lifecycle_state`	(optional) The lifecycle state of a resource. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MANAGED_DATABASES Function

Gets the Managed Database for a specific ID or the list of Managed Databases in a specific compartment. Managed Databases can be filtered based on the name parameter. Only one of the parameters, ID or name should be provided. If neither of these parameters is provided, all the Managed Databases in the compartment are listed. Managed Databases can also be filtered based on the deployment type and management option. If the deployment type is not specified or if it is `ONPREMISE`, then the management option is not considered and Managed Databases with `ADVANCED` management option are listed.

Syntax

FUNCTION list_managed_databases (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  management_option varchar2 DEFAULT NULL,
  deployment_type varchar2 DEFAULT NULL,
  external_exadata_infrastructure_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_managed_databases_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) The client request ID for tracing.
`id`	(optional) The identifier of the resource.
`name`	(optional) A filter to return only resources that match the entire name.
`management_option`	(optional) A filter to return Managed Databases with the specified management option. Allowed values are: 'BASIC', 'ADVANCED'
`deployment_type`	(optional) A filter to return Managed Databases of the specified deployment type. Allowed values are: 'ONPREMISE', 'BM', 'VM', 'EXADATA', 'EXADATA_CC', 'AUTONOMOUS'
`external_exadata_infrastructure_id`	(optional) The OCID of the Exadata infrastructure.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_OBJECT_PRIVILEGES Function

Gets the list of object privileges granted to a specific user.

Syntax

FUNCTION list_object_privileges (
  managed_database_id varchar2,
  user_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_object_privileges_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`user_name`	(required) The name of the user whose details are to be viewed.
`opc_request_id`	(optional) The client request ID for tracing.
`name`	(optional) A filter to return only resources that match the entire name.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_OPTIMIZER_STATISTICS_ADVISOR_EXECUTIONS Function

Lists the details of the Optimizer Statistics Advisor task executions, such as their duration, and the number of findings, if any. Optionally, you can specify a date-time range (of seven days) to obtain the list of executions that fall within the specified time range. If the date-time range is not specified, then the executions in the last seven days are listed.

Syntax

FUNCTION list_optimizer_statistics_advisor_executions (
  managed_database_id varchar2,
  start_time_greater_than_or_equal_to varchar2 DEFAULT NULL,
  end_time_less_than_or_equal_to varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_optimizer_statistics_advisor_executions_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`start_time_greater_than_or_equal_to`	(optional) The start time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`end_time_less_than_or_equal_to`	(optional) The end time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_OPTIMIZER_STATISTICS_COLLECTION_AGGREGATIONS Function

Gets a list of the optimizer statistics collection operations per hour, grouped by task or object status for the specified Managed Database. You must specify a value for GroupByQueryParam to determine whether the data should be grouped by task status or task object status. Optionally, you can specify a date-time range (of seven days) to obtain collection aggregations within the specified time range. If the date-time range is not specified, then the operations in the last seven days are listed. You can further filter the results by providing the optional type of TaskTypeQueryParam. If the task type not provided, then both Auto and Manual tasks are considered for aggregation.

Syntax

FUNCTION list_optimizer_statistics_collection_aggregations (
  managed_database_id varchar2,
  group_type varchar2,
  start_time_greater_than_or_equal_to varchar2 DEFAULT NULL,
  end_time_less_than_or_equal_to varchar2 DEFAULT NULL,
  task_type varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_optimizer_statistics_collection_aggregations_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`group_type`	(required) The optimizer statistics tasks grouped by type. Allowed values are: 'TASK_STATUS', 'TASK_OBJECTS_STATUS'
`start_time_greater_than_or_equal_to`	(optional) The start time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`end_time_less_than_or_equal_to`	(optional) The end time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`task_type`	(optional) The filter types of the optimizer statistics tasks. Allowed values are: 'ALL', 'MANUAL', 'AUTO'
`opc_request_id`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_OPTIMIZER_STATISTICS_COLLECTION_OPERATIONS Function

Lists the Optimizer Statistics Collection (Auto and Manual) task operation summary for the specified Managed Database. The summary includes the details of each operation and the number of tasks grouped by status: Completed, In Progress, Failed, and so on. Optionally, you can specify a date-time range (of seven days) to obtain the list of operations that fall within the specified time range. If the date-time range is not specified, then the operations in the last seven days are listed. This API also enables the pagination of results and the opc-next-page response header indicates whether there is a next page. If you use the same header value in a consecutive request, the next page records are returned. To obtain the required results, you can apply the different types of filters supported by this API.

Syntax

FUNCTION list_optimizer_statistics_collection_operations (
  managed_database_id varchar2,
  start_time_greater_than_or_equal_to varchar2 DEFAULT NULL,
  end_time_less_than_or_equal_to varchar2 DEFAULT NULL,
  task_type varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  filter_by varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_optimizer_statistics_collection_operations_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`start_time_greater_than_or_equal_to`	(optional) The start time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`end_time_less_than_or_equal_to`	(optional) The end time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`task_type`	(optional) The filter types of the optimizer statistics tasks. Allowed values are: 'ALL', 'MANUAL', 'AUTO'
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`filter_by`	(optional) The parameter used to filter the optimizer statistics operations. Any property of the OptimizerStatisticsCollectionOperationSummary can be used to define the filter condition. The allowed conditional operators are AND or OR, and the allowed binary operators are are >, < and =. Any other operator is regarded invalid. Example: jobName=<replace with job name> AND status=<replace with status>
`sort_by`	(optional) Sorts the list of optimizer statistics operations based on a specific attribute. Allowed values are: 'START_TIME', 'END_TIME', 'STATUS'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PREFERRED_CREDENTIALS Function

Gets the list of preferred credentials for a given Managed Database.

Syntax

FUNCTION list_preferred_credentials (
  managed_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_preferred_credentials_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PROXIED_FOR_USERS Function

Gets the list of users on whose behalf the current user acts as proxy.

Syntax

FUNCTION list_proxied_for_users (
  managed_database_id varchar2,
  user_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_proxied_for_users_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`user_name`	(required) The name of the user whose details are to be viewed.
`opc_request_id`	(optional) The client request ID for tracing.
`name`	(optional) A filter to return only resources that match the entire name.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PROXY_USERS Function

Gets the list of proxy users for the current user.

Syntax

FUNCTION list_proxy_users (
  managed_database_id varchar2,
  user_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_proxy_users_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`user_name`	(required) The name of the user whose details are to be viewed.
`opc_request_id`	(optional) The client request ID for tracing.
`name`	(optional) A filter to return only resources that match the entire name.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ROLES Function

Gets the list of roles granted to a specific user.

Syntax

FUNCTION list_roles (
  managed_database_id varchar2,
  user_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_roles_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`user_name`	(required) The name of the user whose details are to be viewed.
`opc_request_id`	(optional) The client request ID for tracing.
`name`	(optional) A filter to return only resources that match the entire name.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_PLAN_BASELINE_JOBS Function

Lists the database jobs used for loading SQL plan baselines in the specified Managed Database.

Syntax

FUNCTION list_sql_plan_baseline_jobs (
  managed_database_id varchar2,
  name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_sql_plan_baseline_jobs_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`name`	(optional) A filter to return the SQL plan baseline jobs that match the name.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_PLAN_BASELINES Function

Lists the SQL plan baselines for the specified Managed Database.

Syntax

FUNCTION list_sql_plan_baselines (
  managed_database_id varchar2,
  plan_name varchar2 DEFAULT NULL,
  sql_handle varchar2 DEFAULT NULL,
  sql_text varchar2 DEFAULT NULL,
  is_enabled number DEFAULT NULL,
  is_accepted number DEFAULT NULL,
  is_reproduced number DEFAULT NULL,
  is_fixed number DEFAULT NULL,
  is_adaptive number DEFAULT NULL,
  origin varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_sql_plan_baselines_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`plan_name`	(optional) A filter to return only SQL plan baselines that match the plan name.
`sql_handle`	(optional) A filter to return all the SQL plan baselines for the specified SQL handle.
`sql_text`	(optional) A filter to return all the SQL plan baselines that match the SQL text. By default, the search is case insensitive. To run an exact or case-sensitive search, double-quote the search string. You may also use the '%' symbol as a wildcard.
`is_enabled`	(optional) A filter to return only SQL plan baselines that are either enabled or not enabled. By default, all SQL plan baselines are returned.
`is_accepted`	(optional) A filter to return only SQL plan baselines that are either accepted or not accepted. By default, all SQL plan baselines are returned.
`is_reproduced`	(optional) A filter to return only SQL plan baselines that were either reproduced or not reproduced by the optimizer. By default, all SQL plan baselines are returned.
`is_fixed`	(optional) A filter to return only SQL plan baselines that are either fixed or not fixed. By default, all SQL plan baselines are returned.
`is_adaptive`	(optional) A filter to return only SQL plan baselines that are either adaptive or not adaptive. By default, all SQL plan baselines are returned.
`origin`	(optional) A filter to return all the SQL plan baselines that match the origin. Allowed values are: 'ADDM_SQLTUNE', 'AUTO_CAPTURE', 'AUTO_SQLTUNE', 'EVOLVE_AUTO_INDEX_LOAD', 'EVOLVE_CREATE_FROM_ADAPTIVE', 'EVOLVE_LOAD_FROM_STS', 'EVOLVE_LOAD_FROM_AWR', 'EVOLVE_LOAD_FROM_CURSOR_CACHE', 'MANUAL_LOAD', 'MANUAL_LOAD_FROM_AWR', 'MANUAL_LOAD_FROM_CURSOR_CACHE', 'MANUAL_LOAD_FROM_STS', 'MANUAL_SQLTUNE', 'STORED_OUTLINE', 'UNKNOWN'
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The option to sort the SQL plan baseline summary data. Allowed values are: 'timeCreated', 'timeLastModified'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SYSTEM_PRIVILEGES Function

Gets the list of system privileges granted to a specific user.

Syntax

FUNCTION list_system_privileges (
  managed_database_id varchar2,
  user_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_system_privileges_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`user_name`	(required) The name of the user whose details are to be viewed.
`opc_request_id`	(optional) The client request ID for tracing.
`name`	(optional) A filter to return only resources that match the entire name.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TABLE_STATISTICS Function

Lists the database table statistics grouped by different statuses such as Not Stale Stats, Stale Stats, and No Stats. This also includes the percentage of each status.

Syntax

FUNCTION list_table_statistics (
  managed_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_table_statistics_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TABLESPACES Function

Gets the list of tablespaces for the specified managedDatabaseId.

Syntax

FUNCTION list_tablespaces (
  managed_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_tablespaces_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`opc_request_id`	(optional) The client request ID for tracing.
`name`	(optional) A filter to return only resources that match the entire name.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_USERS Function

Gets the list of users for the specified managedDatabaseId.

Syntax

FUNCTION list_users (
  managed_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_users_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`opc_request_id`	(optional) The client request ID for tracing.
`name`	(optional) A filter to return only resources that match the entire name.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Returns a paginated list of errors for a given work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous work request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending. Allowed values are: 'timeAccepted'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Returns a paginated list of logs for a given work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous work request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending. Allowed values are: 'timeAccepted'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

The list of work requests in a specific compartment was retrieved successfully.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  resource_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  work_request_id varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`resource_id`	(optional) The OCID of the resource affected by the work request.
`opc_request_id`	(optional) The client request ID for tracing.
`work_request_id`	(optional) The OCID of the asynchronous work request.
`status`	(optional) A filter that returns the resources whose status matches the given WorkRequestStatus. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending. Allowed values are: 'timeAccepted'
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LOAD_SQL_PLAN_BASELINES_FROM_AWR Function

Loads plans from Automatic Workload Repository (AWR) snapshots. You must specify the beginning and ending of the snapshot range. Optionally, you can apply a filter to load only plans that meet specified criteria. By default, the optimizer uses the loaded plans the next time that the database executes the SQL statements.

Syntax

FUNCTION load_sql_plan_baselines_from_awr (
  managed_database_id varchar2,
  load_sql_plan_baselines_from_awr_details dbms_cloud_oci_database_management_load_sql_plan_baselines_from_awr_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_load_sql_plan_baselines_from_awr_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`load_sql_plan_baselines_from_awr_details`	(required) The details required to load plans from Automatic Workload Repository (AWR).
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LOAD_SQL_PLAN_BASELINES_FROM_CURSOR_CACHE Function

Loads plans for statements directly from the shared SQL area, also called the cursor cache. By applying a filter on the module name, the schema, or the SQL ID you identify the SQL statement or set of SQL statements to load.

Syntax

FUNCTION load_sql_plan_baselines_from_cursor_cache (
  managed_database_id varchar2,
  load_sql_plan_baselines_from_cursor_cache_details dbms_cloud_oci_database_management_load_sql_plan_baselines_from_cursor_cache_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_load_sql_plan_baselines_from_cursor_cache_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`load_sql_plan_baselines_from_cursor_cache_details`	(required) The details of SQL statements and plans to be loaded from cursor cache.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PATCH_EXTERNAL_DB_SYSTEM_DISCOVERY Function

Patches the external DB system discovery specified by `externalDbSystemDiscoveryId`.

Syntax

FUNCTION patch_external_db_system_discovery (
  external_db_system_discovery_id varchar2,
  patch_external_db_system_discovery_details dbms_cloud_oci_database_management_patch_external_db_system_discovery_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_patch_external_db_system_discovery_response_t;

Parameters

Parameter	Description
`external_db_system_discovery_id`	(required) The OCID of the external DB system discovery.
`patch_external_db_system_discovery_details`	(required) The details required to update an external DB system discovery.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_DATA_FILE Function

Removes a data file or temp file from the tablespace.

Syntax

FUNCTION remove_data_file (
  managed_database_id varchar2,
  tablespace_name varchar2,
  remove_data_file_details dbms_cloud_oci_database_management_remove_data_file_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_remove_data_file_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`tablespace_name`	(required) The name of the tablespace.
`remove_data_file_details`	(required) The details required to remove a data file or temp file from the tablespace.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_MANAGED_DATABASE_FROM_MANAGED_DATABASE_GROUP Function

Removes a Managed Database from a Managed Database Group. Any management activities that are currently running on this database will continue to run to completion. However, any activities scheduled to run in the future will not be performed on this database.

Syntax

FUNCTION remove_managed_database_from_managed_database_group (
  managed_database_group_id varchar2,
  remove_managed_database_from_managed_database_group_details dbms_cloud_oci_database_management_remove_managed_database_from_managed_database_group_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_remove_managed_database_from_managed_database_group_response_t;

Parameters

Parameter	Description
`managed_database_group_id`	(required) The OCID of the Managed Database Group.
`remove_managed_database_from_managed_database_group_details`	(required) The Managed Database details required to remove the Managed Database from a Managed Database Group.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

RESET_DATABASE_PARAMETERS Function

Resets database parameter values to their default or startup values.

Syntax

FUNCTION reset_database_parameters (
  managed_database_id varchar2,
  reset_database_parameters_details dbms_cloud_oci_database_management_reset_database_parameters_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_reset_database_parameters_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`reset_database_parameters_details`	(required) The details required to reset database parameters.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

RESIZE_DATA_FILE Function

Resizes a data file or temp file within the tablespace.

Syntax

FUNCTION resize_data_file (
  managed_database_id varchar2,
  tablespace_name varchar2,
  resize_data_file_details dbms_cloud_oci_database_management_resize_data_file_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_resize_data_file_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`tablespace_name`	(required) The name of the tablespace.
`resize_data_file_details`	(required) The details required to resize a data file or temp file within the tablespace.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

RUN_HISTORIC_ADDM Function

Creates and executes a historic ADDM task using the specified AWR snapshot IDs. If an existing ADDM task uses the provided awr snapshot IDs, the existing task will be returned.

Syntax

FUNCTION run_historic_addm (
  managed_database_id varchar2,
  run_historic_addm_details dbms_cloud_oci_database_management_run_historic_addm_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_run_historic_addm_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`run_historic_addm_details`	(required) The details of the ADDM task, which include the beginning and ending AWR snapshot IDs.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) Unique identifier for the request.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DB_CPU_USAGES Function

Summarizes the AWR CPU resource limits and metrics for the specified database in AWR.

Syntax

FUNCTION summarize_awr_db_cpu_usages (
  managed_database_id varchar2,
  awr_db_id varchar2,
  inst_num varchar2 DEFAULT NULL,
  begin_sn_id_greater_than_or_equal_to number DEFAULT NULL,
  end_sn_id_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  session_type varchar2 DEFAULT NULL,
  container_id number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_awr_db_cpu_usages_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`awr_db_id`	(required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs
`inst_num`	(optional) The optional single value query parameter to filter the database instance number.
`begin_sn_id_greater_than_or_equal_to`	(optional) The optional greater than or equal to filter on the snapshot ID.
`end_sn_id_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the snapshot ID.
`time_greater_than_or_equal_to`	(optional) The optional greater than or equal to query parameter to filter the timestamp.
`time_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the timestamp.
`session_type`	(optional) The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. Allowed values are: 'FOREGROUND', 'BACKGROUND', 'ALL'
`container_id`	(optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in large paginated response.
`sort_by`	(optional) The option to sort the AWR CPU usage summary data. Allowed values are: 'TIME_SAMPLED', 'AVG_VALUE'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DB_METRICS Function

Summarizes the metric samples for the specified database in the AWR. The metric samples are summarized based on the Time dimension for each metric.

Syntax

FUNCTION summarize_awr_db_metrics (
  managed_database_id varchar2,
  awr_db_id varchar2,
  name dbms_cloud_oci_database_management_varchar2_tbl,
  inst_num varchar2 DEFAULT NULL,
  begin_sn_id_greater_than_or_equal_to number DEFAULT NULL,
  end_sn_id_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  container_id number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_awr_db_metrics_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`awr_db_id`	(required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs
`name`	(required) The required multiple value query parameter to filter the entity name.
`inst_num`	(optional) The optional single value query parameter to filter the database instance number.
`begin_sn_id_greater_than_or_equal_to`	(optional) The optional greater than or equal to filter on the snapshot ID.
`end_sn_id_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the snapshot ID.
`time_greater_than_or_equal_to`	(optional) The optional greater than or equal to query parameter to filter the timestamp.
`time_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the timestamp.
`container_id`	(optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in large paginated response.
`sort_by`	(optional) The option to sort the AWR time series summary data. Allowed values are: 'TIMESTAMP', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DB_PARAMETER_CHANGES Function

Summarizes the database parameter change history for one database parameter of the specified database in AWR. One change history record contains the previous value, the changed value, and the corresponding time range. If the database parameter value was changed multiple times within the time range, then multiple change history records are created for the same parameter. Note that this API only returns information on change history details for one database parameter. To get a list of all the database parameters whose values were changed during a specified time range, use the following API endpoint: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameters

Syntax

FUNCTION summarize_awr_db_parameter_changes (
  managed_database_id varchar2,
  awr_db_id varchar2,
  name varchar2,
  inst_num varchar2 DEFAULT NULL,
  begin_sn_id_greater_than_or_equal_to number DEFAULT NULL,
  end_sn_id_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  container_id number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_awr_db_parameter_changes_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`awr_db_id`	(required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs
`name`	(required) The required single value query parameter to filter the entity name.
`inst_num`	(optional) The optional single value query parameter to filter the database instance number.
`begin_sn_id_greater_than_or_equal_to`	(optional) The optional greater than or equal to filter on the snapshot ID.
`end_sn_id_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the snapshot ID.
`time_greater_than_or_equal_to`	(optional) The optional greater than or equal to query parameter to filter the timestamp.
`time_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the timestamp.
`container_id`	(optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in large paginated response.
`sort_by`	(optional) The option to sort the AWR database parameter change history data. Allowed values are: 'IS_CHANGED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DB_PARAMETERS Function

Summarizes the database parameter history for the specified database in AWR. This includes the list of database parameters, with information on whether the parameter values were modified within the query time range. Note that each database parameter is only listed once. Depending on the optional query parameters, the returned summary gets all the database parameters, which include: - Each parameter whose value was changed during the time range: (valueChanged =\"Y\") - Each parameter whose value was unchanged during the time range: (valueChanged =\"N\") - Each parameter whose value was changed at the system level during the time range: (valueChanged =\"Y\" and valueModified = \"SYSTEM_MOD\") - Each parameter whose value was unchanged during the time range, however, the value is not the default value: (valueChanged =\"N\" and valueDefault = \"FALSE\") Note that this API does not return information on the number of times each database parameter has been changed within the time range. To get the database parameter value change history for a specific parameter, use the following API endpoint: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameterChanges

Syntax

FUNCTION summarize_awr_db_parameters (
  managed_database_id varchar2,
  awr_db_id varchar2,
  inst_num varchar2 DEFAULT NULL,
  begin_sn_id_greater_than_or_equal_to number DEFAULT NULL,
  end_sn_id_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  container_id number DEFAULT NULL,
  name dbms_cloud_oci_database_management_varchar2_tbl DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  value_changed varchar2 DEFAULT NULL,
  value_default varchar2 DEFAULT NULL,
  value_modified varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_awr_db_parameters_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`awr_db_id`	(required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs
`inst_num`	(optional) The optional single value query parameter to filter the database instance number.
`begin_sn_id_greater_than_or_equal_to`	(optional) The optional greater than or equal to filter on the snapshot ID.
`end_sn_id_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the snapshot ID.
`time_greater_than_or_equal_to`	(optional) The optional greater than or equal to query parameter to filter the timestamp.
`time_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the timestamp.
`container_id`	(optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
`name`	(optional) The optional multiple value query parameter to filter the entity name.
`name_contains`	(optional) The optional contains query parameter to filter the entity name by any part of the name.
`value_changed`	(optional) The optional query parameter to filter database parameters whose values were changed. Allowed values are: 'Y', 'N'
`value_default`	(optional) The optional query parameter to filter the database parameters that had the default value in the last snapshot. Allowed values are: 'TRUE', 'FALSE'
`value_modified`	(optional) The optional query parameter to filter the database parameters that had a modified value in the last snapshot. Allowed values are: 'MODIFIED', 'SYSTEM_MOD', 'FALSE'
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in large paginated response.
`sort_by`	(optional) The option to sort the AWR database parameter change history data. Allowed values are: 'IS_CHANGED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DB_SNAPSHOT_RANGES Function

Summarizes the AWR snapshot ranges that contain continuous snapshots, for the specified Managed Database.

Syntax

FUNCTION summarize_awr_db_snapshot_ranges (
  managed_database_id varchar2,
  name varchar2 DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_awr_db_snapshot_ranges_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`name`	(optional) The optional single value query parameter to filter the entity name.
`time_greater_than_or_equal_to`	(optional) The optional greater than or equal to query parameter to filter the timestamp.
`time_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the timestamp.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The option to sort the AWR summary data. Allowed values are: 'END_INTERVAL_TIME', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DB_SYSSTATS Function

Summarizes the AWR SYSSTAT sample data for the specified database in AWR. The statistical data is summarized based on the Time dimension for each statistic.

Syntax

FUNCTION summarize_awr_db_sysstats (
  managed_database_id varchar2,
  awr_db_id varchar2,
  name dbms_cloud_oci_database_management_varchar2_tbl,
  inst_num varchar2 DEFAULT NULL,
  begin_sn_id_greater_than_or_equal_to number DEFAULT NULL,
  end_sn_id_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  container_id number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_awr_db_sysstats_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`awr_db_id`	(required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs
`name`	(required) The required multiple value query parameter to filter the entity name.
`inst_num`	(optional) The optional single value query parameter to filter the database instance number.
`begin_sn_id_greater_than_or_equal_to`	(optional) The optional greater than or equal to filter on the snapshot ID.
`end_sn_id_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the snapshot ID.
`time_greater_than_or_equal_to`	(optional) The optional greater than or equal to query parameter to filter the timestamp.
`time_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the timestamp.
`container_id`	(optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in large paginated response.
`sort_by`	(optional) The option to sort the data within a time period. Allowed values are: 'TIME_BEGIN', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DB_TOP_WAIT_EVENTS Function

Summarizes the AWR top wait events.

Syntax

FUNCTION summarize_awr_db_top_wait_events (
  managed_database_id varchar2,
  awr_db_id varchar2,
  inst_num varchar2 DEFAULT NULL,
  begin_sn_id_greater_than_or_equal_to number DEFAULT NULL,
  end_sn_id_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  session_type varchar2 DEFAULT NULL,
  container_id number DEFAULT NULL,
  top_n number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_awr_db_top_wait_events_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`awr_db_id`	(required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs
`inst_num`	(optional) The optional single value query parameter to filter the database instance number.
`begin_sn_id_greater_than_or_equal_to`	(optional) The optional greater than or equal to filter on the snapshot ID.
`end_sn_id_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the snapshot ID.
`time_greater_than_or_equal_to`	(optional) The optional greater than or equal to query parameter to filter the timestamp.
`time_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the timestamp.
`session_type`	(optional) The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. Allowed values are: 'FOREGROUND', 'BACKGROUND', 'ALL'
`container_id`	(optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
`top_n`	(optional) The optional query parameter to filter the number of top categories to be returned.
`sort_by`	(optional) The option to sort the AWR top event summary data. Allowed values are: 'WAITS_PERSEC', 'AVG_WAIT_TIME_PERSEC'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DB_WAIT_EVENT_BUCKETS Function

Summarizes AWR wait event data into value buckets and frequency, for the specified database in the AWR.

Syntax

FUNCTION summarize_awr_db_wait_event_buckets (
  managed_database_id varchar2,
  awr_db_id varchar2,
  name varchar2,
  inst_num varchar2 DEFAULT NULL,
  begin_sn_id_greater_than_or_equal_to number DEFAULT NULL,
  end_sn_id_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  num_bucket number DEFAULT NULL,
  min_value number DEFAULT NULL,
  max_value number DEFAULT NULL,
  container_id number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_awr_db_wait_event_buckets_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`awr_db_id`	(required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs
`name`	(required) The required single value query parameter to filter the entity name.
`inst_num`	(optional) The optional single value query parameter to filter the database instance number.
`begin_sn_id_greater_than_or_equal_to`	(optional) The optional greater than or equal to filter on the snapshot ID.
`end_sn_id_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the snapshot ID.
`time_greater_than_or_equal_to`	(optional) The optional greater than or equal to query parameter to filter the timestamp.
`time_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the timestamp.
`num_bucket`	(optional) The number of buckets within the histogram.
`min_value`	(optional) The minimum value of the histogram.
`max_value`	(optional) The maximum value of the histogram.
`container_id`	(optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in large paginated response.
`sort_by`	(optional) The option to sort distribution data. Allowed values are: 'CATEGORY', 'PERCENTAGE'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_AWR_DB_WAIT_EVENTS Function

Summarizes the AWR wait event sample data for the specified database in the AWR. The event data is summarized based on the Time dimension for each event.

Syntax

FUNCTION summarize_awr_db_wait_events (
  managed_database_id varchar2,
  awr_db_id varchar2,
  inst_num varchar2 DEFAULT NULL,
  begin_sn_id_greater_than_or_equal_to number DEFAULT NULL,
  end_sn_id_less_than_or_equal_to number DEFAULT NULL,
  time_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  name dbms_cloud_oci_database_management_varchar2_tbl DEFAULT NULL,
  session_type varchar2 DEFAULT NULL,
  container_id number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_awr_db_wait_events_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`awr_db_id`	(required) The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs
`inst_num`	(optional) The optional single value query parameter to filter the database instance number.
`begin_sn_id_greater_than_or_equal_to`	(optional) The optional greater than or equal to filter on the snapshot ID.
`end_sn_id_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the snapshot ID.
`time_greater_than_or_equal_to`	(optional) The optional greater than or equal to query parameter to filter the timestamp.
`time_less_than_or_equal_to`	(optional) The optional less than or equal to query parameter to filter the timestamp.
`name`	(optional) The optional multiple value query parameter to filter the entity name.
`session_type`	(optional) The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. Allowed values are: 'FOREGROUND', 'BACKGROUND', 'ALL'
`container_id`	(optional) The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in large paginated response.
`sort_by`	(optional) The option to sort the data within a time period. Allowed values are: 'TIME_BEGIN', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXTERNAL_ASM_METRICS Function

Gets metrics for the external ASM specified by `externalAsmId`.

Syntax

FUNCTION summarize_external_asm_metrics (
  external_asm_id varchar2,
  start_time varchar2,
  end_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  filter_by_metric_names varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_external_asm_metrics_response_t;

Parameters

Parameter	Description
`external_asm_id`	(required) The OCID of the external ASM.
`start_time`	(required) The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.
`end_time`	(required) The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`filter_by_metric_names`	(optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXTERNAL_CLUSTER_METRICS Function

Gets metrics for the external cluster specified by `externalClusterId`.

Syntax

FUNCTION summarize_external_cluster_metrics (
  external_cluster_id varchar2,
  start_time varchar2,
  end_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  filter_by_metric_names varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_external_cluster_metrics_response_t;

Parameters

Parameter	Description
`external_cluster_id`	(required) The OCID of the external cluster.
`start_time`	(required) The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.
`end_time`	(required) The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`filter_by_metric_names`	(optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXTERNAL_DB_NODE_METRICS Function

Gets metrics for the external DB node specified by `externalDbNodeId`.

Syntax

FUNCTION summarize_external_db_node_metrics (
  external_db_node_id varchar2,
  start_time varchar2,
  end_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  filter_by_metric_names varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_external_db_node_metrics_response_t;

Parameters

Parameter	Description
`external_db_node_id`	(required) The OCID of the external database node.
`start_time`	(required) The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.
`end_time`	(required) The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`filter_by_metric_names`	(optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXTERNAL_DB_SYSTEM_AVAILABILITY_METRICS Function

Gets availability metrics for the components present in the external DB system specified by `externalDbSystemId`.

Syntax

FUNCTION summarize_external_db_system_availability_metrics (
  external_db_system_id varchar2,
  start_time varchar2,
  end_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  filter_by_component_types varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_external_db_system_availability_metrics_response_t;

Parameters

Parameter	Description
`external_db_system_id`	(required) The OCID of the external DB system.
`start_time`	(required) The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.
`end_time`	(required) The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`filter_by_component_types`	(optional) The filter used to retrieve metrics for a specific set of component types by passing the desired component types separated by a comma. Note that, by default, the service returns metrics for all DB system component types.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_EXTERNAL_LISTENER_METRICS Function

Gets metrics for the external listener specified by `externalListenerId`.

Syntax

FUNCTION summarize_external_listener_metrics (
  external_listener_id varchar2,
  start_time varchar2,
  end_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  filter_by_metric_names varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_external_listener_metrics_response_t;

Parameters

Parameter	Description
`external_listener_id`	(required) The OCID of the external listener.
`start_time`	(required) The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.
`end_time`	(required) The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd'T'hh:mm:ss.sss'Z'`.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`filter_by_metric_names`	(optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_JOB_EXECUTIONS_STATUSES Function

Gets the number of job executions grouped by status for a job, Managed Database, or Database Group in a specific compartment. Only one of the parameters, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided.

Syntax

FUNCTION summarize_job_executions_statuses (
  compartment_id varchar2,
  start_time varchar2,
  end_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  managed_database_group_id varchar2 DEFAULT NULL,
  managed_database_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_job_executions_statuses_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`start_time`	(required) The start time of the time range to retrieve the status summary of job executions in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`end_time`	(required) The end time of the time range to retrieve the status summary of job executions in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`opc_request_id`	(optional) The client request ID for tracing.
`id`	(optional) The identifier of the resource.
`managed_database_group_id`	(optional) The OCID of the Managed Database Group.
`managed_database_id`	(optional) The OCID of the Managed Database.
`name`	(optional) A filter to return only resources that match the entire name.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_MANAGED_DATABASE_AVAILABILITY_METRICS Function

Gets the availability metrics related to managed database for the Oracle database specified by managedDatabaseId.

Syntax

FUNCTION summarize_managed_database_availability_metrics (
  managed_database_id varchar2,
  start_time varchar2,
  end_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_managed_database_availability_metrics_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`start_time`	(required) The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`end_time`	(required) The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_SQL_PLAN_BASELINES Function

Gets the number of SQL plan baselines aggregated by their attributes.

Syntax

FUNCTION summarize_sql_plan_baselines (
  managed_database_id varchar2,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_sql_plan_baselines_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_SQL_PLAN_BASELINES_BY_LAST_EXECUTION Function

Gets the number of SQL plan baselines aggregated by the age of their last execution in weeks.

Syntax

FUNCTION summarize_sql_plan_baselines_by_last_execution (
  managed_database_id varchar2,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_summarize_sql_plan_baselines_by_last_execution_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

TEST_PREFERRED_CREDENTIAL Function

Tests the preferred credential.

Syntax

FUNCTION test_preferred_credential (
  managed_database_id varchar2,
  l_credential_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  test_preferred_credential_details dbms_cloud_oci_database_management_test_preferred_credential_details_t DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_test_preferred_credential_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`l_credential_name`	(required) The name of the preferred credential.
`opc_request_id`	(optional) The client request ID for tracing.
`test_preferred_credential_details`	(optional) The details required to test preferred credential.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DB_MANAGEMENT_PRIVATE_ENDPOINT Function

Updates one or more attributes of a specific Database Management private endpoint.

Syntax

FUNCTION update_db_management_private_endpoint (
  db_management_private_endpoint_id varchar2,
  update_db_management_private_endpoint_details dbms_cloud_oci_database_management_update_db_management_private_endpoint_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_db_management_private_endpoint_response_t;

Parameters

Parameter	Description
`db_management_private_endpoint_id`	(required) The OCID of the Database Management private endpoint.
`update_db_management_private_endpoint_details`	(required) The details used to update a Database Management private endpoint.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EXTERNAL_ASM Function

Updates the external ASM specified by `externalAsmId`.

Syntax

FUNCTION update_external_asm (
  external_asm_id varchar2,
  update_external_asm_details dbms_cloud_oci_database_management_update_external_asm_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_external_asm_response_t;

Parameters

Parameter	Description
`external_asm_id`	(required) The OCID of the external ASM.
`update_external_asm_details`	(required) The details required to update an external ASM.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EXTERNAL_CLUSTER Function

Updates the external cluster specified by `externalClusterId`.

Syntax

FUNCTION update_external_cluster (
  external_cluster_id varchar2,
  update_external_cluster_details dbms_cloud_oci_database_management_update_external_cluster_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_external_cluster_response_t;

Parameters

Parameter	Description
`external_cluster_id`	(required) The OCID of the external cluster.
`update_external_cluster_details`	(required) The details required to update an external cluster.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EXTERNAL_CLUSTER_INSTANCE Function

Updates the external cluster instance specified by `externalClusterInstanceId`.

Syntax

FUNCTION update_external_cluster_instance (
  external_cluster_instance_id varchar2,
  update_external_cluster_instance_details dbms_cloud_oci_database_management_update_external_cluster_instance_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_external_cluster_instance_response_t;

Parameters

Parameter	Description
`external_cluster_instance_id`	(required) The OCID of the external cluster instance.
`update_external_cluster_instance_details`	(required) The details required to update an external cluster instance.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EXTERNAL_DB_NODE Function

Updates the external DB node specified by `externalDbNodeId`.

Syntax

FUNCTION update_external_db_node (
  external_db_node_id varchar2,
  update_external_db_node_details dbms_cloud_oci_database_management_update_external_db_node_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_external_db_node_response_t;

Parameters

Parameter	Description
`external_db_node_id`	(required) The OCID of the external database node.
`update_external_db_node_details`	(required) The details required to update an external DB node.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EXTERNAL_DB_SYSTEM Function

Updates the external DB system specified by `externalDbSystemId`.

Syntax

FUNCTION update_external_db_system (
  external_db_system_id varchar2,
  update_external_db_system_details dbms_cloud_oci_database_management_update_external_db_system_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_external_db_system_response_t;

Parameters

Parameter	Description
`external_db_system_id`	(required) The OCID of the external DB system.
`update_external_db_system_details`	(required) The details required to update an external DB system.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EXTERNAL_DB_SYSTEM_CONNECTOR Function

Updates the external connector specified by `externalDbSystemConnectorId`.

Syntax

FUNCTION update_external_db_system_connector (
  external_db_system_connector_id varchar2,
  update_external_db_system_connector_details dbms_cloud_oci_database_management_update_external_db_system_connector_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_external_db_system_connector_response_t;

Parameters

Parameter	Description
`external_db_system_connector_id`	(required) The OCID of the external connector.
`update_external_db_system_connector_details`	(required) The details required to update an external connector.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EXTERNAL_DB_SYSTEM_DISCOVERY Function

Updates the external DB system discovery specified by `externalDbSystemDiscoveryId`.

Syntax

FUNCTION update_external_db_system_discovery (
  external_db_system_discovery_id varchar2,
  update_external_db_system_discovery_details dbms_cloud_oci_database_management_update_external_db_system_discovery_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_external_db_system_discovery_response_t;

Parameters

Parameter	Description
`external_db_system_discovery_id`	(required) The OCID of the external DB system discovery.
`update_external_db_system_discovery_details`	(required) The details required to update an external DB system discovery.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EXTERNAL_EXADATA_INFRASTRUCTURE Function

Updates the details for the Exadata infrastructure specified by externalExadataInfrastructureId.

Syntax

FUNCTION update_external_exadata_infrastructure (
  external_exadata_infrastructure_id varchar2,
  update_external_exadata_infrastructure_details dbms_cloud_oci_database_management_update_external_exadata_infrastructure_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_external_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`external_exadata_infrastructure_id`	(required) The OCID of the Exadata infrastructure.
`update_external_exadata_infrastructure_details`	(required) The details required to update the managed Exadata infrastructure resources.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EXTERNAL_EXADATA_STORAGE_CONNECTOR Function

Updates the Exadata storage server connector specified by exadataStorageConnectorId.

Syntax

FUNCTION update_external_exadata_storage_connector (
  external_exadata_storage_connector_id varchar2,
  update_external_exadata_storage_connector_details dbms_cloud_oci_database_management_update_external_exadata_storage_connector_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_external_exadata_storage_connector_response_t;

Parameters

Parameter	Description
`external_exadata_storage_connector_id`	(required) The OCID of the connector to the Exadata storage server.
`update_external_exadata_storage_connector_details`	(required) The details required to update connections to the Exadata storage servers.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_EXTERNAL_LISTENER Function

Updates the external listener specified by `externalListenerId`.

Syntax

FUNCTION update_external_listener (
  external_listener_id varchar2,
  update_external_listener_details dbms_cloud_oci_database_management_update_external_listener_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_external_listener_response_t;

Parameters

Parameter	Description
`external_listener_id`	(required) The OCID of the external listener.
`update_external_listener_details`	(required) The details required to update an external listener.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_JOB Function

Updates the details for the recurring scheduled job specified by jobId. Note that non-recurring (one time) jobs cannot be updated.

Syntax

FUNCTION update_job (
  job_id varchar2,
  update_job_details dbms_cloud_oci_database_management_update_job_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_job_response_t;

Parameters

Parameter	Description
`job_id`	(required) The identifier of the job.
`update_job_details`	(required) The details required to update a job.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MANAGED_DATABASE_GROUP Function

Updates the Managed Database Group specified by managedDatabaseGroupId.

Syntax

FUNCTION update_managed_database_group (
  managed_database_group_id varchar2,
  update_managed_database_group_details dbms_cloud_oci_database_management_update_managed_database_group_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_managed_database_group_response_t;

Parameters

Parameter	Description
`managed_database_group_id`	(required) The OCID of the Managed Database Group.
`update_managed_database_group_details`	(required) The details required to update a Managed Database Group.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_PREFERRED_CREDENTIAL Function

Updates the preferred credential based on the credentialName.

Syntax

FUNCTION update_preferred_credential (
  managed_database_id varchar2,
  l_credential_name varchar2,
  update_preferred_credential_details dbms_cloud_oci_database_management_update_preferred_credential_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_preferred_credential_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`l_credential_name`	(required) The name of the preferred credential.
`update_preferred_credential_details`	(required) The details required to update preferred credential.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_TABLESPACE Function

Updates the attributes of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.

Syntax

FUNCTION update_tablespace (
  managed_database_id varchar2,
  tablespace_name varchar2,
  update_tablespace_details dbms_cloud_oci_database_management_update_tablespace_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_db_management_update_tablespace_response_t;

Parameters

Parameter	Description
`managed_database_id`	(required) The OCID of the Managed Database.
`tablespace_name`	(required) The name of the tablespace.
`update_tablespace_details`	(required) The details required to update a tablespace.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

ADD_DATA_FILES Function 🔗

ADD_MANAGED_DATABASE_TO_MANAGED_DATABASE_GROUP Function 🔗

ADDM_TASKS Function 🔗

CHANGE_DATABASE_PARAMETERS Function 🔗

CHANGE_DB_MANAGEMENT_PRIVATE_ENDPOINT_COMPARTMENT Function 🔗

CHANGE_EXTERNAL_DB_SYSTEM_COMPARTMENT Function 🔗

CHANGE_EXTERNAL_EXADATA_INFRASTRUCTURE_COMPARTMENT Function 🔗

CHANGE_JOB_COMPARTMENT Function 🔗

CHANGE_MANAGED_DATABASE_GROUP_COMPARTMENT Function 🔗

CHANGE_PLAN_RETENTION Function 🔗

CHANGE_SPACE_BUDGET Function 🔗

CHANGE_SQL_PLAN_BASELINES_ATTRIBUTES Function 🔗

CHECK_EXTERNAL_DB_SYSTEM_CONNECTOR_CONNECTION_STATUS Function 🔗

CHECK_EXTERNAL_EXADATA_STORAGE_CONNECTOR Function 🔗

CONFIGURE_AUTOMATIC_CAPTURE_FILTERS Function 🔗

CONFIGURE_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function 🔗

CREATE_DB_MANAGEMENT_PRIVATE_ENDPOINT Function 🔗

CREATE_EXTERNAL_DB_SYSTEM Function 🔗

CREATE_EXTERNAL_DB_SYSTEM_CONNECTOR Function 🔗

CREATE_EXTERNAL_DB_SYSTEM_DISCOVERY Function 🔗

CREATE_EXTERNAL_EXADATA_INFRASTRUCTURE Function 🔗

CREATE_EXTERNAL_EXADATA_STORAGE_CONNECTOR Function 🔗

CREATE_JOB Function 🔗

CREATE_MANAGED_DATABASE_GROUP Function 🔗

CREATE_TABLESPACE Function 🔗

DELETE_DB_MANAGEMENT_PRIVATE_ENDPOINT Function 🔗

DELETE_EXTERNAL_DB_SYSTEM Function 🔗

DELETE_EXTERNAL_DB_SYSTEM_CONNECTOR Function 🔗

DELETE_EXTERNAL_DB_SYSTEM_DISCOVERY Function 🔗

DELETE_EXTERNAL_EXADATA_INFRASTRUCTURE Function 🔗

DELETE_EXTERNAL_EXADATA_STORAGE_CONNECTOR Function 🔗

DELETE_JOB Function 🔗

DELETE_MANAGED_DATABASE_GROUP Function 🔗

DELETE_PREFERRED_CREDENTIAL Function 🔗

DISABLE_AUTOMATIC_INITIAL_PLAN_CAPTURE Function 🔗

DISABLE_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function 🔗

DISABLE_EXTERNAL_DB_SYSTEM_DATABASE_MANAGEMENT Function 🔗

DISABLE_EXTERNAL_DB_SYSTEM_STACK_MONITORING Function 🔗

DISABLE_EXTERNAL_EXADATA_INFRASTRUCTURE_MANAGEMENT Function 🔗

DISABLE_HIGH_FREQUENCY_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function 🔗

DISABLE_SQL_PLAN_BASELINES_USAGE Function 🔗

DISCOVER_EXTERNAL_EXADATA_INFRASTRUCTURE Function 🔗

DROP_SQL_PLAN_BASELINES Function 🔗

DROP_TABLESPACE Function 🔗

ENABLE_AUTOMATIC_INITIAL_PLAN_CAPTURE Function 🔗

ENABLE_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function 🔗

ENABLE_EXTERNAL_DB_SYSTEM_DATABASE_MANAGEMENT Function 🔗

ENABLE_EXTERNAL_DB_SYSTEM_STACK_MONITORING Function 🔗

ENABLE_EXTERNAL_EXADATA_INFRASTRUCTURE_MANAGEMENT Function 🔗

ENABLE_HIGH_FREQUENCY_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function 🔗

ENABLE_SQL_PLAN_BASELINES_USAGE Function 🔗

GENERATE_AWR_SNAPSHOT Function 🔗

GET_AWR_DB_REPORT Function 🔗

GET_AWR_DB_SQL_REPORT Function 🔗

GET_CLUSTER_CACHE_METRIC Function 🔗

GET_DATABASE_FLEET_HEALTH_METRICS Function 🔗

GET_DATABASE_HOME_METRICS Function 🔗

GET_DB_MANAGEMENT_PRIVATE_ENDPOINT Function 🔗

GET_EXTERNAL_ASM Function 🔗

GET_EXTERNAL_ASM_CONFIGURATION Function 🔗

GET_EXTERNAL_ASM_INSTANCE Function 🔗

GET_EXTERNAL_CLUSTER Function 🔗

GET_EXTERNAL_CLUSTER_INSTANCE Function 🔗

GET_EXTERNAL_DB_HOME Function 🔗

GET_EXTERNAL_DB_NODE Function 🔗

GET_EXTERNAL_DB_SYSTEM Function 🔗

GET_EXTERNAL_DB_SYSTEM_CONNECTOR Function 🔗

GET_EXTERNAL_DB_SYSTEM_DISCOVERY Function 🔗

GET_EXTERNAL_EXADATA_INFRASTRUCTURE Function 🔗

GET_EXTERNAL_EXADATA_STORAGE_CONNECTOR Function 🔗

GET_EXTERNAL_EXADATA_STORAGE_GRID Function 🔗

GET_EXTERNAL_EXADATA_STORAGE_SERVER Function 🔗

GET_EXTERNAL_LISTENER Function 🔗

GET_IORM_PLAN Function 🔗

GET_JOB Function 🔗

GET_JOB_EXECUTION Function 🔗

GET_JOB_RUN Function 🔗

GET_MANAGED_DATABASE Function 🔗

GET_MANAGED_DATABASE_GROUP Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

ADD_DATA_FILES Function

ADD_MANAGED_DATABASE_TO_MANAGED_DATABASE_GROUP Function

ADDM_TASKS Function

CHANGE_DATABASE_PARAMETERS Function

CHANGE_DB_MANAGEMENT_PRIVATE_ENDPOINT_COMPARTMENT Function

CHANGE_EXTERNAL_DB_SYSTEM_COMPARTMENT Function

CHANGE_EXTERNAL_EXADATA_INFRASTRUCTURE_COMPARTMENT Function

CHANGE_JOB_COMPARTMENT Function

CHANGE_MANAGED_DATABASE_GROUP_COMPARTMENT Function

CHANGE_PLAN_RETENTION Function

CHANGE_SPACE_BUDGET Function

CHANGE_SQL_PLAN_BASELINES_ATTRIBUTES Function

CHECK_EXTERNAL_DB_SYSTEM_CONNECTOR_CONNECTION_STATUS Function

CHECK_EXTERNAL_EXADATA_STORAGE_CONNECTOR Function

CONFIGURE_AUTOMATIC_CAPTURE_FILTERS Function

CONFIGURE_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function

CREATE_DB_MANAGEMENT_PRIVATE_ENDPOINT Function

CREATE_EXTERNAL_DB_SYSTEM Function

CREATE_EXTERNAL_DB_SYSTEM_CONNECTOR Function

CREATE_EXTERNAL_DB_SYSTEM_DISCOVERY Function

CREATE_EXTERNAL_EXADATA_INFRASTRUCTURE Function

CREATE_EXTERNAL_EXADATA_STORAGE_CONNECTOR Function

CREATE_JOB Function

CREATE_MANAGED_DATABASE_GROUP Function

CREATE_TABLESPACE Function

DELETE_DB_MANAGEMENT_PRIVATE_ENDPOINT Function

DELETE_EXTERNAL_DB_SYSTEM Function

DELETE_EXTERNAL_DB_SYSTEM_CONNECTOR Function

DELETE_EXTERNAL_DB_SYSTEM_DISCOVERY Function

DELETE_EXTERNAL_EXADATA_INFRASTRUCTURE Function

DELETE_EXTERNAL_EXADATA_STORAGE_CONNECTOR Function

DELETE_JOB Function

DELETE_MANAGED_DATABASE_GROUP Function

DELETE_PREFERRED_CREDENTIAL Function

DISABLE_AUTOMATIC_INITIAL_PLAN_CAPTURE Function

DISABLE_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function

DISABLE_EXTERNAL_DB_SYSTEM_DATABASE_MANAGEMENT Function

DISABLE_EXTERNAL_DB_SYSTEM_STACK_MONITORING Function

DISABLE_EXTERNAL_EXADATA_INFRASTRUCTURE_MANAGEMENT Function

DISABLE_HIGH_FREQUENCY_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function

DISABLE_SQL_PLAN_BASELINES_USAGE Function

DISCOVER_EXTERNAL_EXADATA_INFRASTRUCTURE Function

DROP_SQL_PLAN_BASELINES Function

DROP_TABLESPACE Function

ENABLE_AUTOMATIC_INITIAL_PLAN_CAPTURE Function

ENABLE_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function

ENABLE_EXTERNAL_DB_SYSTEM_DATABASE_MANAGEMENT Function

ENABLE_EXTERNAL_DB_SYSTEM_STACK_MONITORING Function

ENABLE_EXTERNAL_EXADATA_INFRASTRUCTURE_MANAGEMENT Function

ENABLE_HIGH_FREQUENCY_AUTOMATIC_SPM_EVOLVE_ADVISOR_TASK Function

ENABLE_SQL_PLAN_BASELINES_USAGE Function

GENERATE_AWR_SNAPSHOT Function

GET_AWR_DB_REPORT Function

GET_AWR_DB_SQL_REPORT Function

GET_CLUSTER_CACHE_METRIC Function

GET_DATABASE_FLEET_HEALTH_METRICS Function

GET_DATABASE_HOME_METRICS Function

GET_DB_MANAGEMENT_PRIVATE_ENDPOINT Function

GET_EXTERNAL_ASM Function

GET_EXTERNAL_ASM_CONFIGURATION Function

GET_EXTERNAL_ASM_INSTANCE Function

GET_EXTERNAL_CLUSTER Function

GET_EXTERNAL_CLUSTER_INSTANCE Function

GET_EXTERNAL_DB_HOME Function

GET_EXTERNAL_DB_NODE Function

GET_EXTERNAL_DB_SYSTEM Function

GET_EXTERNAL_DB_SYSTEM_CONNECTOR Function

GET_EXTERNAL_DB_SYSTEM_DISCOVERY Function

GET_EXTERNAL_EXADATA_INFRASTRUCTURE Function

GET_EXTERNAL_EXADATA_STORAGE_CONNECTOR Function

GET_EXTERNAL_EXADATA_STORAGE_GRID Function

GET_EXTERNAL_EXADATA_STORAGE_SERVER Function

GET_EXTERNAL_LISTENER Function

GET_IORM_PLAN Function

GET_JOB Function

GET_JOB_EXECUTION Function

GET_JOB_RUN Function

GET_MANAGED_DATABASE Function

GET_MANAGED_DATABASE_GROUP Function