ListDbHomes
GET {{baseUrl}}/dbHomes?compartmentId=<string>&dbSystemId=<string>&vmClusterId=<string>&backupId=<string>&dbVersion=NONE&limit=10&page=<string>&sortBy=TIMECREATED&sortOrder=ASC&lifecycleState=<string>&displayName=<string>
Lists the Database Homes in the specified DB system and compartment. A Database Home is a directory where Oracle Database software is installed.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
compartmentId | string | (Required) The compartment OCID. | |
dbSystemId | string | The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system. | |
vmClusterId | string | The OCID of the VM cluster. | |
backupId | string | The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment. | |
dbVersion | string | A filter to return only DB Homes that match the specified dbVersion. | |
limit | number | The maximum number of items to return per page. | |
page | string | The pagination token to continue listing from. | |
sortBy | string | The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. | |
sortOrder | string | The sort order to use, either ascending (ASC) or descending (DESC). | |
lifecycleState | string | A filter to return only resources that match the given lifecycle state exactly. | |
displayName | string | A filter to return only resources that match the entire display name given. The match is not case sensitive. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","lifecycleState":"TERMINATED","displayName":"\u003cstring\u003e","dbVersion":"\u003cstring\u003e","dbHomeLocation":"\u003cstring\u003e","databaseSoftwareImageId":"\u003cstring\u003e","dbSystemId":"\u003cstring\u003e","definedTags":{"anim72":{"autea":{},"suntb3":{},"doloref1":{}},"adipisicing_e":{"ex9":{},"ametf":{},"officia71a":{}},"nostrud21":{"Duis__b":{}}},"freeformTags":{"laboris86":"\u003cstring\u003e","amet__d6":"\u003cstring\u003e"},"kmsKeyId":"\u003cstring\u003e","lastPatchHistoryEntryId":"\u003cstring\u003e","lifecycleDetails":"\u003cstring\u003e","oneOffPatches":["\u003cstring\u003e","\u003cstring\u003e"],"timeCreated":"\u003cdateTime\u003e","vmClusterId":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","lifecycleState":"PROVISIONING","displayName":"\u003cstring\u003e","dbVersion":"\u003cstring\u003e","dbHomeLocation":"\u003cstring\u003e","databaseSoftwareImageId":"\u003cstring\u003e","dbSystemId":"\u003cstring\u003e","definedTags":{"adipisicing4":{"nulla_1_":{},"dolore18":{}}},"freeformTags":{"laboref":"\u003cstring\u003e","qui_7c1":"\u003cstring\u003e","laboris_683":"\u003cstring\u003e","culpa5":"\u003cstring\u003e","ipsum_d8":"\u003cstring\u003e"},"kmsKeyId":"\u003cstring\u003e","lastPatchHistoryEntryId":"\u003cstring\u003e","lifecycleDetails":"\u003cstring\u003e","oneOffPatches":["\u003cstring\u003e","\u003cstring\u003e"],"timeCreated":"\u003cdateTime\u003e","vmClusterId":"\u003cstring\u003e"}]