Lists the external databases.
GET {{baseUrl}}/externalDatabases?compartmentId=<string>&externalDbSystemId=<string>&displayName=<string>&page=<string>&limit=10&sortBy=TIMECREATED&sortOrder=ASC
Lists the external databases in the specified compartment or in the specified DB system.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
compartmentId | string | The OCID of the compartment. | |
externalDbSystemId | string | The OCID of the external DB system. | |
displayName | string | A filter to only return the resources that match the entire display name. | |
page | string | The page token representing the page from where the next set of paginated results | |
| are retrieved. This is usually retrieved from a previous list call. | |||
limit | number | The maximum number of records returned in the paginated response. | |
sortBy | string | The field to sort information by. Only one sortOrder can be used. The default sort order | |
for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. | |||
The DISPLAYNAME sort order is case-sensitive. | |||
sortOrder | string | The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
opc-request-id | string | The client request ID for tracing. | |
Accept | string |
RESPONSES
status: OK
{"items":[{"id":"\u003cstring\u003e","displayName":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","lifecycleState":"DELETING","timeCreated":"\u003cdateTime\u003e","databaseSubType":"ACD","databaseType":"EXTERNAL_RAC","dbManagementConfig":{"databaseManagementStatus":"ENABLING","licenseModel":"LICENSE_INCLUDED","connectorId":"\u003cstring\u003e"},"dbSystemInfo":{"id":"\u003cstring\u003e","displayName":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","exadataInfraInfo":{"id":"\u003cstring\u003e","displayName":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e"}},"dbUniqueName":"\u003cstring\u003e","definedTags":{"proident__":{"occaecat_19":{}}},"externalContainerDatabaseId":"\u003cstring\u003e","externalDbHomeId":"\u003cstring\u003e","freeformTags":{"quis12e":"\u003cstring\u003e"},"instanceDetails":[{"instanceNumber":"\u003cinteger\u003e","instanceName":"\u003cstring\u003e","hostName":"\u003cstring\u003e"},{"instanceNumber":"\u003cinteger\u003e","instanceName":"\u003cstring\u003e","hostName":"\u003cstring\u003e"}]},{"id":"\u003cstring\u003e","displayName":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","lifecycleState":"ACTIVE","timeCreated":"\u003cdateTime\u003e","databaseSubType":"ADB","databaseType":"SHARED","dbManagementConfig":{"databaseManagementStatus":"FAILED_ENABLING","licenseModel":"BRING_YOUR_OWN_LICENSE","connectorId":"\u003cstring\u003e"},"dbSystemInfo":{"id":"\u003cstring\u003e","displayName":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","exadataInfraInfo":{"id":"\u003cstring\u003e","displayName":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e"}},"dbUniqueName":"\u003cstring\u003e","definedTags":{"est__e":{"exercitation9":{},"ut_3":{}}},"externalContainerDatabaseId":"\u003cstring\u003e","externalDbHomeId":"\u003cstring\u003e","freeformTags":{"ad44":"\u003cstring\u003e"},"instanceDetails":[{"instanceNumber":"\u003cinteger\u003e","instanceName":"\u003cstring\u003e","hostName":"\u003cstring\u003e"},{"instanceNumber":"\u003cinteger\u003e","instanceName":"\u003cstring\u003e","hostName":"\u003cstring\u003e"}]}]}