Database Functions

ACTIVATE_EXADATA_INFRASTRUCTURE Function

Activates the specified Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION activate_exadata_infrastructure (
  exadata_infrastructure_id varchar2,
  activate_exadata_infrastructure_details dbms_cloud_oci_database_activate_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_db_database_activate_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`activate_exadata_infrastructure_details`	(required) The activation details for the Exadata infrastructure and the additional storage servers requested.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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_STORAGE_CAPACITY_CLOUD_EXADATA_INFRASTRUCTURE Function

Makes the storage capacity from additional storage servers available for Cloud VM Cluster consumption. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Syntax

FUNCTION add_storage_capacity_cloud_exadata_infrastructure (
  cloud_exadata_infrastructure_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_db_database_add_storage_capacity_cloud_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`cloud_exadata_infrastructure_id`	(required) The cloud Exadata infrastructure OCID.
`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) Unique identifier for the request.
`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 may 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://database.{region}.{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_STORAGE_CAPACITY_EXADATA_INFRASTRUCTURE Function

Makes the storage capacity from additional storage servers available for VM Cluster consumption. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION add_storage_capacity_exadata_infrastructure (
  exadata_infrastructure_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_db_database_add_storage_capacity_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`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) Unique identifier for the request.
`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 may 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://database.{region}.{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_VIRTUAL_MACHINE_TO_CLOUD_VM_CLUSTER Function

Add Virtual Machines to the Cloud VM cluster. Applies to Exadata Cloud instances only.

Syntax

FUNCTION add_virtual_machine_to_cloud_vm_cluster (
  add_virtual_machine_to_cloud_vm_cluster_details dbms_cloud_oci_database_add_virtual_machine_to_cloud_vm_cluster_details_t,
  cloud_vm_cluster_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_add_virtual_machine_to_cloud_vm_cluster_response_t;

Parameters

Parameter	Description
`add_virtual_machine_to_cloud_vm_cluster_details`	(required) Request to add Virtual Machines to the Cloud VM cluster.
`cloud_vm_cluster_id`	(required) The cloud VM cluster OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_VIRTUAL_MACHINE_TO_VM_CLUSTER Function

Add Virtual Machines to the VM cluster. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION add_virtual_machine_to_vm_cluster (
  add_virtual_machine_to_vm_cluster_details dbms_cloud_oci_database_add_virtual_machine_to_vm_cluster_details_t,
  vm_cluster_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_add_virtual_machine_to_vm_cluster_response_t;

Parameters

Parameter	Description
`add_virtual_machine_to_vm_cluster_details`	(required) Request to add Virtual Machines to the VM cluster.
`vm_cluster_id`	(required) The VM cluster OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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.

AUTONOMOUS_DATABASE_MANUAL_REFRESH Function

Initiates a data refresh for an Autonomous Database refreshable clone. Data is refreshed from the source database to the point of a specified timestamp.

Syntax

FUNCTION autonomous_database_manual_refresh (
  autonomous_database_id varchar2,
  autonomous_database_manual_refresh_details dbms_cloud_oci_database_autonomous_database_manual_refresh_details_t,
  if_match varchar2 DEFAULT NULL,
  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_db_database_autonomous_database_manual_refresh_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`autonomous_database_manual_refresh_details`	(required) Request details for manually refreshing an Autonomous Database refreshable clone.
`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 may 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://database.{region}.{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.

CANCEL_BACKUP Function

Cancel automatic/standalone full/incremental create backup workrequests specified by the backup Id.

Syntax

FUNCTION cancel_backup (
  backup_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_db_database_cancel_backup_response_t;

Parameters

Parameter	Description
`backup_id`	(required) The backup OCID.
`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) Unique identifier for the request.
`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 may 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://database.{region}.{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_AUTONOMOUS_CONTAINER_DATABASE_COMPARTMENT Function

Move the Autonomous Container Database and its dependent resources to the specified compartment. For more information about moving Autonomous Container Databases, see Moving Database Resources to a Different Compartment.

Syntax

FUNCTION change_autonomous_container_database_compartment (
  change_compartment_details dbms_cloud_oci_database_change_compartment_details_t,
  autonomous_container_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_autonomous_container_database_compartment_response_t;

Parameters

Parameter	Description
`change_compartment_details`	(required) Request to move Autonomous Container Database to a different compartment
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_AUTONOMOUS_DATABASE_COMPARTMENT Function

Move the Autonomous Database and its dependent resources to the specified compartment. For more information about moving Autonomous Databases, see Moving Database Resources to a Different Compartment.

Syntax

FUNCTION change_autonomous_database_compartment (
  change_compartment_details dbms_cloud_oci_database_change_compartment_details_t,
  autonomous_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_autonomous_database_compartment_response_t;

Parameters

Parameter	Description
`change_compartment_details`	(required) Request to move Autonomous Database to a different compartment
`autonomous_database_id`	(required) The database OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_AUTONOMOUS_EXADATA_INFRASTRUCTURE_COMPARTMENT Function

**Deprecated.** Use the CHANGE_CLOUD_EXADATA_INFRASTRUCTURE_COMPARTMENT Function operation to move an Exadata infrastructure resource to a different compartment and CHANGE_CLOUD_AUTONOMOUS_VM_CLUSTER_COMPARTMENT Function operation to move an Autonomous Exadata VM cluster to a different compartment. For more information, see Moving Database Resources to a Different Compartment.

Syntax

FUNCTION change_autonomous_exadata_infrastructure_compartment (
  change_compartment_details dbms_cloud_oci_database_change_compartment_details_t,
  autonomous_exadata_infrastructure_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_autonomous_exadata_infrastructure_compartment_response_t;

Parameters

Parameter	Description
`change_compartment_details`	(required) Request to move an Autonomous Exadata Infrastructure resource to a different compartment.
`autonomous_exadata_infrastructure_id`	(required) The Autonomous Exadata Infrastructure OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_AUTONOMOUS_VM_CLUSTER_COMPARTMENT Function

Moves an Autonomous VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer only. For systems in the Oracle cloud, see CHANGE_AUTONOMOUS_VM_CLUSTER_COMPARTMENT Function.

Syntax

FUNCTION change_autonomous_vm_cluster_compartment (
  change_autonomous_vm_cluster_compartment_details dbms_cloud_oci_database_change_autonomous_vm_cluster_compartment_details_t,
  autonomous_vm_cluster_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_autonomous_vm_cluster_compartment_response_t;

Parameters

Parameter	Description
`change_autonomous_vm_cluster_compartment_details`	(required) Request to move Autonomous VM cluster to a different compartment
`autonomous_vm_cluster_id`	(required) The autonomous VM cluster OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_BACKUP_DESTINATION_COMPARTMENT Function

Move the backup destination and its dependent resources to the specified compartment. For more information, see Moving Database Resources to a Different Compartment.

Syntax

FUNCTION change_backup_destination_compartment (
  change_compartment_details dbms_cloud_oci_database_change_compartment_details_t,
  backup_destination_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_backup_destination_compartment_response_t;

Parameters

Parameter	Description
`change_compartment_details`	(required) Request to move backup destination to a different compartment.
`backup_destination_id`	(required) The OCID of the backup destination.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_CLOUD_AUTONOMOUS_VM_CLUSTER_COMPARTMENT Function

Moves an Autonomous Exadata VM cluster in the Oracle cloud and its dependent resources to another compartment. For Exadata Cloud@Customer systems, see CHANGE_AUTONOMOUS_VM_CLUSTER_COMPARTMENT Function.

Syntax

FUNCTION change_cloud_autonomous_vm_cluster_compartment (
  change_cloud_autonomous_vm_cluster_compartment_details dbms_cloud_oci_database_change_cloud_autonomous_vm_cluster_compartment_details_t,
  cloud_autonomous_vm_cluster_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_cloud_autonomous_vm_cluster_compartment_response_t;

Parameters

Parameter	Description
`change_cloud_autonomous_vm_cluster_compartment_details`	(required) Request to move cloud Autonomous VM cluster to a different compartment
`cloud_autonomous_vm_cluster_id`	(required) The Cloud VM cluster OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_CLOUD_EXADATA_INFRASTRUCTURE_COMPARTMENT Function

Moves a cloud Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.For more information about moving resources to a different compartment, see Moving Database Resources to a Different Compartment.

Syntax

FUNCTION change_cloud_exadata_infrastructure_compartment (
  change_cloud_exadata_infrastructure_compartment_details dbms_cloud_oci_database_change_cloud_exadata_infrastructure_compartment_details_t,
  cloud_exadata_infrastructure_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_cloud_exadata_infrastructure_compartment_response_t;

Parameters

Parameter	Description
`change_cloud_exadata_infrastructure_compartment_details`	(required) Request to move cloud Exadata infrastructure resource to a different compartment.
`cloud_exadata_infrastructure_id`	(required) The cloud Exadata infrastructure OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_CLOUD_VM_CLUSTER_COMPARTMENT Function

Moves a cloud VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Syntax

FUNCTION change_cloud_vm_cluster_compartment (
  change_cloud_vm_cluster_compartment_details dbms_cloud_oci_database_change_cloud_vm_cluster_compartment_details_t,
  cloud_vm_cluster_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_cloud_vm_cluster_compartment_response_t;

Parameters

Parameter	Description
`change_cloud_vm_cluster_compartment_details`	(required) Request to move cloud VM cluster to a different compartment
`cloud_vm_cluster_id`	(required) The cloud VM cluster OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_SOFTWARE_IMAGE_COMPARTMENT Function

Move the Database Software Image and its dependent resources to the specified compartment. For more information about moving Databse Software Images, see Moving Database Resources to a Different Compartment.

Syntax

FUNCTION change_database_software_image_compartment (
  change_compartment_details dbms_cloud_oci_database_change_compartment_details_t,
  database_software_image_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_database_software_image_compartment_response_t;

Parameters

Parameter	Description
`change_compartment_details`	(required) Request to move Database Software Image to a different compartment
`database_software_image_id`	(required) The DB system OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_DATAGUARD_ROLE Function

Switch the Autonomous Container Database role between Standby and Snapshot Standby. For more information about changing Autonomous Container Databases Dataguard Role, see Convert Physical Standby to Snapshot Standby and Convert Snapshot Standby to Physical Standby.

Syntax

FUNCTION change_dataguard_role (
  change_dataguard_role_details dbms_cloud_oci_database_change_dataguard_role_details_t,
  autonomous_container_database_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_db_database_change_dataguard_role_response_t;

Parameters

Parameter	Description
`change_dataguard_role_details`	(required) Request to Change the Autonomous Container Database Dataguard role.
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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_SYSTEM_COMPARTMENT Function

Moves the DB system and its dependent resources to the specified compartment. For more information about moving DB systems, see Moving Database Resources to a Different Compartment.

Syntax

FUNCTION change_db_system_compartment (
  change_compartment_details dbms_cloud_oci_database_change_compartment_details_t,
  db_system_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_db_system_compartment_response_t;

Parameters

Parameter	Description
`change_compartment_details`	(required) Request to move the DB system to a different compartment. Note: Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.
`db_system_id`	(required) The DB system OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_DISASTER_RECOVERY_CONFIGURATION Function

This operation updates the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless database, and must be run on the standby side.

Syntax

FUNCTION change_disaster_recovery_configuration (
  autonomous_database_id varchar2,
  change_disaster_recovery_configuration_details dbms_cloud_oci_database_change_disaster_recovery_configuration_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_db_database_change_disaster_recovery_configuration_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`change_disaster_recovery_configuration_details`	(required) Request to update the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless database.
`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) 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://database.{region}.{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_EXADATA_INFRASTRUCTURE_COMPARTMENT Function

Moves an Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only. To move an Exadata Cloud Service infrastructure resource to another compartment, use the CHANGE_CLOUD_EXADATA_INFRASTRUCTURE_COMPARTMENT Function operation.

Syntax

FUNCTION change_exadata_infrastructure_compartment (
  change_exadata_infrastructure_compartment_details dbms_cloud_oci_database_change_exadata_infrastructure_compartment_details_t,
  exadata_infrastructure_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_exadata_infrastructure_compartment_response_t;

Parameters

Parameter	Description
`change_exadata_infrastructure_compartment_details`	(required) Request to move Exadata infrastructure to a different compartment
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_CONTAINER_DATABASE_COMPARTMENT Function

Move the CREATE_EXTERNAL_CONTAINER_DATABASE_DETAILS Function and its dependent resources to the specified compartment. For more information about moving external container databases, see Moving Database Resources to a Different Compartment.

Syntax

FUNCTION change_external_container_database_compartment (
  change_compartment_details dbms_cloud_oci_database_change_compartment_details_t,
  external_container_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_external_container_database_compartment_response_t;

Parameters

Parameter	Description
`change_compartment_details`	(required) Request to move the external container database to a different compartment.
`external_container_database_id`	(required) The ExternalContainerDatabase OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_NON_CONTAINER_DATABASE_COMPARTMENT Function

Move the external non-container database and its dependent resources to the specified compartment. For more information about moving external non-container databases, see Moving Database Resources to a Different Compartment.

Syntax

FUNCTION change_external_non_container_database_compartment (
  change_compartment_details dbms_cloud_oci_database_change_compartment_details_t,
  external_non_container_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_external_non_container_database_compartment_response_t;

Parameters

Parameter	Description
`change_compartment_details`	(required) Request to move the external non-container database to a different compartment.
`external_non_container_database_id`	(required) The external non-container database OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_PLUGGABLE_DATABASE_COMPARTMENT Function

Move the CREATE_EXTERNAL_PLUGGABLE_DATABASE_DETAILS Function and its dependent resources to the specified compartment. For more information about moving external pluggable databases, see Moving Database Resources to a Different Compartment.

Syntax

FUNCTION change_external_pluggable_database_compartment (
  change_compartment_details dbms_cloud_oci_database_change_compartment_details_t,
  external_pluggable_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_external_pluggable_database_compartment_response_t;

Parameters

Parameter	Description
`change_compartment_details`	(required) Request to move the `CREATE_EXTERNAL_PLUGGABLE_DATABASE_DETAILS` Function resource to a different compartment.
`external_pluggable_database_id`	(required) The ExternalPluggableDatabaseId OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_KEY_STORE_COMPARTMENT Function

Move the key store resource to the specified compartment. For more information about moving key stores, see Moving Database Resources to a Different Compartment.

Syntax

FUNCTION change_key_store_compartment (
  change_key_store_compartment_details dbms_cloud_oci_database_change_key_store_compartment_details_t,
  key_store_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_key_store_compartment_response_t;

Parameters

Parameter	Description
`change_key_store_compartment_details`	(required) Request to move key store to a different compartment
`key_store_id`	(required) The OCID of the key store.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_KEY_STORE_TYPE Function

Changes encryption key management type

Syntax

FUNCTION change_key_store_type (
  database_id varchar2,
  change_key_store_type_details dbms_cloud_oci_database_change_key_store_type_details_t,
  if_match varchar2 DEFAULT NULL,
  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_db_database_change_key_store_type_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`change_key_store_type_details`	(required) Request to change the source of the encryption key for the database.
`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 may 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://database.{region}.{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_ONEOFF_PATCH_COMPARTMENT Function

Move the one-off patch to the specified compartment.

Syntax

FUNCTION change_oneoff_patch_compartment (
  change_compartment_details dbms_cloud_oci_database_change_compartment_details_t,
  oneoff_patch_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_oneoff_patch_compartment_response_t;

Parameters

Parameter	Description
`change_compartment_details`	(required) Request to move one-off patch to a different compartment
`oneoff_patch_id`	(required) The one-off patch OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_VM_CLUSTER_COMPARTMENT Function

Moves a VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only. To move a cloud VM cluster in an Exadata Cloud Service instance to another compartment, use the CHANGE_CLOUD_VM_CLUSTER_COMPARTMENT Function operation.

Syntax

FUNCTION change_vm_cluster_compartment (
  change_vm_cluster_compartment_details dbms_cloud_oci_database_change_vm_cluster_compartment_details_t,
  vm_cluster_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_change_vm_cluster_compartment_response_t;

Parameters

Parameter	Description
`change_vm_cluster_compartment_details`	(required) Request to move the Exadata Cloud@Customer VM cluster to a different compartment.
`vm_cluster_id`	(required) The VM cluster OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_DATABASE_CONNECTOR_CONNECTION_STATUS Function

Check the status of the external database connection specified in this connector. This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.

Syntax

FUNCTION check_external_database_connector_connection_status (
  external_database_connector_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_check_external_database_connector_connection_status_response_t;

Parameters

Parameter	Description
`external_database_connector_id`	(required) The OCID of the external database connector resource (`ExternalDatabaseConnectorId`).
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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.

COMPLETE_EXTERNAL_BACKUP_JOB Function

Changes the status of the standalone backup resource to `ACTIVE` after the backup is created from the on-premises database and placed in Oracle Cloud Infrastructure Object Storage. **Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud for more information.

Syntax

FUNCTION complete_external_backup_job (
  backup_id varchar2,
  complete_external_backup_job_details dbms_cloud_oci_database_complete_external_backup_job_details_t,
  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_db_database_complete_external_backup_job_response_t;

Parameters

Parameter	Description
`backup_id`	(required) The backup OCID.
`complete_external_backup_job_details`	(required) Updates the status of the backup resource.
`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 may 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://database.{region}.{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_AUTONOMOUS_DATABASE_VAULT_KEY Function

Configures the Autonomous Database Vault service key.

Syntax

FUNCTION configure_autonomous_database_vault_key (
  autonomous_database_id varchar2,
  configure_autonomous_database_vault_key_details dbms_cloud_oci_database_configure_autonomous_database_vault_key_details_t,
  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_db_database_configure_autonomous_database_vault_key_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`configure_autonomous_database_vault_key_details`	(required) Configuration details for the Autonomous Database Vault service key.
`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) Unique identifier for the request.
`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 may 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://database.{region}.{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_SAAS_ADMIN_USER Function

This operation updates SaaS administrative user configuration of the Autonomous Database.

Syntax

FUNCTION configure_saas_admin_user (
  autonomous_database_id varchar2,
  configure_saas_admin_user_details dbms_cloud_oci_database_configure_saas_admin_user_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_db_database_configure_saas_admin_user_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`configure_saas_admin_user_details`	(required) Request to update SaaS administrative user configuration of the Autonomous Database.
`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) 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://database.{region}.{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.

CONVERT_TO_PDB Function

Converts a non-container database to a pluggable database.

Syntax

FUNCTION convert_to_pdb (
  database_id varchar2,
  convert_to_pdb_details dbms_cloud_oci_database_convert_to_pdb_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_db_database_convert_to_pdb_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`convert_to_pdb_details`	(required) Request to convert a non-container database to a pluggable database.
`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) 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://database.{region}.{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.

CONVERT_TO_REGULAR_PLUGGABLE_DATABASE Function

Converts a Refreshable clone to Regular pluggable database (PDB). Pluggable Database will be in `READ_WRITE` openmode after conversion.

Syntax

FUNCTION convert_to_regular_pluggable_database (
  convert_to_regular_pluggable_database_details dbms_cloud_oci_database_convert_to_regular_pluggable_database_details_t,
  pluggable_database_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_db_database_convert_to_regular_pluggable_database_response_t;

Parameters

Parameter	Description
`convert_to_regular_pluggable_database_details`	(required) Request to convert a Refreshable clone pluggable database (PDB) to a Regular pluggable database.
`pluggable_database_id`	(required) The database OCID.
`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) Unique identifier for the request.
`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 may 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://database.{region}.{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_APPLICATION_VIP Function

Creates a new application virtual IP (VIP) address in the specified cloud VM cluster based on the request parameters you provide.

Syntax

FUNCTION create_application_vip (
  create_application_vip_details dbms_cloud_oci_database_create_application_vip_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_db_database_create_application_vip_response_t;

Parameters

Parameter	Description
`create_application_vip_details`	(required) Request to create a new application virtual IP (VIP) address.
`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 may 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://database.{region}.{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_AUTONOMOUS_CONTAINER_DATABASE Function

Creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure.

Syntax

FUNCTION create_autonomous_container_database (
  create_autonomous_container_database_details dbms_cloud_oci_database_create_autonomous_container_database_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_create_autonomous_container_database_response_t;

Parameters

Parameter	Description
`create_autonomous_container_database_details`	(required) Request to create an Autonomous Container Database in a specified Autonomous Exadata Infrastructure or in Autonomous VM Cluster.
`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 may 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://database.{region}.{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_AUTONOMOUS_CONTAINER_DATABASE_DATAGUARD_ASSOCIATION Function

Create a new Autonomous Data Guard association. An Autonomous Data Guard association represents the replication relationship between the specified Autonomous Container database and a peer Autonomous Container database. For more information, see Using Oracle Data Guard. All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see Resource Identifiers.

Syntax

FUNCTION create_autonomous_container_database_dataguard_association (
  autonomous_container_database_id varchar2,
  create_autonomous_container_database_dataguard_association_details dbms_cloud_oci_database_create_autonomous_container_database_dataguard_association_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_create_autonomous_container_database_dataguard_association_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`create_autonomous_container_database_dataguard_association_details`	(required) A request to create an Autonomous Data Guard association.
`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 may 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://database.{region}.{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_AUTONOMOUS_DATABASE Function

Creates a new Autonomous Database.

Syntax

FUNCTION create_autonomous_database (
  create_autonomous_database_details dbms_cloud_oci_database_create_autonomous_database_base_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_db_database_create_autonomous_database_response_t;

Parameters

Parameter	Description
`create_autonomous_database_details`	(required) Request to create a new Autonomous 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 may 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://database.{region}.{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_AUTONOMOUS_DATABASE_BACKUP Function

Creates a new Autonomous Database backup for the specified database based on the provided request parameters.

Syntax

FUNCTION create_autonomous_database_backup (
  create_autonomous_database_backup_details dbms_cloud_oci_database_create_autonomous_database_backup_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_db_database_create_autonomous_database_backup_response_t;

Parameters

Parameter	Description
`create_autonomous_database_backup_details`	(required) Request to create a new Autonomous Database backup.
`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 may 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://database.{region}.{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_AUTONOMOUS_VM_CLUSTER Function

Creates an Autonomous VM cluster for Exadata Cloud@Customer. To create an Autonomous VM Cluster in the Oracle cloud, see CREATE_CLOUD_AUTONOMOUS_VM_CLUSTER Function.

Syntax

FUNCTION create_autonomous_vm_cluster (
  create_autonomous_vm_cluster_details dbms_cloud_oci_database_create_autonomous_vm_cluster_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_db_database_create_autonomous_vm_cluster_response_t;

Parameters

Parameter	Description
`create_autonomous_vm_cluster_details`	(required) Request to create an Autonomous VM cluster.
`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 may 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://database.{region}.{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_BACKUP Function

Creates a new backup in the specified database based on the request parameters you provide. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

Syntax

FUNCTION create_backup (
  create_backup_details dbms_cloud_oci_database_create_backup_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_create_backup_response_t;

Parameters

Parameter	Description
`create_backup_details`	(required) Request to create a new database backup.
`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 may 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://database.{region}.{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_BACKUP_DESTINATION Function

Creates a backup destination in an Exadata Cloud@Customer system.

Syntax

FUNCTION create_backup_destination (
  create_backup_destination_details dbms_cloud_oci_database_create_backup_destination_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_db_database_create_backup_destination_response_t;

Parameters

Parameter	Description
`create_backup_destination_details`	(required) Request to create a new backup destination.
`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 may 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://database.{region}.{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_CLOUD_AUTONOMOUS_VM_CLUSTER Function

Creates an Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see CREATE_AUTONOMOUS_VM_CLUSTER Function.

Syntax

FUNCTION create_cloud_autonomous_vm_cluster (
  create_cloud_autonomous_vm_cluster_details dbms_cloud_oci_database_create_cloud_autonomous_vm_cluster_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_db_database_create_cloud_autonomous_vm_cluster_response_t;

Parameters

Parameter	Description
`create_cloud_autonomous_vm_cluster_details`	(required) Request to create a cloud Autonomous VM cluster.
`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 may 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://database.{region}.{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_CLOUD_EXADATA_INFRASTRUCTURE Function

Creates a cloud Exadata infrastructure resource. This resource is used to create either an Exadata Cloud Service instance or an Autonomous Database on dedicated Exadata infrastructure.

Syntax

FUNCTION create_cloud_exadata_infrastructure (
  create_cloud_exadata_infrastructure_details dbms_cloud_oci_database_create_cloud_exadata_infrastructure_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_db_database_create_cloud_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`create_cloud_exadata_infrastructure_details`	(required) Request to create a cloud Exadata infrastructure resource in an Exadata Cloud Service instance.
`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 may 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://database.{region}.{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_CLOUD_VM_CLUSTER Function

Creates a cloud VM cluster.

Syntax

FUNCTION create_cloud_vm_cluster (
  create_cloud_vm_cluster_details dbms_cloud_oci_database_create_cloud_vm_cluster_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_db_database_create_cloud_vm_cluster_response_t;

Parameters

Parameter	Description
`create_cloud_vm_cluster_details`	(required) Request to create a cloud VM cluster. Applies to Exadata Cloud Service instances only. See The New Exadata Cloud Service Resource Model for information on this resource type.
`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 may 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://database.{region}.{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_CONSOLE_CONNECTION Function

Creates a new console connection to the specified database node. After the console connection has been created and is available, you connect to the console using SSH.

Syntax

FUNCTION create_console_connection (
  create_console_connection_details dbms_cloud_oci_database_create_console_connection_details_t,
  db_node_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_create_console_connection_response_t;

Parameters

Parameter	Description
`create_console_connection_details`	(required) Request object for creating an CreateConsoleConnection
`db_node_id`	(required) The database node OCID.
`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 may 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://database.{region}.{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_CONSOLE_HISTORY Function

Captures the most recent serial console data (up to a megabyte) for the specified database node.

Syntax

FUNCTION create_console_history (
  create_console_history_details dbms_cloud_oci_database_create_console_history_details_t,
  db_node_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_db_database_create_console_history_response_t;

Parameters

Parameter	Description
`create_console_history_details`	(required) Request object for creating a console history.
`db_node_id`	(required) The database node OCID.
`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 may 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://database.{region}.{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_DATA_GUARD_ASSOCIATION Function

Creates a new Data Guard association. A Data Guard association represents the replication relationship between the specified database and a peer database. For more information, see Using Oracle Data Guard. All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see Resource Identifiers.

Syntax

FUNCTION create_data_guard_association (
  database_id varchar2,
  create_data_guard_association_details dbms_cloud_oci_database_create_data_guard_association_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_create_data_guard_association_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`create_data_guard_association_details`	(required) A request to create a Data Guard association.
`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 may 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://database.{region}.{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_DATABASE Function

Creates a new database in the specified Database Home. If the database version is provided, it must match the version of the Database Home. Applies to Exadata and Exadata Cloud@Customer systems.

Syntax

FUNCTION create_database (
  create_new_database_details dbms_cloud_oci_database_create_database_base_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_db_database_create_database_response_t;

Parameters

Parameter	Description
`create_new_database_details`	(required) Request to create a new 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 may 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://database.{region}.{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_DATABASE_SOFTWARE_IMAGE Function

create database software image in the specified compartment.

Syntax

FUNCTION create_database_software_image (
  create_database_software_image_details dbms_cloud_oci_database_create_database_software_image_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_create_database_software_image_response_t;

Parameters

Parameter	Description
`create_database_software_image_details`	(required) Request to create database software image.
`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 may 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://database.{region}.{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_HOME Function

Creates a new Database Home in the specified database system based on the request parameters you provide. Applies to bare metal DB systems, Exadata systems, and Exadata Cloud@Customer systems.

Syntax

FUNCTION create_db_home (
  create_db_home_with_db_system_id_details dbms_cloud_oci_database_create_db_home_base_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_create_db_home_response_t;

Parameters

Parameter	Description
`create_db_home_with_db_system_id_details`	(required) Request to create a new Database Home.
`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 may 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://database.{region}.{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_EXADATA_INFRASTRUCTURE Function

Creates an Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. To create an Exadata Cloud Service infrastructure resource, use the CREATE_CLOUD_EXADATA_INFRASTRUCTURE Function operation.

Syntax

FUNCTION create_exadata_infrastructure (
  create_exadata_infrastructure_details dbms_cloud_oci_database_create_exadata_infrastructure_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_db_database_create_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`create_exadata_infrastructure_details`	(required) Request to create Exadata Cloud@Customer infrastructure.
`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 may 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://database.{region}.{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_BACKUP_JOB Function

Creates a new backup resource and returns the information the caller needs to back up an on-premises Oracle Database to Oracle Cloud Infrastructure. **Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud for more information.

Syntax

FUNCTION create_external_backup_job (
  create_external_backup_job_details dbms_cloud_oci_database_create_external_backup_job_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_create_external_backup_job_response_t;

Parameters

Parameter	Description
`create_external_backup_job_details`	(required) Request to create a cloud backup resource for a database running outside the cloud.
`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 may 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://database.{region}.{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_CONTAINER_DATABASE Function

Creates a new external container database resource.

Syntax

FUNCTION create_external_container_database (
  create_external_container_database_details dbms_cloud_oci_database_create_external_container_database_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_db_database_create_external_container_database_response_t;

Parameters

Parameter	Description
`create_external_container_database_details`	(required) Request to create a new external container database resource.
`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 may 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://database.{region}.{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_DATABASE_CONNECTOR Function

Creates a new external database connector.

Syntax

FUNCTION create_external_database_connector (
  create_external_database_connector_details dbms_cloud_oci_database_create_external_database_connector_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_db_database_create_external_database_connector_response_t;

Parameters

Parameter	Description
`create_external_database_connector_details`	(required) Request to create a connector to an external 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 may 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://database.{region}.{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_NON_CONTAINER_DATABASE Function

Creates a new ExternalNonContainerDatabase resource

Syntax

FUNCTION create_external_non_container_database (
  create_external_non_container_database_details dbms_cloud_oci_database_create_external_non_container_database_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_db_database_create_external_non_container_database_response_t;

Parameters

Parameter	Description
`create_external_non_container_database_details`	(required) Request to create a new external non-container 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 may 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://database.{region}.{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_PLUGGABLE_DATABASE Function

Registers a new CREATE_EXTERNAL_PLUGGABLE_DATABASE_DETAILS Function resource.

Syntax

FUNCTION create_external_pluggable_database (
  create_external_pluggable_database_details dbms_cloud_oci_database_create_external_pluggable_database_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_db_database_create_external_pluggable_database_response_t;

Parameters

Parameter	Description
`create_external_pluggable_database_details`	(required) Request to create a new external pluggable 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 may 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://database.{region}.{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_KEY_STORE Function

Creates a Key Store.

Syntax

FUNCTION create_key_store (
  create_key_store_details dbms_cloud_oci_database_create_key_store_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_db_database_create_key_store_response_t;

Parameters

Parameter	Description
`create_key_store_details`	(required) Request to create a new key store.
`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 may 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://database.{region}.{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_MAINTENANCE_RUN Function

Creates a maintenance run with one of the following: The latest available release update patch (RUP) for the Autonomous Container Database. The latest available RUP and DST time zone (TZ) file updates for the Autonomous Container Database. Creates a maintenance run to update the DST TZ file for the Autonomous Container Database.

Syntax

FUNCTION create_maintenance_run (
  create_maintenance_run_details dbms_cloud_oci_database_create_maintenance_run_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_db_database_create_maintenance_run_response_t;

Parameters

Parameter	Description
`create_maintenance_run_details`	(required) Request to create a Maintenance Run for the resource.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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_ONEOFF_PATCH Function

Creates one-off patch for specified database version to download.

Syntax

FUNCTION create_oneoff_patch (
  create_oneoff_patch_details dbms_cloud_oci_database_create_oneoff_patch_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_db_database_create_oneoff_patch_response_t;

Parameters

Parameter	Description
`create_oneoff_patch_details`	(required) Request to create a one-off patch to download.
`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 may 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://database.{region}.{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_PLUGGABLE_DATABASE Function

Creates and starts a pluggable database in the specified container database. Pluggable Database can be created using different operations (e.g. LocalClone, RemoteClone, Relocate ) with this API. Use the START_PLUGGABLE_DATABASE Function and STOP_PLUGGABLE_DATABASE Function APIs to start and stop the pluggable database.

Syntax

FUNCTION create_pluggable_database (
  create_pluggable_database_details dbms_cloud_oci_database_create_pluggable_database_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_db_database_create_pluggable_database_response_t;

Parameters

Parameter	Description
`create_pluggable_database_details`	(required) Request to create pluggable 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 may 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://database.{region}.{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_VM_CLUSTER Function

Creates an Exadata Cloud@Customer VM cluster.

Syntax

FUNCTION create_vm_cluster (
  create_vm_cluster_details dbms_cloud_oci_database_create_vm_cluster_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_db_database_create_vm_cluster_response_t;

Parameters

Parameter	Description
`create_vm_cluster_details`	(required) Request to create a VM cluster. Applies to Exadata Cloud@Customer instances only. See `CREATE_CLOUD_VM_CLUSTER_DETAILS` Function for details on creating a cloud VM cluster in an Exadata Cloud Service instance.
`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 may 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://database.{region}.{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_VM_CLUSTER_NETWORK Function

Creates the VM cluster network. Applies to Exadata Cloud@Customer instances only. To create a cloud VM cluster in an Exadata Cloud Service instance, use the CREATE_CLOUD_VM_CLUSTER Function operation.

Syntax

FUNCTION create_vm_cluster_network (
  exadata_infrastructure_id varchar2,
  vm_cluster_network_details dbms_cloud_oci_database_vm_cluster_network_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_db_database_create_vm_cluster_network_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`vm_cluster_network_details`	(required) Request to create the Cloud@Customer VM cluster network.
`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 may 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://database.{region}.{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.

DB_NODE_ACTION Function

Performs one of the following power actions on the specified DB node: - start - power on - stop - power off - softreset - ACPI shutdown and power on - reset - power off and power on **Note:** Stopping a node affects billing differently, depending on the type of DB system: *Bare metal and Exadata systems* - The _stop_ state has no effect on the resources you consume. Billing continues for DB nodes that you stop, and related resources continue to apply against any relevant quotas. You must terminate the DB system (TERMINATE_DB_SYSTEM Function) to remove its resources from billing and quotas. *Virtual machine DB systems* - Stopping a node stops billing for all OCPUs associated with that node, and billing resumes when you restart the node.

Syntax

FUNCTION db_node_action (
  db_node_id varchar2,
  action varchar2,
  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_db_database_db_node_action_response_t;

Parameters

Parameter	Description
`db_node_id`	(required) The database node OCID.
`action`	(required) The action to perform on the DB Node. Allowed values are: 'STOP', 'START', 'SOFTRESET', 'RESET'
`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 may 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://database.{region}.{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_APPLICATION_VIP Function

Deletes and deregisters the specified application virtual IP (VIP) address.

Syntax

FUNCTION delete_application_vip (
  application_vip_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_db_database_delete_application_vip_response_t;

Parameters

Parameter	Description
`application_vip_id`	(required) The OCID of the application virtual IP (VIP) address.
`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) 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://database.{region}.{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_AUTONOMOUS_DATABASE Function

Deletes the specified Autonomous Database.

Syntax

FUNCTION delete_autonomous_database (
  autonomous_database_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_db_database_delete_autonomous_database_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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) 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://database.{region}.{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_AUTONOMOUS_DATABASE_BACKUP Function

Deletes a long-term backup. You cannot delete other backups using this API.

Syntax

FUNCTION delete_autonomous_database_backup (
  autonomous_database_backup_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_db_database_delete_autonomous_database_backup_response_t;

Parameters

Parameter	Description
`autonomous_database_backup_id`	(required) The OCID of the Autonomous Database backup.
`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) 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://database.{region}.{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_AUTONOMOUS_VM_CLUSTER Function

Deletes the specified Autonomous VM cluster in an Exadata Cloud@Customer system. To delete an Autonomous VM Cluster in the Oracle cloud, see DELETE_CLOUD_AUTONOMOUS_VM_CLUSTER Function.

Syntax

FUNCTION delete_autonomous_vm_cluster (
  autonomous_vm_cluster_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_db_database_delete_autonomous_vm_cluster_response_t;

Parameters

Parameter	Description
`autonomous_vm_cluster_id`	(required) The autonomous VM cluster OCID.
`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) 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://database.{region}.{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_BACKUP Function

Deletes a full backup. You cannot delete automatic backups using this API.

Syntax

FUNCTION delete_backup (
  backup_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_delete_backup_response_t;

Parameters

Parameter	Description
`backup_id`	(required) The backup OCID.
`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://database.{region}.{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_BACKUP_DESTINATION Function

Deletes a backup destination in an Exadata Cloud@Customer system.

Syntax

FUNCTION delete_backup_destination (
  backup_destination_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_db_database_delete_backup_destination_response_t;

Parameters

Parameter	Description
`backup_destination_id`	(required) The OCID of the backup destination.
`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) 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://database.{region}.{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_CLOUD_AUTONOMOUS_VM_CLUSTER Function

Deletes the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see DELETE_AUTONOMOUS_VM_CLUSTER Function.

Syntax

FUNCTION delete_cloud_autonomous_vm_cluster (
  cloud_autonomous_vm_cluster_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_db_database_delete_cloud_autonomous_vm_cluster_response_t;

Parameters

Parameter	Description
`cloud_autonomous_vm_cluster_id`	(required) The Cloud VM cluster OCID.
`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) 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://database.{region}.{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_CLOUD_EXADATA_INFRASTRUCTURE Function

Deletes the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Syntax

FUNCTION delete_cloud_exadata_infrastructure (
  cloud_exadata_infrastructure_id varchar2,
  if_match varchar2 DEFAULT NULL,
  is_delete_vm_clusters number 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_db_database_delete_cloud_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`cloud_exadata_infrastructure_id`	(required) The cloud Exadata infrastructure OCID.
`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.
`is_delete_vm_clusters`	(optional) If `true`, forces the deletion the specified cloud Exadata infrastructure resource as well as all associated VM clusters. If `false`, the cloud Exadata infrastructure resource can be deleted only if it has no associated VM clusters. Default value is `false`.
`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://database.{region}.{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_CLOUD_VM_CLUSTER Function

Deletes the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Syntax

FUNCTION delete_cloud_vm_cluster (
  cloud_vm_cluster_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_db_database_delete_cloud_vm_cluster_response_t;

Parameters

Parameter	Description
`cloud_vm_cluster_id`	(required) The cloud VM cluster OCID.
`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) 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://database.{region}.{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_CONSOLE_CONNECTION Function

Deletes the specified database node console connection.

Syntax

FUNCTION delete_console_connection (
  db_node_id varchar2,
  console_connection_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_delete_console_connection_response_t;

Parameters

Parameter	Description
`db_node_id`	(required) The database node OCID.
`console_connection_id`	(required) The OCID of the console connection.
`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://database.{region}.{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_CONSOLE_HISTORY Function

Deletes the specified database node console history.

Syntax

FUNCTION delete_console_history (
  db_node_id varchar2,
  console_history_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_db_database_delete_console_history_response_t;

Parameters

Parameter	Description
`db_node_id`	(required) The database node OCID.
`console_history_id`	(required) The OCID of the console history.
`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) 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://database.{region}.{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_DATABASE Function

Deletes the specified database. Applies only to Exadata systems. The data in this database is local to the Exadata system and will be lost when the database is deleted. Oracle recommends that you back up any data in the Exadata system prior to deleting it. You can use the `performFinalBackup` parameter to have the Exadata system database backed up before it is deleted.

Syntax

FUNCTION delete_database (
  database_id varchar2,
  if_match varchar2 DEFAULT NULL,
  perform_final_backup number 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_db_database_delete_database_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`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.
`perform_final_backup`	(optional) Whether to perform a final backup of the database or not. Default is false. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. This parameter is used in multiple APIs. Refer to the API description for details on how the operation uses it.
`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://database.{region}.{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_DATABASE_SOFTWARE_IMAGE Function

Delete a database software image

Syntax

FUNCTION delete_database_software_image (
  database_software_image_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_delete_database_software_image_response_t;

Parameters

Parameter	Description
`database_software_image_id`	(required) The DB system OCID.
`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://database.{region}.{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_HOME Function

Deletes a Database Home. Applies to bare metal DB systems, Exadata Cloud Service, and Exadata Cloud@Customer systems. Oracle recommends that you use the `performFinalBackup` parameter to back up any data on a bare metal DB system before you delete a Database Home. On an Exadata Cloud@Customer system or an Exadata Cloud Service system, you can delete a Database Home only when there are no databases in it and therefore you cannot use the `performFinalBackup` parameter to back up data.

Syntax

FUNCTION delete_db_home (
  db_home_id varchar2,
  if_match varchar2 DEFAULT NULL,
  perform_final_backup number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_delete_db_home_response_t;

Parameters

Parameter	Description
`db_home_id`	(required) The Database Home OCID.
`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.
`perform_final_backup`	(optional) Whether to perform a final backup of the database or not. Default is false. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. This parameter is used in multiple APIs. Refer to the API description for details on how the operation uses it.
`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://database.{region}.{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_EXADATA_INFRASTRUCTURE Function

Deletes the Exadata Cloud@Customer infrastructure.

Syntax

FUNCTION delete_exadata_infrastructure (
  exadata_infrastructure_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_db_database_delete_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`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) 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://database.{region}.{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_CONTAINER_DATABASE Function

Deletes the CREATE_EXTERNAL_CONTAINER_DATABASE_DETAILS Function resource. Any external pluggable databases registered under this container database must be deleted in your Oracle Cloud Infrastructure tenancy prior to this operation.

Syntax

FUNCTION delete_external_container_database (
  external_container_database_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_db_database_delete_external_container_database_response_t;

Parameters

Parameter	Description
`external_container_database_id`	(required) The ExternalContainerDatabase OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_DATABASE_CONNECTOR Function

Deletes an external database connector. Any services enabled using the external database connector must be deleted prior to this operation.

Syntax

FUNCTION delete_external_database_connector (
  external_database_connector_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_db_database_delete_external_database_connector_response_t;

Parameters

Parameter	Description
`external_database_connector_id`	(required) The OCID of the external database connector resource (`ExternalDatabaseConnectorId`).
`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) 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://database.{region}.{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_NON_CONTAINER_DATABASE Function

Deletes the Oracle Cloud Infrastructure resource representing an external non-container database.

Syntax

FUNCTION delete_external_non_container_database (
  external_non_container_database_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_db_database_delete_external_non_container_database_response_t;

Parameters

Parameter	Description
`external_non_container_database_id`	(required) The external non-container database OCID.
`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) 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://database.{region}.{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_PLUGGABLE_DATABASE Function

Deletes the CREATE_EXTERNAL_PLUGGABLE_DATABASE_DETAILS Function. resource.

Syntax

FUNCTION delete_external_pluggable_database (
  external_pluggable_database_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_db_database_delete_external_pluggable_database_response_t;

Parameters

Parameter	Description
`external_pluggable_database_id`	(required) The ExternalPluggableDatabaseId OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_KEY_STORE Function

Deletes a key store.

Syntax

FUNCTION delete_key_store (
  key_store_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_db_database_delete_key_store_response_t;

Parameters

Parameter	Description
`key_store_id`	(required) The OCID of the key store.
`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) 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://database.{region}.{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_ONEOFF_PATCH Function

Deletes a one-off patch.

Syntax

FUNCTION delete_oneoff_patch (
  oneoff_patch_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_db_database_delete_oneoff_patch_response_t;

Parameters

Parameter	Description
`oneoff_patch_id`	(required) The one-off patch OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_PLUGGABLE_DATABASE Function

Deletes the specified pluggable database.

Syntax

FUNCTION delete_pluggable_database (
  pluggable_database_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_db_database_delete_pluggable_database_response_t;

Parameters

Parameter	Description
`pluggable_database_id`	(required) The database OCID.
`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) 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://database.{region}.{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_VM_CLUSTER Function

Deletes the specified VM cluster. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION delete_vm_cluster (
  vm_cluster_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_db_database_delete_vm_cluster_response_t;

Parameters

Parameter	Description
`vm_cluster_id`	(required) The VM cluster OCID.
`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) 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://database.{region}.{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_VM_CLUSTER_NETWORK Function

Deletes the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To delete a cloud VM cluster in an Exadata Cloud Service instance, use the DELETE_CLOUD_VM_CLUSTER Function operation.

Syntax

FUNCTION delete_vm_cluster_network (
  exadata_infrastructure_id varchar2,
  vm_cluster_network_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_db_database_delete_vm_cluster_network_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`vm_cluster_network_id`	(required) The VM cluster network OCID.
`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) 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://database.{region}.{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.

DEREGISTER_AUTONOMOUS_DATABASE_DATA_SAFE Function

Asynchronously deregisters this Autonomous Database with Data Safe.

Syntax

FUNCTION deregister_autonomous_database_data_safe (
  autonomous_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  deregister_autonomous_database_data_safe_details dbms_cloud_oci_database_deregister_autonomous_database_data_safe_details_t DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_deregister_autonomous_database_data_safe_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`deregister_autonomous_database_data_safe_details`	(optional) Details for deregistering an Autonomous Database with Data Safe.
`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://database.{region}.{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_AUTONOMOUS_DATABASE_MANAGEMENT Function

Disables Database Management for the Autonomous Database resource.

Syntax

FUNCTION disable_autonomous_database_management (
  autonomous_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_db_database_disable_autonomous_database_management_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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://database.{region}.{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_AUTONOMOUS_DATABASE_OPERATIONS_INSIGHTS Function

Disables Operations Insights for the Autonomous Database resource.

Syntax

FUNCTION disable_autonomous_database_operations_insights (
  autonomous_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_db_database_disable_autonomous_database_operations_insights_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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://database.{region}.{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_DATABASE_MANAGEMENT Function

Disables the Database Management service for the database.

Syntax

FUNCTION disable_database_management (
  database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_disable_database_management_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_CONTAINER_DATABASE_DATABASE_MANAGEMENT Function

Disable Database Management service for the external container database.

Syntax

FUNCTION disable_external_container_database_database_management (
  external_container_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_disable_external_container_database_database_management_response_t;

Parameters

Parameter	Description
`external_container_database_id`	(required) The ExternalContainerDatabase OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_CONTAINER_DATABASE_STACK_MONITORING Function

Disable Stack Monitoring for the external container database.

Syntax

FUNCTION disable_external_container_database_stack_monitoring (
  external_container_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_disable_external_container_database_stack_monitoring_response_t;

Parameters

Parameter	Description
`external_container_database_id`	(required) The ExternalContainerDatabase OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_NON_CONTAINER_DATABASE_DATABASE_MANAGEMENT Function

Disable Database Management Service for the external non-container database. For more information about the Database Management Service, see Database Management Service.

Syntax

FUNCTION disable_external_non_container_database_database_management (
  external_non_container_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_disable_external_non_container_database_database_management_response_t;

Parameters

Parameter	Description
`external_non_container_database_id`	(required) The external non-container database OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_NON_CONTAINER_DATABASE_OPERATIONS_INSIGHTS Function

Disable Operations Insights for the external non-container database.

Syntax

FUNCTION disable_external_non_container_database_operations_insights (
  external_non_container_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_disable_external_non_container_database_operations_insights_response_t;

Parameters

Parameter	Description
`external_non_container_database_id`	(required) The external non-container database OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_NON_CONTAINER_DATABASE_STACK_MONITORING Function

Disable Stack Monitoring for the external non-container database.

Syntax

FUNCTION disable_external_non_container_database_stack_monitoring (
  external_non_container_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_disable_external_non_container_database_stack_monitoring_response_t;

Parameters

Parameter	Description
`external_non_container_database_id`	(required) The external non-container database OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_PLUGGABLE_DATABASE_DATABASE_MANAGEMENT Function

Disable Database Management Service for the external pluggable database. For more information about the Database Management Service, see Database Management Service.

Syntax

FUNCTION disable_external_pluggable_database_database_management (
  external_pluggable_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_disable_external_pluggable_database_database_management_response_t;

Parameters

Parameter	Description
`external_pluggable_database_id`	(required) The ExternalPluggableDatabaseId OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_PLUGGABLE_DATABASE_OPERATIONS_INSIGHTS Function

Disable Operations Insights for the external pluggable database.

Syntax

FUNCTION disable_external_pluggable_database_operations_insights (
  external_pluggable_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_disable_external_pluggable_database_operations_insights_response_t;

Parameters

Parameter	Description
`external_pluggable_database_id`	(required) The ExternalPluggableDatabaseId OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_PLUGGABLE_DATABASE_STACK_MONITORING Function

Disable Stack Monitoring for the external pluggable database.

Syntax

FUNCTION disable_external_pluggable_database_stack_monitoring (
  external_pluggable_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_disable_external_pluggable_database_stack_monitoring_response_t;

Parameters

Parameter	Description
`external_pluggable_database_id`	(required) The ExternalPluggableDatabaseId OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_PLUGGABLE_DATABASE_MANAGEMENT Function

Disables the Database Management service for the pluggable database.

Syntax

FUNCTION disable_pluggable_database_management (
  pluggable_database_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_disable_pluggable_database_management_response_t;

Parameters

Parameter	Description
`pluggable_database_id`	(required) The database OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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.

DOWNLOAD_EXADATA_INFRASTRUCTURE_CONFIG_FILE Function

Downloads the configuration file for the specified Exadata Cloud@Customer infrastructure.

Syntax

FUNCTION download_exadata_infrastructure_config_file (
  exadata_infrastructure_id varchar2,
  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_db_database_download_exadata_infrastructure_config_file_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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.

DOWNLOAD_ONEOFF_PATCH Function

Download one-off patch.

Syntax

FUNCTION download_oneoff_patch (
  oneoff_patch_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_download_oneoff_patch_response_t;

Parameters

Parameter	Description
`oneoff_patch_id`	(required) The one-off patch OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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.

DOWNLOAD_VALIDATION_REPORT Function

Downloads the network validation report file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION download_validation_report (
  exadata_infrastructure_id varchar2,
  vm_cluster_network_id varchar2,
  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_db_database_download_validation_report_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`vm_cluster_network_id`	(required) The VM cluster network OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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.

DOWNLOAD_VM_CLUSTER_NETWORK_CONFIG_FILE Function

Downloads the configuration file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION download_vm_cluster_network_config_file (
  exadata_infrastructure_id varchar2,
  vm_cluster_network_id varchar2,
  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_db_database_download_vm_cluster_network_config_file_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`vm_cluster_network_id`	(required) The VM cluster network OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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_AUTONOMOUS_DATABASE_MANAGEMENT Function

Enables Database Management for Autonomous Database.

Syntax

FUNCTION enable_autonomous_database_management (
  autonomous_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_db_database_enable_autonomous_database_management_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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://database.{region}.{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_AUTONOMOUS_DATABASE_OPERATIONS_INSIGHTS Function

Enables the specified Autonomous Database with Operations Insights.

Syntax

FUNCTION enable_autonomous_database_operations_insights (
  autonomous_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_db_database_enable_autonomous_database_operations_insights_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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://database.{region}.{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_DATABASE_MANAGEMENT Function

Enables the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure. This service allows the database to access tools including Metrics and Performance hub. Database Management is enabled at the container database (CDB) level.

Syntax

FUNCTION enable_database_management (
  database_id varchar2,
  enable_database_management_details dbms_cloud_oci_database_enable_database_management_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_enable_database_management_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`enable_database_management_details`	(required) Request to enable the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_CONTAINER_DATABASE_DATABASE_MANAGEMENT Function

Enables Database Management Service for the external container database. For more information about the Database Management Service, see Database Management Service.

Syntax

FUNCTION enable_external_container_database_database_management (
  external_container_database_id varchar2,
  enable_external_container_database_database_management_details dbms_cloud_oci_database_enable_external_container_database_database_management_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_enable_external_container_database_database_management_response_t;

Parameters

Parameter	Description
`external_container_database_id`	(required) The ExternalContainerDatabase OCID.
`enable_external_container_database_database_management_details`	(required) Request to enable the Database Management Service for an external container 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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_CONTAINER_DATABASE_STACK_MONITORING Function

Enable Stack Monitoring for the external container database.

Syntax

FUNCTION enable_external_container_database_stack_monitoring (
  external_container_database_id varchar2,
  enable_external_container_database_stack_monitoring_details dbms_cloud_oci_database_enable_external_container_database_stack_monitoring_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_enable_external_container_database_stack_monitoring_response_t;

Parameters

Parameter	Description
`external_container_database_id`	(required) The ExternalContainerDatabase OCID.
`enable_external_container_database_stack_monitoring_details`	(required) Details to enable Stack Monitoring on the external container 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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_NON_CONTAINER_DATABASE_DATABASE_MANAGEMENT Function

Enable Database Management Service for the external non-container database. For more information about the Database Management Service, see Database Management Service.

Syntax

FUNCTION enable_external_non_container_database_database_management (
  external_non_container_database_id varchar2,
  enable_external_non_container_database_database_management_details dbms_cloud_oci_database_enable_external_non_container_database_database_management_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_enable_external_non_container_database_database_management_response_t;

Parameters

Parameter	Description
`external_non_container_database_id`	(required) The external non-container database OCID.
`enable_external_non_container_database_database_management_details`	(required) Request to enable the Database Management Service for an external non-container 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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_NON_CONTAINER_DATABASE_OPERATIONS_INSIGHTS Function

Enable Operations Insights for the external non-container database.

Syntax

FUNCTION enable_external_non_container_database_operations_insights (
  external_non_container_database_id varchar2,
  enable_external_non_container_database_operations_insights_details dbms_cloud_oci_database_enable_external_non_container_database_operations_insights_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_enable_external_non_container_database_operations_insights_response_t;

Parameters

Parameter	Description
`external_non_container_database_id`	(required) The external non-container database OCID.
`enable_external_non_container_database_operations_insights_details`	(required) Details to enable Operations Insights on the external non-container 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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_NON_CONTAINER_DATABASE_STACK_MONITORING Function

Enable Stack Monitoring for the external non-container database.

Syntax

FUNCTION enable_external_non_container_database_stack_monitoring (
  external_non_container_database_id varchar2,
  enable_external_non_container_database_stack_monitoring_details dbms_cloud_oci_database_enable_external_non_container_database_stack_monitoring_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_enable_external_non_container_database_stack_monitoring_response_t;

Parameters

Parameter	Description
`external_non_container_database_id`	(required) The external non-container database OCID.
`enable_external_non_container_database_stack_monitoring_details`	(required) Details to enable Stack Monitoring on the external non-container 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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_PLUGGABLE_DATABASE_DATABASE_MANAGEMENT Function

Enable Database Management Service for the external pluggable database. For more information about the Database Management Service, see Database Management Service.

Syntax

FUNCTION enable_external_pluggable_database_database_management (
  external_pluggable_database_id varchar2,
  enable_external_pluggable_database_database_management_details dbms_cloud_oci_database_enable_external_pluggable_database_database_management_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_enable_external_pluggable_database_database_management_response_t;

Parameters

Parameter	Description
`external_pluggable_database_id`	(required) The ExternalPluggableDatabaseId OCID.
`enable_external_pluggable_database_database_management_details`	(required) Request to enable the Database Management Service for an external 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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_PLUGGABLE_DATABASE_OPERATIONS_INSIGHTS Function

Enable Operations Insights for the external pluggable database.

Syntax

FUNCTION enable_external_pluggable_database_operations_insights (
  external_pluggable_database_id varchar2,
  enable_external_pluggable_database_operations_insights_details dbms_cloud_oci_database_enable_external_pluggable_database_operations_insights_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_enable_external_pluggable_database_operations_insights_response_t;

Parameters

Parameter	Description
`external_pluggable_database_id`	(required) The ExternalPluggableDatabaseId OCID.
`enable_external_pluggable_database_operations_insights_details`	(required) Details to enable Operations Insights on the external pluggable 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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_PLUGGABLE_DATABASE_STACK_MONITORING Function

Enable Stack Monitoring for the external pluggable database.

Syntax

FUNCTION enable_external_pluggable_database_stack_monitoring (
  external_pluggable_database_id varchar2,
  enable_external_pluggable_database_stack_monitoring_details dbms_cloud_oci_database_enable_external_pluggable_database_stack_monitoring_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_enable_external_pluggable_database_stack_monitoring_response_t;

Parameters

Parameter	Description
`external_pluggable_database_id`	(required) The ExternalPluggableDatabaseId OCID.
`enable_external_pluggable_database_stack_monitoring_details`	(required) Details to enable Stack Monitoring on the external pluggable 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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_PLUGGABLE_DATABASE_MANAGEMENT Function

Enables the Database Management service for an Oracle Pluggable Database located in Oracle Cloud Infrastructure. This service allows the pluggable database to access tools including Metrics and Performance hub. Database Management is enabled at the pluggable database (PDB) level.

Syntax

FUNCTION enable_pluggable_database_management (
  pluggable_database_id varchar2,
  enable_pluggable_database_management_details dbms_cloud_oci_database_enable_pluggable_database_management_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_enable_pluggable_database_management_response_t;

Parameters

Parameter	Description
`pluggable_database_id`	(required) The database OCID.
`enable_pluggable_database_management_details`	(required) Request to enable the Database Management service for an Oracle Pluggable Database located in Oracle Cloud Infrastructure.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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.

FAIL_OVER_AUTONOMOUS_DATABASE Function

Initiates a failover the specified Autonomous Database to a standby. To perform a failover to a standby located in a remote region, specify the OCID of the remote standby using the `peerDbId` parameter.

Syntax

FUNCTION fail_over_autonomous_database (
  autonomous_database_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  peer_db_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_fail_over_autonomous_database_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`peer_db_id`	(optional) The database OCID of the Autonomous Data Guard standby database located in a different (remote) region from the source primary Autonomous Database.
`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://database.{region}.{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.

FAILOVER_AUTONOMOUS_CONTAINER_DATABASE_DATAGUARD_ASSOCIATION Function

Fails over the standby Autonomous Container Database identified by the autonomousContainerDatabaseId parameter to the primary Autonomous Container Database after the existing primary Autonomous Container Database fails or becomes unreachable. A failover can result in data loss, depending on the protection mode in effect at the time the primary Autonomous Container Database fails.

Syntax

FUNCTION failover_autonomous_container_database_dataguard_association (
  autonomous_container_database_id varchar2,
  autonomous_container_database_dataguard_association_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_failover_autonomous_container_database_dataguard_association_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`autonomous_container_database_dataguard_association_id`	(required) The Autonomous Container Database-Autonomous Data Guard association OCID.
`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://database.{region}.{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.

FAILOVER_DATA_GUARD_ASSOCIATION Function

Performs a failover to transition the standby database identified by the `databaseId` parameter into the specified Data Guard association's primary role after the existing primary database fails or becomes unreachable. A failover might result in data loss depending on the protection mode in effect at the time of the primary database failure.

Syntax

FUNCTION failover_data_guard_association (
  database_id varchar2,
  data_guard_association_id varchar2,
  failover_data_guard_association_details dbms_cloud_oci_database_failover_data_guard_association_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_failover_data_guard_association_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`data_guard_association_id`	(required) The Data Guard association's OCID.
`failover_data_guard_association_details`	(required) A request to perform a failover, transitioning a standby database into a primary database.
`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://database.{region}.{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_AUTONOMOUS_DATABASE_WALLET Function

Creates and downloads a wallet for the specified Autonomous Database.

Syntax

FUNCTION generate_autonomous_database_wallet (
  autonomous_database_id varchar2,
  generate_autonomous_database_wallet_details dbms_cloud_oci_database_generate_autonomous_database_wallet_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_db_database_generate_autonomous_database_wallet_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`generate_autonomous_database_wallet_details`	(required) Request to create a new Autonomous Database wallet.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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_RECOMMENDED_VM_CLUSTER_NETWORK Function

Generates a recommended Cloud@Customer VM cluster network configuration.

Syntax

FUNCTION generate_recommended_vm_cluster_network (
  exadata_infrastructure_id varchar2,
  generate_recommended_network_details dbms_cloud_oci_database_generate_recommended_network_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_db_database_generate_recommended_vm_cluster_network_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`generate_recommended_network_details`	(required) Request to generate a recommended Cloud@Customer VM cluster network configuration.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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_APPLICATION_VIP Function

Gets information about a specified application virtual IP (VIP) address.

Syntax

FUNCTION get_application_vip (
  application_vip_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_db_database_get_application_vip_response_t;

Parameters

Parameter	Description
`application_vip_id`	(required) The OCID of the application virtual IP (VIP) address.
`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://database.{region}.{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_AUTONOMOUS_CONTAINER_DATABASE Function

Gets information about the specified Autonomous Container Database.

Syntax

FUNCTION get_autonomous_container_database (
  autonomous_container_database_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_autonomous_container_database_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`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://database.{region}.{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_AUTONOMOUS_CONTAINER_DATABASE_DATAGUARD_ASSOCIATION Function

Gets an Autonomous Container Database enabled with Autonomous Data Guard associated with the specified Autonomous Container Database.

Syntax

FUNCTION get_autonomous_container_database_dataguard_association (
  autonomous_container_database_id varchar2,
  autonomous_container_database_dataguard_association_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_autonomous_container_database_dataguard_association_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`autonomous_container_database_dataguard_association_id`	(required) The Autonomous Container Database-Autonomous Data Guard association OCID.
`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://database.{region}.{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_AUTONOMOUS_CONTAINER_DATABASE_RESOURCE_USAGE Function

Get resource usage details for the specified Autonomous Container Database.

Syntax

FUNCTION get_autonomous_container_database_resource_usage (
  autonomous_container_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_db_database_get_autonomous_container_database_resource_usage_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`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://database.{region}.{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_AUTONOMOUS_DATABASE Function

Gets the details of the specified Autonomous Database.

Syntax

FUNCTION get_autonomous_database (
  autonomous_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_db_database_get_autonomous_database_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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://database.{region}.{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_AUTONOMOUS_DATABASE_BACKUP Function

Gets information about the specified Autonomous Database backup.

Syntax

FUNCTION get_autonomous_database_backup (
  autonomous_database_backup_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_db_database_get_autonomous_database_backup_response_t;

Parameters

Parameter	Description
`autonomous_database_backup_id`	(required) The OCID of the Autonomous Database backup.
`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://database.{region}.{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_AUTONOMOUS_DATABASE_DATAGUARD_ASSOCIATION Function

Gets an Autonomous Data Guard-enabled database associated with the specified Autonomous Database.

Syntax

FUNCTION get_autonomous_database_dataguard_association (
  autonomous_database_id varchar2,
  autonomous_database_dataguard_association_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_db_database_get_autonomous_database_dataguard_association_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`autonomous_database_dataguard_association_id`	(required) The Autonomous Container Database-Autonomous Data Guard association OCID.
`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://database.{region}.{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_AUTONOMOUS_DATABASE_REGIONAL_WALLET Function

Gets the Autonomous Database regional wallet details.

Syntax

FUNCTION get_autonomous_database_regional_wallet (
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_autonomous_database_regional_wallet_response_t;

Parameters

Parameter	Description
`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://database.{region}.{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_AUTONOMOUS_DATABASE_WALLET Function

Gets the wallet details for the specified Autonomous Database.

Syntax

FUNCTION get_autonomous_database_wallet (
  autonomous_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_db_database_get_autonomous_database_wallet_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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://database.{region}.{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_AUTONOMOUS_EXADATA_INFRASTRUCTURE Function

**Deprecated.** Use the GET_CLOUD_EXADATA_INFRASTRUCTURE Function operation to get details of an Exadata Infrastructure resource and the GET_CLOUD_AUTONOMOUS_VM_CLUSTER Function operation to get details of an Autonomous Exadata VM cluster.

Syntax

FUNCTION get_autonomous_exadata_infrastructure (
  autonomous_exadata_infrastructure_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_autonomous_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`autonomous_exadata_infrastructure_id`	(required) The Autonomous Exadata Infrastructure OCID.
`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://database.{region}.{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_AUTONOMOUS_PATCH Function

Gets information about a specific autonomous patch.

Syntax

FUNCTION get_autonomous_patch (
  autonomous_patch_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_autonomous_patch_response_t;

Parameters

Parameter	Description
`autonomous_patch_id`	(required) The autonomous patch OCID.
`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://database.{region}.{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_AUTONOMOUS_VIRTUAL_MACHINE Function

Gets the details of specific Autonomous Virtual Machine.

Syntax

FUNCTION get_autonomous_virtual_machine (
  autonomous_virtual_machine_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_db_database_get_autonomous_virtual_machine_response_t;

Parameters

Parameter	Description
`autonomous_virtual_machine_id`	(required) The Autonomous Virtual machine OCID.
`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://database.{region}.{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_AUTONOMOUS_VM_CLUSTER Function

Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system. To get information about an Autonomous VM Cluster in the Oracle cloud, see GET_CLOUD_AUTONOMOUS_VM_CLUSTER Function.

Syntax

FUNCTION get_autonomous_vm_cluster (
  autonomous_vm_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_db_database_get_autonomous_vm_cluster_response_t;

Parameters

Parameter	Description
`autonomous_vm_cluster_id`	(required) The autonomous VM cluster OCID.
`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://database.{region}.{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_AUTONOMOUS_VM_CLUSTER_RESOURCE_USAGE Function

Get the resource usage details for the specified Autonomous Exadata VM cluster.

Syntax

FUNCTION get_autonomous_vm_cluster_resource_usage (
  autonomous_vm_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_db_database_get_autonomous_vm_cluster_resource_usage_response_t;

Parameters

Parameter	Description
`autonomous_vm_cluster_id`	(required) The autonomous VM cluster OCID.
`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://database.{region}.{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_BACKUP Function

Gets information about the specified backup.

Syntax

FUNCTION get_backup (
  backup_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_backup_response_t;

Parameters

Parameter	Description
`backup_id`	(required) The backup OCID.
`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://database.{region}.{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_BACKUP_DESTINATION Function

Gets information about the specified backup destination in an Exadata Cloud@Customer system.

Syntax

FUNCTION get_backup_destination (
  backup_destination_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_db_database_get_backup_destination_response_t;

Parameters

Parameter	Description
`backup_destination_id`	(required) The OCID of the backup destination.
`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://database.{region}.{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_CLOUD_AUTONOMOUS_VM_CLUSTER Function

Gets information about the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Custustomer systems, see GET_AUTONOMOUS_VM_CLUSTER Function.

Syntax

FUNCTION get_cloud_autonomous_vm_cluster (
  cloud_autonomous_vm_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_db_database_get_cloud_autonomous_vm_cluster_response_t;

Parameters

Parameter	Description
`cloud_autonomous_vm_cluster_id`	(required) The Cloud VM cluster OCID.
`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://database.{region}.{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_CLOUD_AUTONOMOUS_VM_CLUSTER_RESOURCE_USAGE Function

Get the resource usage details for the specified Cloud Autonomous Exadata VM cluster.

Syntax

FUNCTION get_cloud_autonomous_vm_cluster_resource_usage (
  cloud_autonomous_vm_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_db_database_get_cloud_autonomous_vm_cluster_resource_usage_response_t;

Parameters

Parameter	Description
`cloud_autonomous_vm_cluster_id`	(required) The Cloud VM cluster OCID.
`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://database.{region}.{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_CLOUD_EXADATA_INFRASTRUCTURE Function

Gets information about the specified cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Syntax

FUNCTION get_cloud_exadata_infrastructure (
  cloud_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_db_database_get_cloud_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`cloud_exadata_infrastructure_id`	(required) The cloud Exadata infrastructure OCID.
`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://database.{region}.{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_CLOUD_EXADATA_INFRASTRUCTURE_UNALLOCATED_RESOURCES Function

Gets unallocated resources information for the specified Cloud Exadata infrastructure.

Syntax

FUNCTION get_cloud_exadata_infrastructure_unallocated_resources (
  cloud_exadata_infrastructure_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  db_servers dbms_cloud_oci_database_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_cloud_exadata_infrastructure_unallocated_resources_response_t;

Parameters

Parameter	Description
`cloud_exadata_infrastructure_id`	(required) The cloud Exadata infrastructure OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`db_servers`	(optional) The list of OCIDs of the Db servers.
`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://database.{region}.{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_CLOUD_VM_CLUSTER Function

Gets information about the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Syntax

FUNCTION get_cloud_vm_cluster (
  cloud_vm_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_db_database_get_cloud_vm_cluster_response_t;

Parameters

Parameter	Description
`cloud_vm_cluster_id`	(required) The cloud VM cluster OCID.
`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://database.{region}.{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_CLOUD_VM_CLUSTER_IORM_CONFIG Function

Gets the IORM configuration for the specified cloud VM cluster in an Exadata Cloud Service instance. If you have not specified an IORM configuration, the default configuration is returned.

Syntax

FUNCTION get_cloud_vm_cluster_iorm_config (
  cloud_vm_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_db_database_get_cloud_vm_cluster_iorm_config_response_t;

Parameters

Parameter	Description
`cloud_vm_cluster_id`	(required) The cloud VM cluster OCID.
`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://database.{region}.{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_CLOUD_VM_CLUSTER_UPDATE Function

Gets information about a specified maintenance update package for a cloud VM cluster. Applies to Exadata Cloud Service instances only.

Syntax

FUNCTION get_cloud_vm_cluster_update (
  cloud_vm_cluster_id varchar2,
  update_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_db_database_get_cloud_vm_cluster_update_response_t;

Parameters

Parameter	Description
`cloud_vm_cluster_id`	(required) The cloud VM cluster OCID.
`update_id`	(required) The OCID of the maintenance update.
`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://database.{region}.{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_CLOUD_VM_CLUSTER_UPDATE_HISTORY_ENTRY Function

Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud Service instances only.

Syntax

FUNCTION get_cloud_vm_cluster_update_history_entry (
  cloud_vm_cluster_id varchar2,
  update_history_entry_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_db_database_get_cloud_vm_cluster_update_history_entry_response_t;

Parameters

Parameter	Description
`cloud_vm_cluster_id`	(required) The cloud VM cluster OCID.
`update_history_entry_id`	(required) The OCID of the maintenance update history entry.
`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://database.{region}.{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_CONSOLE_CONNECTION Function

Gets the specified database node console connection's information.

Syntax

FUNCTION get_console_connection (
  db_node_id varchar2,
  console_connection_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_console_connection_response_t;

Parameters

Parameter	Description
`db_node_id`	(required) The database node OCID.
`console_connection_id`	(required) The OCID of the console connection.
`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://database.{region}.{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_CONSOLE_HISTORY Function

Gets information about the specified database node console history.

Syntax

FUNCTION get_console_history (
  db_node_id varchar2,
  console_history_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_db_database_get_console_history_response_t;

Parameters

Parameter	Description
`db_node_id`	(required) The database node OCID.
`console_history_id`	(required) The OCID of the console history.
`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://database.{region}.{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_CONSOLE_HISTORY_CONTENT Function

Retrieves the specified database node console history contents upto a megabyte.

Syntax

FUNCTION get_console_history_content (
  db_node_id varchar2,
  console_history_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_db_database_get_console_history_content_response_t;

Parameters

Parameter	Description
`db_node_id`	(required) The database node OCID.
`console_history_id`	(required) The OCID of the console history.
`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://database.{region}.{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_DATA_GUARD_ASSOCIATION Function

Gets the specified Data Guard association's configuration information.

Syntax

FUNCTION get_data_guard_association (
  database_id varchar2,
  data_guard_association_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_data_guard_association_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`data_guard_association_id`	(required) The Data Guard association's OCID.
`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://database.{region}.{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 Function

Gets information about the specified database.

Syntax

FUNCTION get_database (
  database_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_database_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`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://database.{region}.{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_SOFTWARE_IMAGE Function

Gets information about the specified database software image.

Syntax

FUNCTION get_database_software_image (
  database_software_image_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_database_software_image_response_t;

Parameters

Parameter	Description
`database_software_image_id`	(required) The DB system OCID.
`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://database.{region}.{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_UPGRADE_HISTORY_ENTRY Function

gets the upgrade history for a specified database.

Syntax

FUNCTION get_database_upgrade_history_entry (
  database_id varchar2,
  upgrade_history_entry_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_db_database_get_database_upgrade_history_entry_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`upgrade_history_entry_id`	(required) The database/db system upgrade History OCID.
`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://database.{region}.{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_HOME Function

Gets information about the specified Database Home.

Syntax

FUNCTION get_db_home (
  db_home_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_db_home_response_t;

Parameters

Parameter	Description
`db_home_id`	(required) The Database Home OCID.
`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://database.{region}.{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_HOME_PATCH Function

Gets information about a specified patch package.

Syntax

FUNCTION get_db_home_patch (
  db_home_id varchar2,
  patch_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_db_home_patch_response_t;

Parameters

Parameter	Description
`db_home_id`	(required) The Database Home OCID.
`patch_id`	(required) The OCID of the patch.
`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://database.{region}.{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_HOME_PATCH_HISTORY_ENTRY Function

Gets the patch history details for the specified patchHistoryEntryId

Syntax

FUNCTION get_db_home_patch_history_entry (
  db_home_id varchar2,
  patch_history_entry_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_db_home_patch_history_entry_response_t;

Parameters

Parameter	Description
`db_home_id`	(required) The Database Home OCID.
`patch_history_entry_id`	(required) The OCID of the patch history entry.
`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://database.{region}.{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_NODE Function

Gets information about the specified database node.

Syntax

FUNCTION get_db_node (
  db_node_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_db_node_response_t;

Parameters

Parameter	Description
`db_node_id`	(required) The database node OCID.
`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://database.{region}.{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_SERVER Function

Gets information about the Exadata Db server.

Syntax

FUNCTION get_db_server (
  exadata_infrastructure_id varchar2,
  db_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_db_database_get_db_server_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The OCID of the ExadataInfrastructure.
`db_server_id`	(required) The DB server OCID.
`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://database.{region}.{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_SYSTEM Function

Gets information about the specified DB system. **Note:** Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.

Syntax

FUNCTION get_db_system (
  db_system_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_db_system_response_t;

Parameters

Parameter	Description
`db_system_id`	(required) The DB system OCID.
`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://database.{region}.{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_SYSTEM_PATCH Function

Gets information the specified patch.

Syntax

FUNCTION get_db_system_patch (
  db_system_id varchar2,
  patch_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_db_system_patch_response_t;

Parameters

Parameter	Description
`db_system_id`	(required) The DB system OCID.
`patch_id`	(required) The OCID of the patch.
`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://database.{region}.{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_SYSTEM_PATCH_HISTORY_ENTRY Function

Gets the details of the specified patch operation on the specified DB system.

Syntax

FUNCTION get_db_system_patch_history_entry (
  db_system_id varchar2,
  patch_history_entry_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_db_system_patch_history_entry_response_t;

Parameters

Parameter	Description
`db_system_id`	(required) The DB system OCID.
`patch_history_entry_id`	(required) The OCID of the patch history entry.
`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://database.{region}.{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_SYSTEM_UPGRADE_HISTORY_ENTRY Function

Gets the details of the specified operating system upgrade operation for the specified DB system.

Syntax

FUNCTION get_db_system_upgrade_history_entry (
  db_system_id varchar2,
  upgrade_history_entry_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_db_database_get_db_system_upgrade_history_entry_response_t;

Parameters

Parameter	Description
`db_system_id`	(required) The DB system OCID.
`upgrade_history_entry_id`	(required) The database/db system upgrade History OCID.
`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://database.{region}.{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_EXADATA_INFRASTRUCTURE Function

Gets information about the specified Exadata infrastructure. Applies to Exadata Cloud@Customer instances only. To get information on an Exadata Cloud Service infrastructure resource, use the GET_CLOUD_EXADATA_INFRASTRUCTURE Function operation.

Syntax

FUNCTION get_exadata_infrastructure (
  exadata_infrastructure_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  excluded_fields dbms_cloud_oci_database_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`excluded_fields`	(optional) If provided, the specified fields will be excluded in the response. Allowed values are: 'multiRackConfigurationFile'
`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://database.{region}.{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_EXADATA_INFRASTRUCTURE_OCPUS Function

Gets details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure resource.

Syntax

FUNCTION get_exadata_infrastructure_ocpus (
  autonomous_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_db_database_get_exadata_infrastructure_ocpus_response_t;

Parameters

Parameter	Description
`autonomous_exadata_infrastructure_id`	(required) The Autonomous Exadata Infrastructure OCID.
`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://database.{region}.{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_EXADATA_INFRASTRUCTURE_UN_ALLOCATED_RESOURCES Function

Gets un allocated resources information for the specified Exadata infrastructure. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION get_exadata_infrastructure_un_allocated_resources (
  exadata_infrastructure_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  db_servers dbms_cloud_oci_database_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_exadata_infrastructure_un_allocated_resources_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`db_servers`	(optional) The list of OCIDs of the Db servers.
`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://database.{region}.{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_EXADATA_IORM_CONFIG Function

Gets the IORM configuration settings for the specified cloud Exadata DB system. All Exadata service instances have default IORM settings. **Note:** Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model. The GET_CLOUD_VM_CLUSTER_IORM_CONFIG Function API is used for this operation with Exadata systems using the new resource model.

Syntax

FUNCTION get_exadata_iorm_config (
  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_db_database_get_exadata_iorm_config_response_t;

Parameters

Parameter	Description
`db_system_id`	(required) The DB system OCID.
`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://database.{region}.{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_BACKUP_JOB Function

Gets information about the specified external backup job. **Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud for more information.

Syntax

FUNCTION get_external_backup_job (
  backup_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_external_backup_job_response_t;

Parameters

Parameter	Description
`backup_id`	(required) The backup OCID.
`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://database.{region}.{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_CONTAINER_DATABASE Function

Gets information about the specified external container database.

Syntax

FUNCTION get_external_container_database (
  external_container_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_db_database_get_external_container_database_response_t;

Parameters

Parameter	Description
`external_container_database_id`	(required) The ExternalContainerDatabase OCID.
`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://database.{region}.{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_DATABASE_CONNECTOR Function

Gets information about the specified external database connector.

Syntax

FUNCTION get_external_database_connector (
  external_database_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_db_database_get_external_database_connector_response_t;

Parameters

Parameter	Description
`external_database_connector_id`	(required) The OCID of the external database connector resource (`ExternalDatabaseConnectorId`).
`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://database.{region}.{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_NON_CONTAINER_DATABASE Function

Gets information about a specific external non-container database.

Syntax

FUNCTION get_external_non_container_database (
  external_non_container_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_db_database_get_external_non_container_database_response_t;

Parameters

Parameter	Description
`external_non_container_database_id`	(required) The external non-container database OCID.
`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://database.{region}.{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_PLUGGABLE_DATABASE Function

Gets information about a specific CREATE_EXTERNAL_PLUGGABLE_DATABASE_DETAILS Function resource.

Syntax

FUNCTION get_external_pluggable_database (
  external_pluggable_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_db_database_get_external_pluggable_database_response_t;

Parameters

Parameter	Description
`external_pluggable_database_id`	(required) The ExternalPluggableDatabaseId OCID.
`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://database.{region}.{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_INFRASTRUCTURE_TARGET_VERSIONS Function

Gets details of the Exadata Infrastructure target system software versions that can be applied to the specified infrastructure resource for maintenance updates. Applies to Exadata Cloud@Customer and Exadata Cloud instances only.

Syntax

FUNCTION get_infrastructure_target_versions (
  compartment_id varchar2,
  target_resource_id varchar2 DEFAULT NULL,
  target_resource_type 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_db_database_get_infrastructure_target_versions_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`target_resource_id`	(optional) The target resource ID.
`target_resource_type`	(optional) The type of the target resource.
`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://database.{region}.{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_KEY_STORE Function

Gets information about the specified key store.

Syntax

FUNCTION get_key_store (
  key_store_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_db_database_get_key_store_response_t;

Parameters

Parameter	Description
`key_store_id`	(required) The OCID of the key store.
`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://database.{region}.{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_MAINTENANCE_RUN Function

Gets information about the specified maintenance run.

Syntax

FUNCTION get_maintenance_run (
  maintenance_run_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_maintenance_run_response_t;

Parameters

Parameter	Description
`maintenance_run_id`	(required) The maintenance run OCID.
`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://database.{region}.{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_MAINTENANCE_RUN_HISTORY Function

Gets information about the specified maintenance run history.

Syntax

FUNCTION get_maintenance_run_history (
  maintenance_run_history_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_maintenance_run_history_response_t;

Parameters

Parameter	Description
`maintenance_run_history_id`	(required) The maintenance run history OCID.
`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://database.{region}.{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_ONEOFF_PATCH Function

Gets information about the specified one-off patch.

Syntax

FUNCTION get_oneoff_patch (
  oneoff_patch_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_db_database_get_oneoff_patch_response_t;

Parameters

Parameter	Description
`oneoff_patch_id`	(required) The one-off patch OCID.
`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://database.{region}.{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_CONVERSION_HISTORY_ENTRY Function

Gets the details of operations performed to convert the specified database from non-container (non-CDB) to pluggable (PDB).

Syntax

FUNCTION get_pdb_conversion_history_entry (
  database_id varchar2,
  pdb_conversion_history_entry_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_db_database_get_pdb_conversion_history_entry_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`pdb_conversion_history_entry_id`	(required) The database conversion history OCID.
`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://database.{region}.{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_PLUGGABLE_DATABASE Function

Gets information about the specified pluggable database.

Syntax

FUNCTION get_pluggable_database (
  pluggable_database_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_pluggable_database_response_t;

Parameters

Parameter	Description
`pluggable_database_id`	(required) The database OCID.
`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://database.{region}.{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_VM_CLUSTER Function

Gets information about the VM cluster. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION get_vm_cluster (
  vm_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_db_database_get_vm_cluster_response_t;

Parameters

Parameter	Description
`vm_cluster_id`	(required) The VM cluster OCID.
`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://database.{region}.{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_VM_CLUSTER_NETWORK Function

Gets information about the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To get information about a cloud VM cluster in an Exadata Cloud Service instance, use the GET_CLOUD_VM_CLUSTER Function operation.

Syntax

FUNCTION get_vm_cluster_network (
  exadata_infrastructure_id varchar2,
  vm_cluster_network_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_db_database_get_vm_cluster_network_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`vm_cluster_network_id`	(required) The VM cluster network OCID.
`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://database.{region}.{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_VM_CLUSTER_PATCH Function

Gets information about a specified patch package.

Syntax

FUNCTION get_vm_cluster_patch (
  vm_cluster_id varchar2,
  patch_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_vm_cluster_patch_response_t;

Parameters

Parameter	Description
`vm_cluster_id`	(required) The VM cluster OCID.
`patch_id`	(required) The OCID of the patch.
`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://database.{region}.{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_VM_CLUSTER_PATCH_HISTORY_ENTRY Function

Gets the patch history details for the specified patch history entry.

Syntax

FUNCTION get_vm_cluster_patch_history_entry (
  vm_cluster_id varchar2,
  patch_history_entry_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_get_vm_cluster_patch_history_entry_response_t;

Parameters

Parameter	Description
`vm_cluster_id`	(required) The VM cluster OCID.
`patch_history_entry_id`	(required) The OCID of the patch history entry.
`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://database.{region}.{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_VM_CLUSTER_UPDATE Function

Gets information about a specified maintenance update package for a VM cluster. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION get_vm_cluster_update (
  vm_cluster_id varchar2,
  update_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_db_database_get_vm_cluster_update_response_t;

Parameters

Parameter	Description
`vm_cluster_id`	(required) The VM cluster OCID.
`update_id`	(required) The OCID of the maintenance update.
`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://database.{region}.{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_VM_CLUSTER_UPDATE_HISTORY_ENTRY Function

Gets the maintenance update history details for the specified update history entry. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION get_vm_cluster_update_history_entry (
  vm_cluster_id varchar2,
  update_history_entry_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_db_database_get_vm_cluster_update_history_entry_response_t;

Parameters

Parameter	Description
`vm_cluster_id`	(required) The VM cluster OCID.
`update_history_entry_id`	(required) The OCID of the maintenance update history entry.
`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://database.{region}.{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.

LAUNCH_AUTONOMOUS_EXADATA_INFRASTRUCTURE Function

**Deprecated** To create a new Autonomous Database system on dedicated Exadata Infrastructure, use the CREATE_CLOUD_EXADATA_INFRASTRUCTURE Function and CREATE_CLOUD_AUTONOMOUS_VM_CLUSTER Function operations instead. Note that to create an Autonomous VM cluster, you must have an existing Exadata Infrastructure resource to contain the VM cluster.

Syntax

FUNCTION launch_autonomous_exadata_infrastructure (
  launch_autonomous_exadata_infrastructure_details dbms_cloud_oci_database_launch_autonomous_exadata_infrastructure_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_launch_autonomous_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`launch_autonomous_exadata_infrastructure_details`	(required) Deprecated. Use the `CREATE_CLOUD_EXADATA_INFRASTRUCTURE` Function or `CREATE_CLOUD_AUTONOMOUS_VM_CLUSTER` Function operations instead.
`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 may 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://database.{region}.{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.

LAUNCH_DB_SYSTEM Function

Creates a new DB system in the specified compartment and availability domain. The Oracle Database edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed. An initial database is created on the DB system based on the request parameters you provide and some default options. For detailed information about default options, see Bare metal and virtual machine DB system default options. **Note:** Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model. Use the CREATE_CLOUD_EXADATA_INFRASTRUCTURE Function and CREATE_CLOUD_VM_CLUSTER Function APIs to provision a new Exadata Cloud Service instance.

Syntax

FUNCTION launch_db_system (
  launch_db_system_details dbms_cloud_oci_database_launch_db_system_base_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_launch_db_system_response_t;

Parameters

Parameter	Description
`launch_db_system_details`	(required) Request to launch a DB system. Note: Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.
`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 may 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://database.{region}.{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_APPLICATION_VIPS Function

Gets a list of application virtual IP (VIP) addresses on a cloud VM cluster.

Syntax

FUNCTION list_application_vips (
  compartment_id varchar2,
  cloud_vm_cluster_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_application_vips_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`cloud_vm_cluster_id`	(required) The OCID of the cloud VM cluster associated with the application virtual IP (VIP) address.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`opc_request_id`	(optional) Unique identifier for the request.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'DISPLAYNAME', 'TIMECREATED'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`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://database.{region}.{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_AUTONOMOUS_CONTAINER_DATABASE_DATAGUARD_ASSOCIATIONS Function

Gets a list of the Autonomous Container Databases with Autonomous Data Guard-enabled associated with the specified Autonomous Container Database.

Syntax

FUNCTION list_autonomous_container_database_dataguard_associations (
  autonomous_container_database_id varchar2,
  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_db_database_list_autonomous_container_database_dataguard_associations_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_AUTONOMOUS_CONTAINER_DATABASE_VERSIONS Function

Gets a list of supported Autonomous Container Database versions.

Syntax

FUNCTION list_autonomous_container_database_versions (
  compartment_id varchar2,
  service_component varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id 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_db_database_list_autonomous_container_database_versions_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`service_component`	(required) The service component to use, either ADBD or EXACC. Allowed values are: 'ADBD', 'EXACC'
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`opc_request_id`	(optional) Unique identifier for the request.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). 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://database.{region}.{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_AUTONOMOUS_CONTAINER_DATABASES Function

Gets a list of the Autonomous Container Databases in the specified compartment.

Syntax

FUNCTION list_autonomous_container_databases (
  compartment_id varchar2,
  autonomous_exadata_infrastructure_id varchar2 DEFAULT NULL,
  autonomous_vm_cluster_id varchar2 DEFAULT NULL,
  infrastructure_type varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  availability_domain varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  service_level_agreement_type varchar2 DEFAULT NULL,
  cloud_autonomous_vm_cluster_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_autonomous_container_databases_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`autonomous_exadata_infrastructure_id`	(optional) The Autonomous Exadata Infrastructure OCID.
`autonomous_vm_cluster_id`	(optional) The Autonomous VM Cluster OCID.
`infrastructure_type`	(optional) A filter to return only resources that match the given Infrastructure Type.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`availability_domain`	(optional) A filter to return only resources that match the given availability domain exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`service_level_agreement_type`	(optional) A filter to return only resources that match the given service-level agreement type exactly.
`cloud_autonomous_vm_cluster_id`	(optional) The cloud Autonomous VM Cluster OCID.
`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://database.{region}.{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_AUTONOMOUS_DATABASE_BACKUPS Function

Gets a list of Autonomous Database backups based on either the `autonomousDatabaseId` or `compartmentId` specified as a query parameter.

Syntax

FUNCTION list_autonomous_database_backups (
  autonomous_database_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  l_type 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_db_database_list_autonomous_database_backups_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(optional) The database OCID.
`compartment_id`	(optional) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`l_type`	(optional) A filter to return only backups that matches with the given type of Backup.
`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://database.{region}.{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_AUTONOMOUS_DATABASE_CHARACTER_SETS Function

Gets a list of supported character sets.

Syntax

FUNCTION list_autonomous_database_character_sets (
  opc_request_id varchar2 DEFAULT NULL,
  is_shared number DEFAULT NULL,
  is_dedicated number DEFAULT NULL,
  character_set_type varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_autonomous_database_character_sets_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) Unique identifier for the request.
`is_shared`	(optional) Specifies whether this request is for an Autonomous Database Serverless instance. By default, this request will be for Autonomous Database on Dedicated Exadata Infrastructure.
`is_dedicated`	(optional) Specifies if the request is for an Autonomous Database Dedicated instance. The default request is for an Autonomous Database Dedicated instance.
`character_set_type`	(optional) Specifies whether this request pertains to database character sets or national character sets. Allowed values are: 'DATABASE', 'NATIONAL'
`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://database.{region}.{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_AUTONOMOUS_DATABASE_CLONES Function

Lists the Autonomous Database clones for the specified Autonomous Database.

Syntax

FUNCTION list_autonomous_database_clones (
  compartment_id varchar2,
  autonomous_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  clone_type varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_autonomous_database_clones_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`autonomous_database_id`	(required) The database OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. Allowed values are: 'NONE', 'TIMECREATED', 'DISPLAYNAME'
`clone_type`	(optional) A filter to return only resources that match the given clone type exactly. Allowed values are: 'REFRESHABLE_CLONE'
`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://database.{region}.{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_AUTONOMOUS_DATABASE_DATAGUARD_ASSOCIATIONS Function

Gets a list of the Autonomous Data Guard-enabled databases associated with the specified Autonomous Database.

Syntax

FUNCTION list_autonomous_database_dataguard_associations (
  autonomous_database_id varchar2,
  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_db_database_list_autonomous_database_dataguard_associations_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_AUTONOMOUS_DATABASE_REFRESHABLE_CLONES Function

Lists the OCIDs of the Autonomous Database local and connected remote refreshable clones with the region where they exist for the specified source database.

Syntax

FUNCTION list_autonomous_database_refreshable_clones (
  autonomous_database_id varchar2,
  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_db_database_list_autonomous_database_refreshable_clones_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_AUTONOMOUS_DATABASES Function

Gets a list of Autonomous Databases based on the query parameters specified.

Syntax

FUNCTION list_autonomous_databases (
  compartment_id varchar2,
  autonomous_container_database_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  infrastructure_type varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  db_workload varchar2 DEFAULT NULL,
  db_version varchar2 DEFAULT NULL,
  is_free_tier number DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  is_refreshable_clone number DEFAULT NULL,
  is_data_guard_enabled number DEFAULT NULL,
  is_resource_pool_leader number DEFAULT NULL,
  resource_pool_leader_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_autonomous_databases_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`autonomous_container_database_id`	(optional) The Autonomous Container Database OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`infrastructure_type`	(optional) A filter to return only resources that match the given Infrastructure Type.
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`db_workload`	(optional) A filter to return only autonomous database resources that match the specified workload type.
`db_version`	(optional) A filter to return only autonomous database resources that match the specified dbVersion.
`is_free_tier`	(optional) Filter on the value of the resource's 'isFreeTier' property. A value of `true` returns only Always Free resources. A value of `false` excludes Always Free resources from the returned results. Omitting this parameter returns both Always Free and paid resources.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`opc_request_id`	(optional) Unique identifier for the request.
`is_refreshable_clone`	(optional) Filter on the value of the resource's 'isRefreshableClone' property. A value of `true` returns only refreshable clones. A value of `false` excludes refreshable clones from the returned results. Omitting this parameter returns both refreshable clones and databases that are not refreshable clones.
`is_data_guard_enabled`	(optional) A filter to return only resources that have Data Guard enabled.
`is_resource_pool_leader`	(optional) Filter if the resource is the resource pool leader. A value of `true` returns only resource pool leader.
`resource_pool_leader_id`	(optional) The database OCID of the resourcepool Leader Autonomous Database.
`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://database.{region}.{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_AUTONOMOUS_DB_PREVIEW_VERSIONS Function

Gets a list of supported Autonomous Database versions. Note that preview version software is only available for Autonomous Database Serverless (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) databases.

Syntax

FUNCTION list_autonomous_db_preview_versions (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id 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_db_database_list_autonomous_db_preview_versions_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`opc_request_id`	(optional) Unique identifier for the request.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for DBWORKLOAD is ascending. Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. Allowed values are: 'DBWORKLOAD'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). 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://database.{region}.{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_AUTONOMOUS_DB_VERSIONS Function

Gets a list of supported Autonomous Database versions.

Syntax

FUNCTION list_autonomous_db_versions (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  db_workload 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_db_database_list_autonomous_db_versions_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`opc_request_id`	(optional) Unique identifier for the request.
`db_workload`	(optional) A filter to return only autonomous database resources that match the specified workload type.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). 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://database.{region}.{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_AUTONOMOUS_EXADATA_INFRASTRUCTURE_SHAPES Function

**Deprecated.**

Syntax

FUNCTION list_autonomous_exadata_infrastructure_shapes (
  availability_domain varchar2,
  compartment_id varchar2,
  limit number DEFAULT NULL,
  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_db_database_list_autonomous_exadata_infrastructure_shapes_response_t;

Parameters

Parameter	Description
`availability_domain`	(required) The name of the Availability Domain.
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_AUTONOMOUS_EXADATA_INFRASTRUCTURES Function

**Deprecated.** Use the LIST_CLOUD_EXADATA_INFRASTRUCTURES Function operation to list Exadata Infrastructures in the Oracle cloud and the LIST_CLOUD_AUTONOMOUS_VM_CLUSTERS Function operation to list Autonomous Exadata VM clusters.

Syntax

FUNCTION list_autonomous_exadata_infrastructures (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  availability_domain varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_autonomous_exadata_infrastructures_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`availability_domain`	(optional) A filter to return only resources that match the given availability domain exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_AUTONOMOUS_VIRTUAL_MACHINES Function

Lists the Autonomous Virtual Machines in the specified Autonomous VM Cluster and Compartment.

Syntax

FUNCTION list_autonomous_virtual_machines (
  compartment_id varchar2,
  autonomous_vm_cluster_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_autonomous_virtual_machines_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`autonomous_vm_cluster_id`	(required) The Autonomous Virtual machine OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`opc_request_id`	(optional) Unique identifier for the request.
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`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://database.{region}.{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_AUTONOMOUS_VM_CLUSTER_ACD_RESOURCE_USAGE Function

Gets the list of resource usage details for all the Autonomous Container Database in the specified Autonomous Exadata VM cluster.

Syntax

FUNCTION list_autonomous_vm_cluster_acd_resource_usage (
  autonomous_vm_cluster_id varchar2,
  compartment_id 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_db_database_list_autonomous_vm_cluster_acd_resource_usage_response_t;

Parameters

Parameter	Description
`autonomous_vm_cluster_id`	(required) The autonomous VM cluster OCID.
`compartment_id`	(optional) The compartment OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_AUTONOMOUS_VM_CLUSTERS Function

Gets a list of Exadata Cloud@Customer Autonomous VM clusters in the specified compartment. To list Autonomous VM Clusters in the Oracle Cloud, see LIST_CLOUD_AUTONOMOUS_VM_CLUSTERS Function.

Syntax

FUNCTION list_autonomous_vm_clusters (
  compartment_id varchar2,
  exadata_infrastructure_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name 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_db_database_list_autonomous_vm_clusters_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`exadata_infrastructure_id`	(optional) If provided, filters the results for the given Exadata Infrastructure.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_BACKUP_DESTINATION Function

Gets a list of backup destinations in the specified compartment.

Syntax

FUNCTION list_backup_destination (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  l_type varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_backup_destination_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`opc_request_id`	(optional) Unique identifier for the request.
`l_type`	(optional) A filter to return only resources that match the given type of the Backup Destination.
`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://database.{region}.{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_BACKUPS Function

Gets a list of backups based on the `databaseId` or `compartmentId` specified. Either one of these query parameters must be provided.

Syntax

FUNCTION list_backups (
  database_id varchar2 DEFAULT NULL,
  compartment_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_db_database_list_backups_response_t;

Parameters

Parameter	Description
`database_id`	(optional) The OCID of the database.
`compartment_id`	(optional) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_CLOUD_AUTONOMOUS_VM_CLUSTER_ACD_RESOURCE_USAGE Function

Gets the list of resource usage details for all the Cloud Autonomous Container Database in the specified Cloud Autonomous Exadata VM cluster.

Syntax

FUNCTION list_cloud_autonomous_vm_cluster_acd_resource_usage (
  cloud_autonomous_vm_cluster_id varchar2,
  compartment_id 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_db_database_list_cloud_autonomous_vm_cluster_acd_resource_usage_response_t;

Parameters

Parameter	Description
`cloud_autonomous_vm_cluster_id`	(required) The Cloud VM cluster OCID.
`compartment_id`	(optional) The compartment OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_CLOUD_AUTONOMOUS_VM_CLUSTERS Function

Lists Autonomous Exadata VM clusters in the Oracle cloud. For Exadata Cloud@Customer systems, see LIST_AUTONOMOUS_VM_CLUSTERS Function.

Syntax

FUNCTION list_cloud_autonomous_vm_clusters (
  compartment_id varchar2,
  cloud_exadata_infrastructure_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  availability_domain varchar2 DEFAULT NULL,
  display_name 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_db_database_list_cloud_autonomous_vm_clusters_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`cloud_exadata_infrastructure_id`	(optional) If provided, filters the results for the specified cloud Exadata infrastructure.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`availability_domain`	(optional) A filter to return only resources that match the given availability domain exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_CLOUD_EXADATA_INFRASTRUCTURES Function

Gets a list of the cloud Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Syntax

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

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`opc_request_id`	(optional) Unique identifier for the request.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_CLOUD_VM_CLUSTER_UPDATE_HISTORY_ENTRIES Function

Gets the history of the maintenance update actions performed on the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.

Syntax

FUNCTION list_cloud_vm_cluster_update_history_entries (
  cloud_vm_cluster_id varchar2,
  update_type varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  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_db_database_list_cloud_vm_cluster_update_history_entries_response_t;

Parameters

Parameter	Description
`cloud_vm_cluster_id`	(required) The cloud VM cluster OCID.
`update_type`	(optional) A filter to return only resources that match the given update type exactly. Allowed values are: 'GI_UPGRADE', 'GI_PATCH', 'OS_UPDATE'
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_CLOUD_VM_CLUSTER_UPDATES Function

Lists the maintenance updates that can be applied to the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.

Syntax

FUNCTION list_cloud_vm_cluster_updates (
  cloud_vm_cluster_id varchar2,
  update_type varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  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_db_database_list_cloud_vm_cluster_updates_response_t;

Parameters

Parameter	Description
`cloud_vm_cluster_id`	(required) The cloud VM cluster OCID.
`update_type`	(optional) A filter to return only resources that match the given update type exactly. Allowed values are: 'GI_UPGRADE', 'GI_PATCH', 'OS_UPDATE'
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_CLOUD_VM_CLUSTERS Function

Gets a list of the cloud VM clusters in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Syntax

FUNCTION list_cloud_vm_clusters (
  compartment_id varchar2,
  cloud_exadata_infrastructure_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name 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_db_database_list_cloud_vm_clusters_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`cloud_exadata_infrastructure_id`	(optional) If provided, filters the results for the specified cloud Exadata infrastructure.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only cloud VM clusters that match the given lifecycle state exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_CONSOLE_CONNECTIONS Function

Lists the console connections for the specified database node.

Syntax

FUNCTION list_console_connections (
  db_node_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_console_connections_response_t;

Parameters

Parameter	Description
`db_node_id`	(required) The database node OCID.
`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://database.{region}.{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_CONSOLE_HISTORIES Function

Lists the console histories for the specified database node.

Syntax

FUNCTION list_console_histories (
  db_node_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_console_histories_response_t;

Parameters

Parameter	Description
`db_node_id`	(required) The database node OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`opc_request_id`	(optional) Unique identifier for the request.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_CONTAINER_DATABASE_PATCHES Function

Lists the patches applicable to the requested container database.

Syntax

FUNCTION list_container_database_patches (
  autonomous_container_database_id varchar2,
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  autonomous_patch_type varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_container_database_patches_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`autonomous_patch_type`	(optional) Autonomous patch type, either \"QUARTERLY\" or \"TIMEZONE\". Allowed values are: 'QUARTERLY', 'TIMEZONE'
`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://database.{region}.{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_GUARD_ASSOCIATIONS Function

Lists all Data Guard associations for the specified database.

Syntax

FUNCTION list_data_guard_associations (
  database_id varchar2,
  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_db_database_list_data_guard_associations_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_SOFTWARE_IMAGES Function

Gets a list of the database software images in the specified compartment.

Syntax

FUNCTION list_database_software_images (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  image_type varchar2 DEFAULT NULL,
  image_shape_family varchar2 DEFAULT NULL,
  is_upgrade_supported number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_database_software_images_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`image_type`	(optional) A filter to return only resources that match the given image type exactly.
`image_shape_family`	(optional) A filter to return only resources that match the given image shape family exactly.
`is_upgrade_supported`	(optional) If provided, filters the results to the set of database versions which are supported for Upgrade.
`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://database.{region}.{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_UPGRADE_HISTORY_ENTRIES Function

Gets the upgrade history for a specified database in a bare metal or virtual machine DB system.

Syntax

FUNCTION list_database_upgrade_history_entries (
  database_id varchar2,
  upgrade_action varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order 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_db_database_list_database_upgrade_history_entries_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`upgrade_action`	(optional) A filter to return only upgradeHistoryEntries that match the specified Upgrade Action.
`lifecycle_state`	(optional) A filter to return only upgradeHistoryEntries that match the given lifecycle state exactly.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is ascending. Allowed values are: 'TIMESTARTED'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_DATABASES Function

Gets a list of the databases in the specified Database Home.

Syntax

FUNCTION list_databases (
  compartment_id varchar2,
  db_home_id varchar2 DEFAULT NULL,
  system_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  db_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_databases_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`db_home_id`	(optional) A Database Home OCID.
`system_id`	(optional) The OCID of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DBNAME is ascending. The DBNAME sort order is case sensitive. Allowed values are: 'DBNAME', 'TIMECREATED'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`db_name`	(optional) A filter to return only resources that match the entire database name given. The match is not case sensitive.
`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://database.{region}.{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_HOME_PATCH_HISTORY_ENTRIES Function

Lists the history of patch operations on the specified Database Home.

Syntax

FUNCTION list_db_home_patch_history_entries (
  db_home_id varchar2,
  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_db_database_list_db_home_patch_history_entries_response_t;

Parameters

Parameter	Description
`db_home_id`	(required) The Database Home OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_HOME_PATCHES Function

Lists patches applicable to the requested Database Home.

Syntax

FUNCTION list_db_home_patches (
  db_home_id varchar2,
  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_db_database_list_db_home_patches_response_t;

Parameters

Parameter	Description
`db_home_id`	(required) The Database Home OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_HOMES Function

Lists the Database Homes in the specified DB system and compartment. A Database Home is a directory where Oracle Database software is installed.

Syntax

FUNCTION list_db_homes (
  compartment_id varchar2,
  db_system_id varchar2 DEFAULT NULL,
  vm_cluster_id varchar2 DEFAULT NULL,
  backup_id varchar2 DEFAULT NULL,
  db_version varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_db_homes_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`db_system_id`	(optional) The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
`vm_cluster_id`	(optional) The OCID of the VM cluster.
`backup_id`	(optional) The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
`db_version`	(optional) A filter to return only DB Homes that match the specified dbVersion.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_NODES Function

Lists the database nodes in the specified DB system and compartment. A database node is a server running database software.

Syntax

FUNCTION list_db_nodes (
  compartment_id varchar2,
  db_system_id varchar2 DEFAULT NULL,
  vm_cluster_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  db_server_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_db_nodes_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`db_system_id`	(optional) The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
`vm_cluster_id`	(optional) The OCID of the VM cluster.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) Sort by TIMECREATED. Default order for TIMECREATED is descending. Allowed values are: 'TIMECREATED'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`db_server_id`	(optional) The OCID of the Exacc Db server.
`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://database.{region}.{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_SERVERS Function

Lists the Exadata DB servers in the ExadataInfrastructureId and specified compartment.

Syntax

FUNCTION list_db_servers (
  compartment_id varchar2,
  exadata_infrastructure_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_db_servers_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`exadata_infrastructure_id`	(required) The OCID of the ExadataInfrastructure.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request.
`sort_by`	(optional) Sort by TIMECREATED. Default order for TIMECREATED is descending. Allowed values are: 'TIMECREATED'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_SYSTEM_COMPUTE_PERFORMANCES Function

Gets a list of expected compute performance parameters for a virtual machine DB system based on system configuration.

Syntax

FUNCTION list_db_system_compute_performances (
  db_system_shape 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_db_database_list_db_system_compute_performances_response_t;

Parameters

Parameter	Description
`db_system_shape`	(optional) If provided, filters the results to the set of database versions which are supported for the given shape.
`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://database.{region}.{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_SYSTEM_PATCH_HISTORY_ENTRIES Function

Gets the history of the patch actions performed on the specified DB system.

Syntax

FUNCTION list_db_system_patch_history_entries (
  db_system_id varchar2,
  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_db_database_list_db_system_patch_history_entries_response_t;

Parameters

Parameter	Description
`db_system_id`	(required) The DB system OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_SYSTEM_PATCHES Function

Lists the patches applicable to the specified DB system.

Syntax

FUNCTION list_db_system_patches (
  db_system_id varchar2,
  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_db_database_list_db_system_patches_response_t;

Parameters

Parameter	Description
`db_system_id`	(required) The DB system OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_SYSTEM_SHAPES Function

Gets a list of the shapes that can be used to launch a new DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.

Syntax

FUNCTION list_db_system_shapes (
  compartment_id varchar2,
  availability_domain 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_db_database_list_db_system_shapes_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`availability_domain`	(optional) The name of the Availability Domain.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_SYSTEM_STORAGE_PERFORMANCES Function

Gets a list of possible expected storage performance parameters of a VMDB System based on Configuration.

Syntax

FUNCTION list_db_system_storage_performances (
  storage_management varchar2,
  shape_type 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_db_database_list_db_system_storage_performances_response_t;

Parameters

Parameter	Description
`storage_management`	(required) The DB system storage management option. Used to list database versions available for that storage manager. Valid values are `ASM` and `LVM`. * ASM specifies Oracle Automatic Storage Management * LVM specifies logical volume manager, sometimes called logical disk manager.
`shape_type`	(optional) Optional. Filters the performance results by shape type.
`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://database.{region}.{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_SYSTEM_UPGRADE_HISTORY_ENTRIES Function

Gets the history of the upgrade actions performed on the specified DB system.

Syntax

FUNCTION list_db_system_upgrade_history_entries (
  db_system_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  upgrade_action varchar2 DEFAULT NULL,
  lifecycle_state 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_db_database_list_db_system_upgrade_history_entries_response_t;

Parameters

Parameter	Description
`db_system_id`	(required) The DB system OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is ascending. Allowed values are: 'TIMESTARTED'
`upgrade_action`	(optional) A filter to return only upgradeHistoryEntries that match the specified Upgrade Action.
`lifecycle_state`	(optional) A filter to return only upgrade history entries that match the given lifecycle state exactly.
`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://database.{region}.{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_SYSTEMS Function

Lists the DB systems in the specified compartment. You can specify a `backupId` to list only the DB systems that support creating a database using this backup in this compartment. **Note:** Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.

Syntax

FUNCTION list_db_systems (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  backup_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  availability_domain varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_db_systems_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`backup_id`	(optional) The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`availability_domain`	(optional) A filter to return only resources that match the given availability domain exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_VERSIONS Function

Gets a list of supported Oracle Database versions.

Syntax

FUNCTION list_db_versions (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  db_system_shape varchar2 DEFAULT NULL,
  db_system_id varchar2 DEFAULT NULL,
  storage_management varchar2 DEFAULT NULL,
  is_upgrade_supported number DEFAULT NULL,
  is_database_software_image_supported number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_db_versions_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`db_system_shape`	(optional) If provided, filters the results to the set of database versions which are supported for the given shape.
`db_system_id`	(optional) The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
`storage_management`	(optional) The DB system storage management option. Used to list database versions available for that storage manager. Valid values are `ASM` and `LVM`. * ASM specifies Oracle Automatic Storage Management * LVM specifies logical volume manager, sometimes called logical disk manager.
`is_upgrade_supported`	(optional) If provided, filters the results to the set of database versions which are supported for Upgrade.
`is_database_software_image_supported`	(optional) If true, filters the results to the set of Oracle Database versions that are supported for OCI database software images.
`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://database.{region}.{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_EXADATA_INFRASTRUCTURES Function

Lists the Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud@Customer instances only. To list the Exadata Cloud Service infrastructure resources in a compartment, use the LIST_CLOUD_EXADATA_INFRASTRUCTURES Function operation.

Syntax

FUNCTION list_exadata_infrastructures (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  excluded_fields dbms_cloud_oci_database_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_exadata_infrastructures_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`opc_request_id`	(optional) Unique identifier for the request.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`excluded_fields`	(optional) If provided, the specified fields will be excluded in the response. Allowed values are: 'multiRackConfigurationFile'
`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://database.{region}.{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_CONTAINER_DATABASES Function

Gets a list of the external container databases in the specified compartment.

Syntax

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

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'DISPLAYNAME', 'TIMECREATED'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_DATABASE_CONNECTORS Function

Gets a list of the external database connectors in the specified compartment.

Syntax

FUNCTION list_external_database_connectors (
  compartment_id varchar2,
  external_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_external_database_connectors_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`external_database_id`	(required) The OCID of the external database whose connectors will be listed.
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'DISPLAYNAME', 'TIMECREATED'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_NON_CONTAINER_DATABASES Function

Gets a list of the ExternalNonContainerDatabases in the specified compartment.

Syntax

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

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'DISPLAYNAME', 'TIMECREATED'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_PLUGGABLE_DATABASES Function

Gets a list of the CREATE_EXTERNAL_PLUGGABLE_DATABASE_DETAILS Function resources in the specified compartment.

Syntax

FUNCTION list_external_pluggable_databases (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  external_container_database_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_external_pluggable_databases_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`external_container_database_id`	(optional) The ExternalContainerDatabase OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'DISPLAYNAME', 'TIMECREATED'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the specified lifecycle state.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_FLEX_COMPONENTS Function

Gets a list of the flex components that can be used to launch a new DB system. The flex component determines resources to allocate to the DB system - Database Servers and Storage Servers.

Syntax

FUNCTION list_flex_components (
  compartment_id varchar2,
  name varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by 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_db_database_list_flex_components_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`name`	(optional) A filter to return only resources that match the entire name given. The match is not case sensitive.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for NAME is ascending. The NAME sort order is case sensitive. Allowed values are: 'NAME'
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_GI_VERSIONS Function

Gets a list of supported GI versions for the Exadata Cloud@Customer VM cluster.

Syntax

FUNCTION list_gi_versions (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  shape varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_gi_versions_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`shape`	(optional) If provided, filters the results for the given shape.
`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://database.{region}.{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_KEY_STORES Function

Gets a list of key stores in the specified compartment.

Syntax

FUNCTION list_key_stores (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  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_db_database_list_key_stores_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_MAINTENANCE_RUN_HISTORY Function

Gets a list of the maintenance run histories in the specified compartment.

Syntax

FUNCTION list_maintenance_run_history (
  compartment_id varchar2,
  target_resource_id varchar2 DEFAULT NULL,
  target_resource_type varchar2 DEFAULT NULL,
  maintenance_type varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  availability_domain varchar2 DEFAULT NULL,
  maintenance_subtype varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_maintenance_run_history_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`target_resource_id`	(optional) The target resource ID.
`target_resource_type`	(optional) The type of the target resource.
`maintenance_type`	(optional) The maintenance type.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIME_SCHEDULED and TIME_ENDED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIME_SCHEDULED', 'TIME_ENDED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) The state of the maintenance run history.
`availability_domain`	(optional) A filter to return only resources that match the given availability domain exactly.
`maintenance_subtype`	(optional) The sub-type of the maintenance 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://database.{region}.{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_MAINTENANCE_RUNS Function

Gets a list of the maintenance runs in the specified compartment.

Syntax

FUNCTION list_maintenance_runs (
  compartment_id varchar2,
  target_resource_id varchar2 DEFAULT NULL,
  target_resource_type varchar2 DEFAULT NULL,
  maintenance_type varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  availability_domain varchar2 DEFAULT NULL,
  maintenance_subtype varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_maintenance_runs_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`target_resource_id`	(optional) The target resource ID.
`target_resource_type`	(optional) The type of the target resource.
`maintenance_type`	(optional) The maintenance type.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIME_SCHEDULED and TIME_ENDED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIME_SCHEDULED', 'TIME_ENDED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`availability_domain`	(optional) A filter to return only resources that match the given availability domain exactly.
`maintenance_subtype`	(optional) The sub-type of the maintenance 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://database.{region}.{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_ONEOFF_PATCHES Function

Lists one-off patches in the specified compartment.

Syntax

FUNCTION list_oneoff_patches (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name 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_db_database_list_oneoff_patches_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_PDB_CONVERSION_HISTORY_ENTRIES Function

Gets the pluggable database conversion history for a specified database in a bare metal or virtual machine DB system.

Syntax

FUNCTION list_pdb_conversion_history_entries (
  database_id varchar2,
  pdb_conversion_action varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order 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_db_database_list_pdb_conversion_history_entries_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`pdb_conversion_action`	(optional) A filter to return only the pluggable database conversion history entries that match the specified conversion action. For example, you can use this filter to return only entries for the precheck operation.
`lifecycle_state`	(optional) A filter to return only the pluggable database conversion history entries that match the specified lifecycle state. For example, you can use this filter to return only entries in the \"failed\" lifecycle state.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). The default order for `TIMECREATED` is ascending. Allowed values are: 'TIMESTARTED'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique identifier for the request.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_PLUGGABLE_DATABASES Function

Gets a list of the pluggable databases in a database or compartment. You must provide either a `databaseId` or `compartmentId` value.

Syntax

FUNCTION list_pluggable_databases (
  compartment_id varchar2 DEFAULT NULL,
  database_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  pdb_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_list_pluggable_databases_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The compartment OCID.
`database_id`	(optional) The OCID of the database.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for PDBNAME is ascending. The PDBNAME sort order is case sensitive. Allowed values are: 'PDBNAME', 'TIMECREATED'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`pdb_name`	(optional) A filter to return only pluggable databases that match the entire name given. The match is not case sensitive.
`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://database.{region}.{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_VERSIONS Function

Gets a list of supported Exadata system versions for a given shape and GI version.

Syntax

FUNCTION list_system_versions (
  compartment_id varchar2,
  shape varchar2,
  gi_version varchar2,
  limit number DEFAULT NULL,
  page 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_db_database_list_system_versions_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`shape`	(required) Specifies shape query parameter.
`gi_version`	(required) Specifies gi version query parameter.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`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://database.{region}.{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_VM_CLUSTER_NETWORKS Function

Gets a list of the VM cluster networks in the specified compartment. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION list_vm_cluster_networks (
  exadata_infrastructure_id varchar2,
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name 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_db_database_list_vm_cluster_networks_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`compartment_id`	(required) The compartment OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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_VM_CLUSTER_PATCH_HISTORY_ENTRIES Function

Gets the history of the patch actions performed on the specified VM cluster in an Exadata Cloud@Customer system.

Syntax

FUNCTION list_vm_cluster_patch_history_entries (
  vm_cluster_id varchar2,
  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_db_database_list_vm_cluster_patch_history_entries_response_t;

Parameters

Parameter	Description
`vm_cluster_id`	(required) The VM cluster OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_VM_CLUSTER_PATCHES Function

Lists the patches applicable to the specified VM cluster in an Exadata Cloud@Customer system.

Syntax

FUNCTION list_vm_cluster_patches (
  vm_cluster_id varchar2,
  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_db_database_list_vm_cluster_patches_response_t;

Parameters

Parameter	Description
`vm_cluster_id`	(required) The VM cluster OCID.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_VM_CLUSTER_UPDATE_HISTORY_ENTRIES Function

Gets the history of the maintenance update actions performed on the specified VM cluster. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION list_vm_cluster_update_history_entries (
  vm_cluster_id varchar2,
  update_type varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  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_db_database_list_vm_cluster_update_history_entries_response_t;

Parameters

Parameter	Description
`vm_cluster_id`	(required) The VM cluster OCID.
`update_type`	(optional) A filter to return only resources that match the given update type exactly. Allowed values are: 'GI_UPGRADE', 'GI_PATCH', 'OS_UPDATE'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_VM_CLUSTER_UPDATES Function

Lists the maintenance updates that can be applied to the specified VM cluster. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION list_vm_cluster_updates (
  vm_cluster_id varchar2,
  update_type varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  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_db_database_list_vm_cluster_updates_response_t;

Parameters

Parameter	Description
`vm_cluster_id`	(required) The VM cluster OCID.
`update_type`	(optional) A filter to return only resources that match the given update type exactly. Allowed values are: 'GI_UPGRADE', 'GI_PATCH', 'OS_UPDATE'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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_VM_CLUSTERS Function

Lists the VM clusters in the specified compartment. Applies to Exadata Cloud@Customer instances only. To list the cloud VM clusters in an Exadata Cloud Service instance, use the LIST_CLOUD_VM_CLUSTERS Function operation.

Syntax

FUNCTION list_vm_clusters (
  compartment_id varchar2,
  exadata_infrastructure_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name 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_db_database_list_vm_clusters_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The compartment OCID.
`exadata_infrastructure_id`	(optional) If provided, filters the results for the given Exadata Infrastructure.
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state exactly.
`display_name`	(optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.
`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://database.{region}.{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.

LOCAL_CLONE_PLUGGABLE_DATABASE Function

**Deprecated.** Use CREATE_PLUGGABLE_DATABASE Function for Pluggable Database LocalClone Operation. Clones and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in the `READ_WRITE` openMode to perform the clone operation.

Syntax

FUNCTION local_clone_pluggable_database (
  local_clone_pluggable_database_details dbms_cloud_oci_database_local_clone_pluggable_database_details_t,
  pluggable_database_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_db_database_local_clone_pluggable_database_response_t;

Parameters

Parameter	Description
`local_clone_pluggable_database_details`	(required) Request to clone a pluggable database locally.
`pluggable_database_id`	(required) The database OCID.
`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) Unique identifier for the request.
`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 may 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://database.{region}.{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.

MIGRATE_EXADATA_DB_SYSTEM_RESOURCE_MODEL Function

Migrates the Exadata DB system to the new Exadata resource model. All related resources will be migrated.

Syntax

FUNCTION migrate_exadata_db_system_resource_model (
  db_system_id varchar2,
  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_db_database_migrate_exadata_db_system_resource_model_response_t;

Parameters

Parameter	Description
`db_system_id`	(required) The DB system OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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.

MIGRATE_VAULT_KEY Function

Changes encryption key management from customer-managed, using the Vault service, to Oracle-managed.

Syntax

FUNCTION migrate_vault_key (
  database_id varchar2,
  migrate_vault_key_details dbms_cloud_oci_database_migrate_vault_key_details_t,
  if_match varchar2 DEFAULT NULL,
  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_db_database_migrate_vault_key_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`migrate_vault_key_details`	(required) Request to change the source of the encryption key for the database.
`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 may 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://database.{region}.{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.

MODIFY_DATABASE_MANAGEMENT Function

Updates one or more attributes of the Database Management service for the database.

Syntax

FUNCTION modify_database_management (
  database_id varchar2,
  modify_database_management_details dbms_cloud_oci_database_modify_database_management_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_modify_database_management_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`modify_database_management_details`	(required) The data to update one or more attributes of the Database Management Service for the 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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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.

MODIFY_PLUGGABLE_DATABASE_MANAGEMENT Function

Updates one or more attributes of the Database Management service for the pluggable database.

Syntax

FUNCTION modify_pluggable_database_management (
  pluggable_database_id varchar2,
  modify_pluggable_database_management_details dbms_cloud_oci_database_modify_pluggable_database_management_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_modify_pluggable_database_management_response_t;

Parameters

Parameter	Description
`pluggable_database_id`	(required) The database OCID.
`modify_pluggable_database_management_details`	(required) The data to update one or more attributes of the Database Management Service for the pluggable 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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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.

REFRESH_PLUGGABLE_DATABASE Function

Refreshes a pluggable database (PDB) Refreshable clone.

Syntax

FUNCTION refresh_pluggable_database (
  pluggable_database_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_db_database_refresh_pluggable_database_response_t;

Parameters

Parameter	Description
`pluggable_database_id`	(required) The database OCID.
`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) Unique identifier for the request.
`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 may 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://database.{region}.{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.

REGISTER_AUTONOMOUS_DATABASE_DATA_SAFE Function

Asynchronously registers this Autonomous Database with Data Safe.

Syntax

FUNCTION register_autonomous_database_data_safe (
  autonomous_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  register_autonomous_database_data_safe_details dbms_cloud_oci_database_register_autonomous_database_data_safe_details_t DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_register_autonomous_database_data_safe_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`register_autonomous_database_data_safe_details`	(optional) Request to register an Autonomous Database with Data Safe.
`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://database.{region}.{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.

REINSTATE_AUTONOMOUS_CONTAINER_DATABASE_DATAGUARD_ASSOCIATION Function

Reinstates a disabled standby Autonomous Container Database, identified by the autonomousContainerDatabaseId parameter, to an active standby Autonomous Container Database.

Syntax

FUNCTION reinstate_autonomous_container_database_dataguard_association (
  autonomous_container_database_id varchar2,
  autonomous_container_database_dataguard_association_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_reinstate_autonomous_container_database_dataguard_association_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`autonomous_container_database_dataguard_association_id`	(required) The Autonomous Container Database-Autonomous Data Guard association OCID.
`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://database.{region}.{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.

REINSTATE_DATA_GUARD_ASSOCIATION Function

Reinstates the database identified by the `databaseId` parameter into the standby role in a Data Guard association.

Syntax

FUNCTION reinstate_data_guard_association (
  database_id varchar2,
  data_guard_association_id varchar2,
  reinstate_data_guard_association_details dbms_cloud_oci_database_reinstate_data_guard_association_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_reinstate_data_guard_association_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`data_guard_association_id`	(required) The Data Guard association's OCID.
`reinstate_data_guard_association_details`	(required) A request to reinstate a database in a standby role.
`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://database.{region}.{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.

REMOTE_CLONE_PLUGGABLE_DATABASE Function

**Deprecated.** Use CREATE_PLUGGABLE_DATABASE Function for Pluggable Database RemoteClone Operation. Clones a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in the `READ_WRITE` openMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone.

Syntax

FUNCTION remote_clone_pluggable_database (
  remote_clone_pluggable_database_details dbms_cloud_oci_database_remote_clone_pluggable_database_details_t,
  pluggable_database_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_db_database_remote_clone_pluggable_database_response_t;

Parameters

Parameter	Description
`remote_clone_pluggable_database_details`	(required) Request to clone a pluggable database (PDB) to a different database (CDB) from the source PDB.
`pluggable_database_id`	(required) The database OCID.
`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) Unique identifier for the request.
`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 may 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://database.{region}.{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_VIRTUAL_MACHINE_FROM_CLOUD_VM_CLUSTER Function

Remove Virtual Machines from the Cloud VM cluster. Applies to Exadata Cloud instances only.

Syntax

FUNCTION remove_virtual_machine_from_cloud_vm_cluster (
  remove_virtual_machine_from_cloud_vm_cluster_details dbms_cloud_oci_database_remove_virtual_machine_from_cloud_vm_cluster_details_t,
  cloud_vm_cluster_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_remove_virtual_machine_from_cloud_vm_cluster_response_t;

Parameters

Parameter	Description
`remove_virtual_machine_from_cloud_vm_cluster_details`	(required) Request to remove Virtual Machines from the Cloud VM cluster.
`cloud_vm_cluster_id`	(required) The cloud VM cluster OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_VIRTUAL_MACHINE_FROM_VM_CLUSTER Function

Remove Virtual Machines from the VM cluster. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION remove_virtual_machine_from_vm_cluster (
  remove_virtual_machine_from_vm_cluster_details dbms_cloud_oci_database_remove_virtual_machine_from_vm_cluster_details_t,
  vm_cluster_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_remove_virtual_machine_from_vm_cluster_response_t;

Parameters

Parameter	Description
`remove_virtual_machine_from_vm_cluster_details`	(required) Request to remove Virtual Machines from the VM cluster.
`vm_cluster_id`	(required) The VM cluster OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_VM_CLUSTER_NETWORK Function

Adds or removes Db server network nodes to extend or shrink the existing VM cluster network. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION resize_vm_cluster_network (
  exadata_infrastructure_id varchar2,
  vm_cluster_network_id varchar2,
  resize_vm_cluster_network_details dbms_cloud_oci_database_resize_vm_cluster_network_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_db_database_resize_vm_cluster_network_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`vm_cluster_network_id`	(required) The VM cluster network OCID.
`resize_vm_cluster_network_details`	(required) Request to add or remove Db server network nodes in the VM cluster network.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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.

RESOURCE_POOL_SHAPES Function

Lists available resource pools shapes.

Syntax

FUNCTION resource_pool_shapes (
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  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_db_database_resource_pool_shapes_response_t;

Parameters

Parameter	Description
`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 may be rejected).
`limit`	(optional) The maximum number of items to return per page.
`page`	(optional) The pagination token to continue listing from.
`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://database.{region}.{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.

RESTART_AUTONOMOUS_CONTAINER_DATABASE Function

Rolling restarts the specified Autonomous Container Database.

Syntax

FUNCTION restart_autonomous_container_database (
  autonomous_container_database_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_db_database_restart_autonomous_container_database_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`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) 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://database.{region}.{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.

RESTART_AUTONOMOUS_DATABASE Function

Restarts the specified Autonomous Database.

Syntax

FUNCTION restart_autonomous_database (
  autonomous_database_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_restart_autonomous_database_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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://database.{region}.{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.

RESTORE_AUTONOMOUS_DATABASE Function

Restores an Autonomous Database based on the provided request parameters.

Syntax

FUNCTION restore_autonomous_database (
  autonomous_database_id varchar2,
  restore_autonomous_database_details dbms_cloud_oci_database_restore_autonomous_database_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_restore_autonomous_database_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`restore_autonomous_database_details`	(required) Request to perform an Autonomous Database restore.
`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://database.{region}.{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.

RESTORE_DATABASE Function

Restore a Database based on the request parameters you provide.

Syntax

FUNCTION restore_database (
  database_id varchar2,
  restore_database_details dbms_cloud_oci_database_restore_database_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_restore_database_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`restore_database_details`	(required) Request to perform database restore.
`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://database.{region}.{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.

ROTATE_AUTONOMOUS_CONTAINER_DATABASE_ENCRYPTION_KEY Function

Creates a new version of an existing Vault service key.

Syntax

FUNCTION rotate_autonomous_container_database_encryption_key (
  autonomous_container_database_id varchar2,
  if_match varchar2 DEFAULT NULL,
  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_db_database_rotate_autonomous_container_database_encryption_key_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`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 may 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://database.{region}.{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.

ROTATE_AUTONOMOUS_DATABASE_ENCRYPTION_KEY Function

Rotate existing AutonomousDatabase Vault service key.

Syntax

FUNCTION rotate_autonomous_database_encryption_key (
  autonomous_database_id varchar2,
  if_match varchar2 DEFAULT NULL,
  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_db_database_rotate_autonomous_database_encryption_key_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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 may 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://database.{region}.{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.

ROTATE_AUTONOMOUS_VM_CLUSTER_ORDS_CERTS Function

Rotates the Oracle REST Data Services (ORDS) certificates for Autonomous Exadata VM cluster.

Syntax

FUNCTION rotate_autonomous_vm_cluster_ords_certs (
  rotate_autonomous_vm_cluster_ords_certs_details dbms_cloud_oci_database_rotate_autonomous_vm_cluster_ords_certs_details_t,
  autonomous_vm_cluster_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_db_database_rotate_autonomous_vm_cluster_ords_certs_response_t;

Parameters

Parameter	Description
`rotate_autonomous_vm_cluster_ords_certs_details`	(required) Request to rotate the Oracle REST Data Services (ORDS) certificates on Autonomous Exadata VM cluster.
`autonomous_vm_cluster_id`	(required) The autonomous VM cluster OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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.

ROTATE_AUTONOMOUS_VM_CLUSTER_SSL_CERTS Function

Rotates the SSL certificates for Autonomous Exadata VM cluster.

Syntax

FUNCTION rotate_autonomous_vm_cluster_ssl_certs (
  rotate_autonomous_vm_cluster_ssl_certs_details dbms_cloud_oci_database_rotate_autonomous_vm_cluster_ssl_certs_details_t,
  autonomous_vm_cluster_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_db_database_rotate_autonomous_vm_cluster_ssl_certs_response_t;

Parameters

Parameter	Description
`rotate_autonomous_vm_cluster_ssl_certs_details`	(required) Request to rotate the SSL certificates on Autonomous Exadata VM cluster.
`autonomous_vm_cluster_id`	(required) The autonomous VM cluster OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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.

ROTATE_CLOUD_AUTONOMOUS_VM_CLUSTER_ORDS_CERTS Function

Rotates the Oracle REST Data Services (ORDS) certificates for a cloud Autonomous Exadata VM cluster.

Syntax

FUNCTION rotate_cloud_autonomous_vm_cluster_ords_certs (
  cloud_autonomous_vm_cluster_id varchar2,
  rotate_cloud_autonomous_vm_cluster_ords_certs_details dbms_cloud_oci_database_rotate_cloud_autonomous_vm_cluster_ords_certs_details_t DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_rotate_cloud_autonomous_vm_cluster_ords_certs_response_t;

Parameters

Parameter	Description
`cloud_autonomous_vm_cluster_id`	(required) The Cloud VM cluster OCID.
`rotate_cloud_autonomous_vm_cluster_ords_certs_details`	(optional) Request to rotate the Oracle REST Data Services (ORDS) certificates on Cloud Autonomous Exadata VM cluster.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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.

ROTATE_CLOUD_AUTONOMOUS_VM_CLUSTER_SSL_CERTS Function

Rotates the SSL certficates for a cloud Autonomous Exadata VM cluster.

Syntax

FUNCTION rotate_cloud_autonomous_vm_cluster_ssl_certs (
  cloud_autonomous_vm_cluster_id varchar2,
  rotate_cloud_autonomous_vm_cluster_ssl_certs_details dbms_cloud_oci_database_rotate_cloud_autonomous_vm_cluster_ssl_certs_details_t DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  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_db_database_rotate_cloud_autonomous_vm_cluster_ssl_certs_response_t;

Parameters

Parameter	Description
`cloud_autonomous_vm_cluster_id`	(required) The Cloud VM cluster OCID.
`rotate_cloud_autonomous_vm_cluster_ssl_certs_details`	(optional) Request to rotate the SSL certificates on Cloud Autonomous Exadata VM cluster.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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.

ROTATE_ORDS_CERTS Function

**Deprecated.** Use the ROTATE_CLOUD_AUTONOMOUS_VM_CLUSTER_ORDS_CERTS Function to rotate Oracle REST Data Services (ORDS) certs for an Autonomous Exadata VM cluster instead.

Syntax

FUNCTION rotate_ords_certs (
  autonomous_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_db_database_rotate_ords_certs_response_t;

Parameters

Parameter	Description
`autonomous_exadata_infrastructure_id`	(required) The Autonomous Exadata Infrastructure OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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.

ROTATE_PLUGGABLE_DATABASE_ENCRYPTION_KEY Function

Create a new version of the existing encryption key.

Syntax

FUNCTION rotate_pluggable_database_encryption_key (
  pluggable_database_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_db_database_rotate_pluggable_database_encryption_key_response_t;

Parameters

Parameter	Description
`pluggable_database_id`	(required) The database OCID.
`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) Unique identifier for the request.
`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 may 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://database.{region}.{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.

ROTATE_SSL_CERTS Function

**Deprecated.** Use the ROTATE_CLOUD_AUTONOMOUS_VM_CLUSTER_SSL_CERTS Function to rotate SSL certs for an Autonomous Exadata VM cluster instead.

Syntax

FUNCTION rotate_ssl_certs (
  autonomous_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_db_database_rotate_ssl_certs_response_t;

Parameters

Parameter	Description
`autonomous_exadata_infrastructure_id`	(required) The Autonomous Exadata Infrastructure OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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.

ROTATE_VAULT_KEY Function

Creates a new version of an existing Vault service key.

Syntax

FUNCTION rotate_vault_key (
  database_id varchar2,
  if_match varchar2 DEFAULT NULL,
  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_db_database_rotate_vault_key_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`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 may 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://database.{region}.{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.

SAAS_ADMIN_USER_STATUS Function

This operation gets SaaS administrative user status of the Autonomous Database.

Syntax

FUNCTION saas_admin_user_status (
  autonomous_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_db_database_saas_admin_user_status_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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://database.{region}.{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.

SCAN_EXTERNAL_CONTAINER_DATABASE_PLUGGABLE_DATABASES Function

Scans for pluggable databases in the specified external container database. This operation will return un-registered pluggable databases in the GET_WORK_REQUEST Function operation.

Syntax

FUNCTION scan_external_container_database_pluggable_databases (
  external_container_database_id varchar2,
  external_database_connector_id varchar2,
  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_db_database_scan_external_container_database_pluggable_databases_response_t;

Parameters

Parameter	Description
`external_container_database_id`	(required) The ExternalContainerDatabase OCID.
`external_database_connector_id`	(required) The OCID of the external database connector resource (`ExternalDatabaseConnectorId`).
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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.

SHRINK_AUTONOMOUS_DATABASE Function

This operation shrinks the current allocated storage down to the current actual used data storage (actualUsedDataStorageSizeInTBs). The if the base storage value for the database (dataStorageSizeInTBs) is larger than the actualUsedDataStorageSizeInTBs value, you are billed for the base storage value.

Syntax

FUNCTION shrink_autonomous_database (
  autonomous_database_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_shrink_autonomous_database_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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://database.{region}.{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.

START_AUTONOMOUS_DATABASE Function

Starts the specified Autonomous Database.

Syntax

FUNCTION start_autonomous_database (
  autonomous_database_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_start_autonomous_database_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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://database.{region}.{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.

START_PLUGGABLE_DATABASE Function

Starts a stopped pluggable database. The `openMode` value of the pluggable database will be `READ_WRITE` upon completion.

Syntax

FUNCTION start_pluggable_database (
  pluggable_database_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_db_database_start_pluggable_database_response_t;

Parameters

Parameter	Description
`pluggable_database_id`	(required) The database OCID.
`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) Unique identifier for the request.
`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 may 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://database.{region}.{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.

STOP_AUTONOMOUS_DATABASE Function

Stops the specified Autonomous Database.

Syntax

FUNCTION stop_autonomous_database (
  autonomous_database_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_db_database_stop_autonomous_database_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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) 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://database.{region}.{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.

STOP_PLUGGABLE_DATABASE Function

Stops a pluggable database. The `openMode` value of the pluggable database will be `MOUNTED` upon completion.

Syntax

FUNCTION stop_pluggable_database (
  pluggable_database_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_db_database_stop_pluggable_database_response_t;

Parameters

Parameter	Description
`pluggable_database_id`	(required) The database OCID.
`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) Unique identifier for the request.
`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 may 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://database.{region}.{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.

SWITCHOVER_AUTONOMOUS_CONTAINER_DATABASE_DATAGUARD_ASSOCIATION Function

Switches over the primary Autonomous Container Database of an Autonomous Data Guard peer association to standby role. The standby Autonomous Container Database associated with autonomousContainerDatabaseDataguardAssociationId assumes the primary Autonomous Container Database role. A switchover incurs no data loss.

Syntax

FUNCTION switchover_autonomous_container_database_dataguard_association (
  autonomous_container_database_id varchar2,
  autonomous_container_database_dataguard_association_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_switchover_autonomous_container_database_dataguard_association_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`autonomous_container_database_dataguard_association_id`	(required) The Autonomous Container Database-Autonomous Data Guard association OCID.
`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://database.{region}.{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.

SWITCHOVER_AUTONOMOUS_DATABASE Function

Initiates a switchover of the specified Autonomous Database to the associated standby database. Applicable only to databases with Autonomous Data Guard enabled. To perform a switchover to a standby located in a remote region, specify the OCID of the remote standby using the `peerDbId` parameter.

Syntax

FUNCTION switchover_autonomous_database (
  autonomous_database_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  peer_db_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_switchover_autonomous_database_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request.
`peer_db_id`	(optional) The database OCID of the Autonomous Data Guard standby database located in a different (remote) region from the source primary Autonomous Database.
`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://database.{region}.{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.

SWITCHOVER_DATA_GUARD_ASSOCIATION Function

Performs a switchover to transition the primary database of a Data Guard association into a standby role. The standby database associated with the `dataGuardAssociationId` assumes the primary database role. A switchover guarantees no data loss.

Syntax

FUNCTION switchover_data_guard_association (
  database_id varchar2,
  data_guard_association_id varchar2,
  switchover_data_guard_association_details dbms_cloud_oci_database_switchover_data_guard_association_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_switchover_data_guard_association_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`data_guard_association_id`	(required) The Data Guard association's OCID.
`switchover_data_guard_association_details`	(required) Request to swtichover a primary to a standby.
`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://database.{region}.{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.

TERMINATE_AUTONOMOUS_CONTAINER_DATABASE Function

Terminates an Autonomous Container Database, which permanently deletes the container database and any databases within the container database. The database data is local to the Autonomous Exadata Infrastructure and will be lost when the container database is terminated. Oracle recommends that you back up any data in the Autonomous Container Database prior to terminating it.

Syntax

FUNCTION terminate_autonomous_container_database (
  autonomous_container_database_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_terminate_autonomous_container_database_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`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://database.{region}.{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.

TERMINATE_AUTONOMOUS_EXADATA_INFRASTRUCTURE Function

**Deprecated.** To terminate an Exadata Infrastructure resource in the Oracle cloud, use the DELETE_CLOUD_EXADATA_INFRASTRUCTURE Function operation. To delete an Autonomous Exadata VM cluster in the Oracle cloud, use the DELETE_CLOUD_AUTONOMOUS_VM_CLUSTER Function operation.

Syntax

FUNCTION terminate_autonomous_exadata_infrastructure (
  autonomous_exadata_infrastructure_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_terminate_autonomous_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`autonomous_exadata_infrastructure_id`	(required) The Autonomous Exadata Infrastructure OCID.
`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://database.{region}.{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.

TERMINATE_DB_SYSTEM Function

Terminates a DB system and permanently deletes it and any databases running on it, and any storage volumes attached to it. The database data is local to the DB system and will be lost when the system is terminated. Oracle recommends that you back up any data in the DB system prior to terminating it. **Note:** Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.

Syntax

FUNCTION terminate_db_system (
  db_system_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_terminate_db_system_response_t;

Parameters

Parameter	Description
`db_system_id`	(required) The DB system OCID.
`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://database.{region}.{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_AUTONOMOUS_CONTAINER_DATABASE Function

Updates the properties of an Autonomous Container Database, such as display name, maintenance preference, backup retention, and tags.

Syntax

FUNCTION update_autonomous_container_database (
  autonomous_container_database_id varchar2,
  update_autonomous_container_database_details dbms_cloud_oci_database_update_autonomous_container_database_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_update_autonomous_container_database_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`update_autonomous_container_database_details`	(required) Request to update the properties of an Autonomous Container Database.
`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://database.{region}.{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_AUTONOMOUS_CONTAINER_DATABASE_DATAGUARD_ASSOCIATION Function

Update Autonomous Data Guard association.

Syntax

FUNCTION update_autonomous_container_database_dataguard_association (
  autonomous_container_database_id varchar2,
  autonomous_container_database_dataguard_association_id varchar2,
  update_autonomous_container_database_data_guard_association_details dbms_cloud_oci_database_update_autonomous_container_database_data_guard_association_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_db_database_update_autonomous_container_database_dataguard_association_response_t;

Parameters

Parameter	Description
`autonomous_container_database_id`	(required) The Autonomous Container Database OCID.
`autonomous_container_database_dataguard_association_id`	(required) The Autonomous Container Database-Autonomous Data Guard association OCID.
`update_autonomous_container_database_data_guard_association_details`	(required) A request to update Data Guard association of a database.
`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) 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://database.{region}.{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_AUTONOMOUS_DATABASE Function

Updates one or more attributes of the specified Autonomous Database. See the UpdateAutonomousDatabaseDetails resource for a full list of attributes that can be updated.

Syntax

FUNCTION update_autonomous_database (
  autonomous_database_id varchar2,
  update_autonomous_database_details dbms_cloud_oci_database_update_autonomous_database_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_db_database_update_autonomous_database_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`update_autonomous_database_details`	(required) Request to update the properties of an Autonomous Database.
`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) 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://database.{region}.{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_AUTONOMOUS_DATABASE_BACKUP Function

Updates the Autonomous Database backup of the specified database based on the request parameters.

Syntax

FUNCTION update_autonomous_database_backup (
  autonomous_database_backup_id varchar2,
  update_autonomous_database_backup_details dbms_cloud_oci_database_update_autonomous_database_backup_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_db_database_update_autonomous_database_backup_response_t;

Parameters

Parameter	Description
`autonomous_database_backup_id`	(required) The OCID of the Autonomous Database backup.
`update_autonomous_database_backup_details`	(required) Request to update an existing Autonomous Database backup.
`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) 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://database.{region}.{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_AUTONOMOUS_DATABASE_REGIONAL_WALLET Function

Updates the Autonomous Database regional wallet.

Syntax

FUNCTION update_autonomous_database_regional_wallet (
  update_autonomous_database_wallet_details dbms_cloud_oci_database_update_autonomous_database_wallet_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_db_database_update_autonomous_database_regional_wallet_response_t;

Parameters

Parameter	Description
`update_autonomous_database_wallet_details`	(required) Request to update the properties of Autonomous Database regional wallet.
`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://database.{region}.{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_AUTONOMOUS_DATABASE_WALLET Function

Updates the wallet for the specified Autonomous Database.

Syntax

FUNCTION update_autonomous_database_wallet (
  autonomous_database_id varchar2,
  update_autonomous_database_wallet_details dbms_cloud_oci_database_update_autonomous_database_wallet_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_db_database_update_autonomous_database_wallet_response_t;

Parameters

Parameter	Description
`autonomous_database_id`	(required) The database OCID.
`update_autonomous_database_wallet_details`	(required) Request to update the properties of an Autonomous Database wallet.
`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://database.{region}.{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_AUTONOMOUS_EXADATA_INFRASTRUCTURE Function

**Deprecated.** Use the UPDATE_CLOUD_EXADATA_INFRASTRUCTURE Function operation to update an Exadata Infrastructure resource and UPDATE_CLOUD_AUTONOMOUS_VM_CLUSTER Function operation to update an Autonomous Exadata VM cluster.

Syntax

FUNCTION update_autonomous_exadata_infrastructure (
  autonomous_exadata_infrastructure_id varchar2,
  update_autonomous_exadata_infrastructures_details dbms_cloud_oci_database_update_autonomous_exadata_infrastructure_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_update_autonomous_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`autonomous_exadata_infrastructure_id`	(required) The Autonomous Exadata Infrastructure OCID.
`update_autonomous_exadata_infrastructures_details`	(required) Request to update the properties of a Autonomous Exadata Infrastructure.
`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://database.{region}.{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_AUTONOMOUS_VM_CLUSTER Function

Updates the specified Autonomous VM cluster for the Exadata Cloud@Customer system.To update an Autonomous VM Cluster in the Oracle cloud, see UPDATE_CLOUD_AUTONOMOUS_VM_CLUSTER Function.

Syntax

FUNCTION update_autonomous_vm_cluster (
  autonomous_vm_cluster_id varchar2,
  update_autonomous_vm_cluster_details dbms_cloud_oci_database_update_autonomous_vm_cluster_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_db_database_update_autonomous_vm_cluster_response_t;

Parameters

Parameter	Description
`autonomous_vm_cluster_id`	(required) The autonomous VM cluster OCID.
`update_autonomous_vm_cluster_details`	(required) Request to update the attributes of an Autonomous VM cluster.
`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) 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://database.{region}.{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_BACKUP_DESTINATION Function

If no database is associated with the backup destination: - For a RECOVERY_APPLIANCE backup destination, updates the connection string and/or the list of VPC users. - For an NFS backup destination, updates the NFS location.

Syntax

FUNCTION update_backup_destination (
  backup_destination_id varchar2,
  update_backup_destination_details dbms_cloud_oci_database_update_backup_destination_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_db_database_update_backup_destination_response_t;

Parameters

Parameter	Description
`backup_destination_id`	(required) The OCID of the backup destination.
`update_backup_destination_details`	(required) For a RECOVERY_APPLIANCE backup destination, request to update the connection string and/or the list of VPC users. For an NFS backup destination, request to update the NFS location.
`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) 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://database.{region}.{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_CLOUD_AUTONOMOUS_VM_CLUSTER Function

Updates the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see UPDATE_AUTONOMOUS_VM_CLUSTER Function.

Syntax

FUNCTION update_cloud_autonomous_vm_cluster (
  cloud_autonomous_vm_cluster_id varchar2,
  update_cloud_autonomous_vm_cluster_details dbms_cloud_oci_database_update_cloud_autonomous_vm_cluster_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_db_database_update_cloud_autonomous_vm_cluster_response_t;

Parameters

Parameter	Description
`cloud_autonomous_vm_cluster_id`	(required) The Cloud VM cluster OCID.
`update_cloud_autonomous_vm_cluster_details`	(required) Request to update the attributes of a cloud VM cluster.
`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) 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://database.{region}.{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_CLOUD_EXADATA_INFRASTRUCTURE Function

Updates the Cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Syntax

FUNCTION update_cloud_exadata_infrastructure (
  cloud_exadata_infrastructure_id varchar2,
  update_cloud_exadata_infrastructure_details dbms_cloud_oci_database_update_cloud_exadata_infrastructure_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_db_database_update_cloud_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`cloud_exadata_infrastructure_id`	(required) The cloud Exadata infrastructure OCID.
`update_cloud_exadata_infrastructure_details`	(required) Request to update the properties of an cloud Exadata infrastructure resource.
`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) 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://database.{region}.{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_CLOUD_VM_CLUSTER Function

Updates the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

Syntax

FUNCTION update_cloud_vm_cluster (
  cloud_vm_cluster_id varchar2,
  update_cloud_vm_cluster_details dbms_cloud_oci_database_update_cloud_vm_cluster_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_db_database_update_cloud_vm_cluster_response_t;

Parameters

Parameter	Description
`cloud_vm_cluster_id`	(required) The cloud VM cluster OCID.
`update_cloud_vm_cluster_details`	(required) Request to update the attributes of a cloud VM cluster.
`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) 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://database.{region}.{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_CLOUD_VM_CLUSTER_IORM_CONFIG Function

Updates the IORM settings for the specified cloud VM cluster in an Exadata Cloud Service instance.

Syntax

FUNCTION update_cloud_vm_cluster_iorm_config (
  cloud_vm_cluster_id varchar2,
  cloud_vm_cluster_iorm_config_update_details dbms_cloud_oci_database_exadata_iorm_config_update_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_db_database_update_cloud_vm_cluster_iorm_config_response_t;

Parameters

Parameter	Description
`cloud_vm_cluster_id`	(required) The cloud VM cluster OCID.
`cloud_vm_cluster_iorm_config_update_details`	(required) Request to perform database update.
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_CONSOLE_CONNECTION Function

Updates the specified database node console connection.

Syntax

FUNCTION update_console_connection (
  db_node_id varchar2,
  console_connection_id varchar2,
  update_console_connection_details dbms_cloud_oci_database_update_console_connection_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_db_database_update_console_connection_response_t;

Parameters

Parameter	Description
`db_node_id`	(required) The database node OCID.
`console_connection_id`	(required) The OCID of the console connection.
`update_console_connection_details`	(required) Request to update the specified database node console connection.
`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) 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://database.{region}.{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_CONSOLE_HISTORY Function

Updates the specified database node console history.

Syntax

FUNCTION update_console_history (
  db_node_id varchar2,
  console_history_id varchar2,
  update_console_history_details dbms_cloud_oci_database_update_console_history_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_db_database_update_console_history_response_t;

Parameters

Parameter	Description
`db_node_id`	(required) The database node OCID.
`console_history_id`	(required) The OCID of the console history.
`update_console_history_details`	(required) Request to update the specified database node console history.
`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) 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://database.{region}.{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_DATA_GUARD_ASSOCIATION Function

Updates the Data Guard association the specified database. This API can be used to change the `protectionMode` and `transportType` of the Data Guard association.

Syntax

FUNCTION update_data_guard_association (
  database_id varchar2,
  data_guard_association_id varchar2,
  update_data_guard_association_details dbms_cloud_oci_database_update_data_guard_association_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_db_database_update_data_guard_association_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`data_guard_association_id`	(required) The Data Guard association's OCID.
`update_data_guard_association_details`	(required) A request to update Data Guard association of a database.
`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) 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://database.{region}.{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_DATABASE Function

Update the specified database based on the request parameters provided.

Syntax

FUNCTION update_database (
  database_id varchar2,
  update_database_details dbms_cloud_oci_database_update_database_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_update_database_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`update_database_details`	(required) Request to perform database update.
`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://database.{region}.{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_DATABASE_SOFTWARE_IMAGE Function

Updates the properties of a Database Software Image, like Display Nmae

Syntax

FUNCTION update_database_software_image (
  database_software_image_id varchar2,
  update_database_software_image_details dbms_cloud_oci_database_update_database_software_image_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_update_database_software_image_response_t;

Parameters

Parameter	Description
`database_software_image_id`	(required) The DB system OCID.
`update_database_software_image_details`	(required) Request to update the properties of a DB system.
`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://database.{region}.{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_HOME Function

Patches the specified Database Home.

Syntax

FUNCTION update_db_home (
  db_home_id varchar2,
  update_db_home_details dbms_cloud_oci_database_update_db_home_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_update_db_home_response_t;

Parameters

Parameter	Description
`db_home_id`	(required) The Database Home OCID.
`update_db_home_details`	(required) Request to update the properties of a Database Home.
`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://database.{region}.{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_NODE Function

Updates the specified database node.

Syntax

FUNCTION update_db_node (
  db_node_id varchar2,
  update_db_node_details dbms_cloud_oci_database_update_db_node_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_db_database_update_db_node_response_t;

Parameters

Parameter	Description
`db_node_id`	(required) The database node OCID.
`update_db_node_details`	(required) Request to update the specified database node.
`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) 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://database.{region}.{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_SYSTEM Function

Updates the properties of the specified DB system. **Note:** Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.

Syntax

FUNCTION update_db_system (
  db_system_id varchar2,
  update_db_system_details dbms_cloud_oci_database_update_db_system_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_update_db_system_response_t;

Parameters

Parameter	Description
`db_system_id`	(required) The DB system OCID.
`update_db_system_details`	(required) Request to update the properties of a DB system.
`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://database.{region}.{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_EXADATA_INFRASTRUCTURE Function

Updates the Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. To update an Exadata Cloud Service infrastructure resource, use the UPDATE_CLOUD_EXADATA_INFRASTRUCTURE Function operation.

Syntax

FUNCTION update_exadata_infrastructure (
  exadata_infrastructure_id varchar2,
  update_exadata_infrastructure_details dbms_cloud_oci_database_update_exadata_infrastructure_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_db_database_update_exadata_infrastructure_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`update_exadata_infrastructure_details`	(required) Request to update the properties of an Exadata Cloud@Customer infrastructure.
`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) 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://database.{region}.{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_EXADATA_IORM_CONFIG Function

Updates IORM settings for the specified Exadata DB system. **Note:** Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead. For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model. The UPDATE_CLOUD_VM_CLUSTER_IORM_CONFIG Function API is used for Exadata systems using the new resource model.

Syntax

FUNCTION update_exadata_iorm_config (
  db_system_id varchar2,
  exadata_iorm_config_update_details dbms_cloud_oci_database_exadata_iorm_config_update_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_db_database_update_exadata_iorm_config_response_t;

Parameters

Parameter	Description
`db_system_id`	(required) The DB system OCID.
`exadata_iorm_config_update_details`	(required) Request to perform database update.
`opc_request_id`	(optional) Unique identifier for the request.
`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://database.{region}.{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_CONTAINER_DATABASE Function

Updates the properties of an CREATE_EXTERNAL_CONTAINER_DATABASE_DETAILS Function resource, such as the display name.

Syntax

FUNCTION update_external_container_database (
  external_container_database_id varchar2,
  update_external_container_database_details dbms_cloud_oci_database_update_external_container_database_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_db_database_update_external_container_database_response_t;

Parameters

Parameter	Description
`external_container_database_id`	(required) The ExternalContainerDatabase OCID.
`update_external_container_database_details`	(required) Request to update the properties of an `CREATE_EXTERNAL_CONTAINER_DATABASE_DETAILS` Function resource.
`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) 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://database.{region}.{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_DATABASE_CONNECTOR Function

Updates the properties of an external database connector, such as the display name.

Syntax

FUNCTION update_external_database_connector (
  external_database_connector_id varchar2,
  update_external_database_connector_details dbms_cloud_oci_database_update_external_database_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_db_database_update_external_database_connector_response_t;

Parameters

Parameter	Description
`external_database_connector_id`	(required) The OCID of the external database connector resource (`ExternalDatabaseConnectorId`).
`update_external_database_connector_details`	(required) Request to update the properties of an external database 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) 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://database.{region}.{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_NON_CONTAINER_DATABASE Function

Updates the properties of an external non-container database, such as the display name.

Syntax

FUNCTION update_external_non_container_database (
  external_non_container_database_id varchar2,
  update_external_non_container_database_details dbms_cloud_oci_database_update_external_non_container_database_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_db_database_update_external_non_container_database_response_t;

Parameters

Parameter	Description
`external_non_container_database_id`	(required) The external non-container database OCID.
`update_external_non_container_database_details`	(required) Request to update the properties of an external non-container database.
`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) 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://database.{region}.{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_PLUGGABLE_DATABASE Function

Updates the properties of an CREATE_EXTERNAL_PLUGGABLE_DATABASE_DETAILS Function resource, such as the display name.

Syntax

FUNCTION update_external_pluggable_database (
  external_pluggable_database_id varchar2,
  update_external_pluggable_database_details dbms_cloud_oci_database_update_external_pluggable_database_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_db_database_update_external_pluggable_database_response_t;

Parameters

Parameter	Description
`external_pluggable_database_id`	(required) The ExternalPluggableDatabaseId OCID.
`update_external_pluggable_database_details`	(required) Request to update the properties of an external pluggable database resource.
`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) 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://database.{region}.{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_KEY_STORE Function

If no database is associated with the key store, edit the key store.

Syntax

FUNCTION update_key_store (
  key_store_id varchar2,
  update_key_store_details dbms_cloud_oci_database_update_key_store_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_db_database_update_key_store_response_t;

Parameters

Parameter	Description
`key_store_id`	(required) The OCID of the key store.
`update_key_store_details`	(required) Request to update the attributes of a key store.
`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) 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://database.{region}.{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_MAINTENANCE_RUN Function

Updates the properties of a maintenance run, such as the state of a maintenance run.

Syntax

FUNCTION update_maintenance_run (
  maintenance_run_id varchar2,
  update_maintenance_run_details dbms_cloud_oci_database_update_maintenance_run_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_update_maintenance_run_response_t;

Parameters

Parameter	Description
`maintenance_run_id`	(required) The maintenance run OCID.
`update_maintenance_run_details`	(required) Request to update the properties of a maintenance run.
`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://database.{region}.{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_ONEOFF_PATCH Function

Updates the properties of the specified one-off patch.

Syntax

FUNCTION update_oneoff_patch (
  oneoff_patch_id varchar2,
  update_oneoff_patch_details dbms_cloud_oci_database_update_oneoff_patch_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_db_database_update_oneoff_patch_response_t;

Parameters

Parameter	Description
`oneoff_patch_id`	(required) The one-off patch OCID.
`update_oneoff_patch_details`	(required) Request to update the properties of a one-off patch.
`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) 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://database.{region}.{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_PLUGGABLE_DATABASE Function

Updates the specified pluggable database.

Syntax

FUNCTION update_pluggable_database (
  pluggable_database_id varchar2,
  update_pluggable_database_details dbms_cloud_oci_database_update_pluggable_database_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_db_database_update_pluggable_database_response_t;

Parameters

Parameter	Description
`pluggable_database_id`	(required) The database OCID.
`update_pluggable_database_details`	(required) Request to perform pluggable database update.
`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://database.{region}.{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_VM_CLUSTER Function

Updates the specified VM cluster. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION update_vm_cluster (
  vm_cluster_id varchar2,
  update_vm_cluster_details dbms_cloud_oci_database_update_vm_cluster_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_db_database_update_vm_cluster_response_t;

Parameters

Parameter	Description
`vm_cluster_id`	(required) The VM cluster OCID.
`update_vm_cluster_details`	(required) Request to update the attributes of a VM cluster.
`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) 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://database.{region}.{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_VM_CLUSTER_NETWORK Function

Updates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To update a cloud VM cluster in an Exadata Cloud Service instance, use the UPDATE_CLOUD_VM_CLUSTER Function operation.

Syntax

FUNCTION update_vm_cluster_network (
  exadata_infrastructure_id varchar2,
  vm_cluster_network_id varchar2,
  update_vm_cluster_network_details dbms_cloud_oci_database_update_vm_cluster_network_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_db_database_update_vm_cluster_network_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`vm_cluster_network_id`	(required) The VM cluster network OCID.
`update_vm_cluster_network_details`	(required) Request to update the properties of a VM cluster network.
`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) 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://database.{region}.{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.

UPGRADE_DATABASE Function

Upgrades the specified Oracle Database instance.

Syntax

FUNCTION upgrade_database (
  database_id varchar2,
  upgrade_database_details dbms_cloud_oci_database_upgrade_database_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_db_database_upgrade_database_response_t;

Parameters

Parameter	Description
`database_id`	(required) The database OCID.
`upgrade_database_details`	(required) Request to perform a database upgrade.
`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) 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://database.{region}.{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.

UPGRADE_DB_SYSTEM Function

Upgrades the operating system and grid infrastructure of the DB system.

Syntax

FUNCTION upgrade_db_system (
  db_system_id varchar2,
  upgrade_db_system_details dbms_cloud_oci_database_upgrade_db_system_details_t,
  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_db_database_upgrade_db_system_response_t;

Parameters

Parameter	Description
`db_system_id`	(required) The DB system OCID.
`upgrade_db_system_details`	(required) Request to perform an upgrade of the operating system and the Oracle Grid Infrastructure (GI) of the DB system.
`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) Unique identifier for the request.
`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 may 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://database.{region}.{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.

VALIDATE_VM_CLUSTER_NETWORK Function

Validates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.

Syntax

FUNCTION validate_vm_cluster_network (
  exadata_infrastructure_id varchar2,
  vm_cluster_network_id varchar2,
  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_db_database_validate_vm_cluster_network_response_t;

Parameters

Parameter	Description
`exadata_infrastructure_id`	(required) The Exadata infrastructure OCID.
`vm_cluster_network_id`	(required) The VM cluster network OCID.
`opc_request_id`	(optional) Unique identifier for the request.
`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 may 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://database.{region}.{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

ACTIVATE_EXADATA_INFRASTRUCTURE Function

ADD_STORAGE_CAPACITY_CLOUD_EXADATA_INFRASTRUCTURE Function

ADD_STORAGE_CAPACITY_EXADATA_INFRASTRUCTURE Function

ADD_VIRTUAL_MACHINE_TO_CLOUD_VM_CLUSTER Function

ADD_VIRTUAL_MACHINE_TO_VM_CLUSTER Function

AUTONOMOUS_DATABASE_MANUAL_REFRESH Function

CANCEL_BACKUP Function

CHANGE_AUTONOMOUS_CONTAINER_DATABASE_COMPARTMENT Function

CHANGE_AUTONOMOUS_DATABASE_COMPARTMENT Function

CHANGE_AUTONOMOUS_EXADATA_INFRASTRUCTURE_COMPARTMENT Function

CHANGE_AUTONOMOUS_VM_CLUSTER_COMPARTMENT Function

CHANGE_BACKUP_DESTINATION_COMPARTMENT Function

CHANGE_CLOUD_AUTONOMOUS_VM_CLUSTER_COMPARTMENT Function

CHANGE_CLOUD_EXADATA_INFRASTRUCTURE_COMPARTMENT Function

CHANGE_CLOUD_VM_CLUSTER_COMPARTMENT Function

CHANGE_DATABASE_SOFTWARE_IMAGE_COMPARTMENT Function

CHANGE_DATAGUARD_ROLE Function

CHANGE_DB_SYSTEM_COMPARTMENT Function

CHANGE_DISASTER_RECOVERY_CONFIGURATION Function

CHANGE_EXADATA_INFRASTRUCTURE_COMPARTMENT Function

CHANGE_EXTERNAL_CONTAINER_DATABASE_COMPARTMENT Function

CHANGE_EXTERNAL_NON_CONTAINER_DATABASE_COMPARTMENT Function

CHANGE_EXTERNAL_PLUGGABLE_DATABASE_COMPARTMENT Function

CHANGE_KEY_STORE_COMPARTMENT Function

CHANGE_KEY_STORE_TYPE Function

CHANGE_ONEOFF_PATCH_COMPARTMENT Function

CHANGE_VM_CLUSTER_COMPARTMENT Function

CHECK_EXTERNAL_DATABASE_CONNECTOR_CONNECTION_STATUS Function

COMPLETE_EXTERNAL_BACKUP_JOB Function

CONFIGURE_AUTONOMOUS_DATABASE_VAULT_KEY Function

CONFIGURE_SAAS_ADMIN_USER Function

CONVERT_TO_PDB Function

CONVERT_TO_REGULAR_PLUGGABLE_DATABASE Function

CREATE_APPLICATION_VIP Function

CREATE_AUTONOMOUS_CONTAINER_DATABASE Function

CREATE_AUTONOMOUS_CONTAINER_DATABASE_DATAGUARD_ASSOCIATION Function

CREATE_AUTONOMOUS_DATABASE Function

CREATE_AUTONOMOUS_DATABASE_BACKUP Function

CREATE_AUTONOMOUS_VM_CLUSTER Function

CREATE_BACKUP Function

CREATE_BACKUP_DESTINATION Function

CREATE_CLOUD_AUTONOMOUS_VM_CLUSTER Function

CREATE_CLOUD_EXADATA_INFRASTRUCTURE Function

CREATE_CLOUD_VM_CLUSTER Function

CREATE_CONSOLE_CONNECTION Function

CREATE_CONSOLE_HISTORY Function

CREATE_DATA_GUARD_ASSOCIATION Function

CREATE_DATABASE Function

CREATE_DATABASE_SOFTWARE_IMAGE Function

CREATE_DB_HOME Function

CREATE_EXADATA_INFRASTRUCTURE Function

CREATE_EXTERNAL_BACKUP_JOB Function

CREATE_EXTERNAL_CONTAINER_DATABASE Function

CREATE_EXTERNAL_DATABASE_CONNECTOR Function

CREATE_EXTERNAL_NON_CONTAINER_DATABASE Function

CREATE_EXTERNAL_PLUGGABLE_DATABASE Function

CREATE_KEY_STORE Function

CREATE_MAINTENANCE_RUN Function

CREATE_ONEOFF_PATCH Function

CREATE_PLUGGABLE_DATABASE Function

CREATE_VM_CLUSTER Function

CREATE_VM_CLUSTER_NETWORK Function

DB_NODE_ACTION Function

DELETE_APPLICATION_VIP Function

DELETE_AUTONOMOUS_DATABASE Function

DELETE_AUTONOMOUS_DATABASE_BACKUP Function

DELETE_AUTONOMOUS_VM_CLUSTER Function

DELETE_BACKUP Function

DELETE_BACKUP_DESTINATION Function

DELETE_CLOUD_AUTONOMOUS_VM_CLUSTER Function

DELETE_CLOUD_EXADATA_INFRASTRUCTURE Function

DELETE_CLOUD_VM_CLUSTER Function

DELETE_CONSOLE_CONNECTION Function

DELETE_CONSOLE_HISTORY Function

DELETE_DATABASE Function

DELETE_DATABASE_SOFTWARE_IMAGE Function

DELETE_DB_HOME Function

DELETE_EXADATA_INFRASTRUCTURE Function

DELETE_EXTERNAL_CONTAINER_DATABASE Function