Lists the external DB homes.
GET {{baseUrl}}/externalDbHomes?compartmentId=<string>&externalDbSystemId=<string>&displayName=<string>&page=<string>&limit=10&sortBy=TIMECREATED&sortOrder=ASC
Lists the DB homes in the specified external 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","externalDbSystemId":"\u003cstring\u003e","lifecycleState":"\u003cstring\u003e","timeCreated":"\u003cdateTime\u003e","timeUpdated":"\u003cdateTime\u003e","componentName":"\u003cstring\u003e","definedTags":{"esse_2":{"exf":{},"quid8":{}},"officia_826":{"ipsum_9f":{}}},"freeformTags":{"laboris__":"\u003cstring\u003e","amet_5":"\u003cstring\u003e"},"homeDirectory":"\u003cstring\u003e","lifecycleDetails":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","displayName":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","externalDbSystemId":"\u003cstring\u003e","lifecycleState":"\u003cstring\u003e","timeCreated":"\u003cdateTime\u003e","timeUpdated":"\u003cdateTime\u003e","componentName":"\u003cstring\u003e","definedTags":{"ut_e":{"tempor_2":{},"Excepteurf3b":{}},"qui5":{"sunt_11":{}}},"freeformTags":{"in_1e2":"\u003cstring\u003e"},"homeDirectory":"\u003cstring\u003e","lifecycleDetails":"\u003cstring\u003e"}]}