Qodex.ai

Checks the connectivity status of an external connector.

POST {{baseUrl}}/externalDbSystemConnectors/:externalDbSystemConnectorId/actions/checkConnectionStatus

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

HEADERS

KeyDatatypeRequiredDescription
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-idstringThe client request ID for tracing.
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
might be rejected.
Acceptstring

RESPONSES

status: OK

{"connectorType":"MACS","id":"\u003cstring\u003e","displayName":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","externalDbSystemId":"\u003cstring\u003e","lifecycleState":"UPDATING","timeCreated":"\u003cdateTime\u003e","timeUpdated":"\u003cdateTime\u003e","connectionFailureMessage":"\u003cstring\u003e","connectionStatus":"\u003cstring\u003e","lifecycleDetails":"\u003cstring\u003e","timeConnectionStatusLastUpdated":"\u003cdateTime\u003e"}