externaldatabaseconnectors
Creates, updates, deletes, gets or lists an externaldatabaseconnectors resource.
Overview​
| Name | externaldatabaseconnectors |
| Type | Resource |
| Id | oci.database.externaldatabaseconnectors |
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 |
|---|---|---|---|---|
check_external_database_connector_connection_status | exec | externalDatabaseConnectorId, region | opc-retry-token, opc-request-id, if-match | Check the status of the external database connection specified in this connector.<br />This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.<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 |
|---|---|---|
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​
- check_external_database_connector_connection_status
Check the status of the external database connection specified in this connector.<br />This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.<br />
EXEC oci.database.externaldatabaseconnectors.check_external_database_connector_connection_status
@externalDatabaseConnectorId='{{ externalDatabaseConnectorId }}' --required,
@region='{{ region }}' --required,
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}',
@if-match='{{ if-match }}'
;