Skip to main content

externalpluggabledatabases

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

Overview​

Nameexternalpluggabledatabases
TypeResource
Idoci.database.externalpluggabledatabases

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:

NameAccessible byRequired ParamsOptional ParamsDescription
disable_external_pluggable_database_database_managementexecexternalPluggableDatabaseId, regionopc-retry-token, opc-request-id, if-matchDisable Database Management Service for the external pluggable database.<br />For more information about the Database Management Service, see<br />[Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm).<br />
disable_external_pluggable_database_operations_insightsexecexternalPluggableDatabaseId, regionopc-retry-token, opc-request-id, if-matchDisable Operations Insights for the external pluggable database.<br />
disable_external_pluggable_database_stack_monitoringexecexternalPluggableDatabaseId, regionopc-retry-token, opc-request-id, if-matchDisable Stack Monitoring for the external pluggable database.<br />
enable_external_pluggable_database_database_managementexecexternalPluggableDatabaseId, region, externalDatabaseConnectorIdopc-retry-token, opc-request-id, if-matchEnable Database Management Service for the external pluggable database.<br />For more information about the Database Management Service, see<br />[Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm).<br />
enable_external_pluggable_database_operations_insightsexecexternalPluggableDatabaseId, region, externalDatabaseConnectorIdopc-retry-token, opc-request-id, if-matchEnable Operations Insights for the external pluggable database.<br />
enable_external_pluggable_database_stack_monitoringexecexternalPluggableDatabaseId, region, externalDatabaseConnectorIdopc-retry-token, opc-request-id, if-matchEnable Stack Monitoring for the external pluggable database.<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.

NameDatatypeDescription
externalPluggableDatabaseIdstringThe ExternalPluggableDatabaseId [OCID](/Content/General/Concepts/identifiers.htm).
regionstringOCI 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-matchstringFor 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-idstringUnique identifier for the request.
opc-retry-tokenstringA 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 Database Management Service for the external pluggable database.<br />For more information about the Database Management Service, see<br />[Database Management Service](/Content/ExternalDatabase/Concepts/databasemanagementservice.htm).<br />

EXEC oci.database.externalpluggabledatabases.disable_external_pluggable_database_database_management
@externalPluggableDatabaseId='{{ externalPluggableDatabaseId }}' --required,
@region='{{ region }}' --required,
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}',
@if-match='{{ if-match }}'
;