externalcontainerdatabases

Creates, updates, deletes, gets or lists an externalcontainerdatabases resource.

Overview

Name	externalcontainerdatabases
Type	Resource
Id	oci.database.externalcontainerdatabases

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
disable_external_container_database_database_management	exec	externalContainerDatabaseId, region	opc-retry-token, opc-request-id, if-match	Disable Database Management service for the external container database.<br />
disable_external_container_database_stack_monitoring	exec	externalContainerDatabaseId, region	opc-retry-token, opc-request-id, if-match	Disable Stack Monitoring for the external container database.<br />
enable_external_container_database_database_management	exec	externalContainerDatabaseId, region, externalDatabaseConnectorId, licenseModel	opc-retry-token, opc-request-id, if-match	Enables Database Management Service for the external container database.<br />For more information about the Database Management Service, see<br />[Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm).<br />
enable_external_container_database_stack_monitoring	exec	externalContainerDatabaseId, region, externalDatabaseConnectorId	opc-retry-token, opc-request-id, if-match	Enable Stack Monitoring for the external container database.<br />
scan_external_container_database_pluggable_databases	exec	externalContainerDatabaseId, externalDatabaseConnectorId, region	opc-request-id, opc-retry-token	Scans for pluggable databases in the specified external container database.<br />This operation will return un-registered pluggable databases in the [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) operation.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
externalContainerDatabaseId	string	The ExternalContainerDatabase [OCID](/Content/General/Concepts/identifiers.htm).
externalDatabaseConnectorId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the external database connector resource (ExternalDatabaseConnectorId).
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
if-match	string	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	string	Unique identifier for the request.
opc-retry-token	string	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).

Lifecycle Methods

disable_external_container_database_database_management

Disable Database Management service for the external container database.<br />

EXEC oci.database.externalcontainerdatabases.disable_external_container_database_database_management 
@externalContainerDatabaseId='{{ externalContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}'
;

disable_external_container_database_stack_monitoring

Disable Stack Monitoring for the external container database.<br />

EXEC oci.database.externalcontainerdatabases.disable_external_container_database_stack_monitoring 
@externalContainerDatabaseId='{{ externalContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}'
;

enable_external_container_database_database_management

Enables Database Management Service for the external container database.<br />For more information about the Database Management Service, see<br />[Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm).<br />

EXEC oci.database.externalcontainerdatabases.enable_external_container_database_database_management 
@externalContainerDatabaseId='{{ externalContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"externalDatabaseConnectorId": "{{ externalDatabaseConnectorId }}", 
"licenseModel": "{{ licenseModel }}"
}'
;

enable_external_container_database_stack_monitoring

Enable Stack Monitoring for the external container database.<br />

EXEC oci.database.externalcontainerdatabases.enable_external_container_database_stack_monitoring 
@externalContainerDatabaseId='{{ externalContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"externalDatabaseConnectorId": "{{ externalDatabaseConnectorId }}"
}'
;

scan_external_container_database_pluggable_databases

Scans for pluggable databases in the specified external container database.<br />This operation will return un-registered pluggable databases in the [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) operation.<br />

EXEC oci.database.externalcontainerdatabases.scan_external_container_database_pluggable_databases 
@externalContainerDatabaseId='{{ externalContainerDatabaseId }}' --required, 
@externalDatabaseConnectorId='{{ externalDatabaseConnectorId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}'
;