• Public
  • Public/Protected
  • All

Namespace ListDbHomesRequest


Click here to see how to use ListDbHomesRequest.


Optional backupId

backupId: undefined | 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.


compartmentId: string

The compartment OCID.

Optional dbSystemId

dbSystemId: undefined | string

The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.

Optional dbVersion

dbVersion: undefined | string

A filter to return only DB Homes that match the specified dbVersion.

Optional displayName

displayName: undefined | string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

Optional lifecycleState

lifecycleState: undefined | string

A filter to return only resources that match the given lifecycle state exactly.

Optional limit

limit: undefined | number

The maximum number of items to return per page.

Optional page

page: undefined | string

The pagination token to continue listing from.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional sortBy

sortBy: SortBy

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.

Optional sortOrder

sortOrder: SortOrder

The sort order to use, either ascending (ASC) or descending (DESC).

Optional vmClusterId

vmClusterId: undefined | string

The OCID of the VM cluster.