ListDbSystems
GET {{baseUrl}}/dbSystems?compartmentId=<string>&limit=10&page=<string>&backupId=<string>&sortBy=TIMECREATED&sortOrder=ASC&lifecycleState=<string>&availabilityDomain=<string>&displayName=<string>
Lists the DB systems in the specified compartment. You can specify a backupId to list only the DB systems that support creating a database using this backup in this compartment.
Note: Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead.
For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
compartmentId | string | (Required) The compartment OCID. | |
limit | number | The maximum number of items to return per page. | |
page | string | The pagination token to continue listing from. | |
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. | |
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. |
Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.
|
| 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. |
| availabilityDomain | string | | A filter to return only resources that match the given availability domain 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":"PROVISIONING","displayName":"\u003cstring\u003e","availabilityDomain":"\u003cstring\u003e","subnetId":"\u003cstring\u003e","shape":"\u003cstring\u003e","sshPublicKeys":["\u003cstring\u003e","\u003cstring\u003e"],"cpuCoreCount":"\u003cinteger\u003e","databaseEdition":"STANDARD_EDITION","hostname":"\u003cstring\u003e","domain":"\u003cstring\u003e","backupNetworkNsgIds":["\u003cstring\u003e","\u003cstring\u003e"],"backupSubnetId":"\u003cstring\u003e","clusterName":"\u003cstring\u003e","dataCollectionOptions":{"isDiagnosticsEventsEnabled":"\u003cboolean\u003e","isHealthMonitoringEnabled":"\u003cboolean\u003e","isIncidentLogsEnabled":"\u003cboolean\u003e"},"dataStoragePercentage":"\u003cinteger\u003e","dataStorageSizeInGBs":"\u003cinteger\u003e","dbSystemOptions":{"storageManagement":"ASM"},"definedTags":{"ad23":{"anim_9":{}}},"diskRedundancy":"NORMAL","faultDomains":["\u003cstring\u003e","\u003cstring\u003e"],"freeformTags":{"officia_9":"\u003cstring\u003e"},"kmsKeyId":"\u003cstring\u003e","lastMaintenanceRunId":"\u003cstring\u003e","lastPatchHistoryEntryId":"\u003cstring\u003e","licenseModel":"LICENSE_INCLUDED","lifecycleDetails":"\u003cstring\u003e","listenerPort":"\u003cinteger\u003e","maintenanceWindow":{"customActionTimeoutInMins":"\u003cinteger\u003e","daysOfWeek":[{"name":"SATURDAY"},{"name":"WEDNESDAY"}],"hoursOfDay":["\u003cinteger\u003e","\u003cinteger\u003e"],"isCustomActionTimeoutEnabled":"\u003cboolean\u003e","leadTimeInWeeks":"\u003cinteger\u003e","months":[{"name":"OCTOBER"},{"name":"JULY"}],"patchingMode":"NONROLLING","preference":"NO_PREFERENCE","weeksOfMonth":["\u003cinteger\u003e","\u003cinteger\u003e"]},"memorySizeInGBs":"\u003cinteger\u003e","nextMaintenanceRunId":"\u003cstring\u003e","nodeCount":"\u003cinteger\u003e","nsgIds":["\u003cstring\u003e","\u003cstring\u003e"],"pointInTimeDataDiskCloneTimestamp":"\u003cdateTime\u003e","recoStorageSizeInGB":"\u003cinteger\u003e","scanDnsName":"\u003cstring\u003e","scanDnsRecordId":"\u003cstring\u003e","scanIpIds":["\u003cstring\u003e","\u003cstring\u003e"],"sourceDbSystemId":"\u003cstring\u003e","sparseDiskgroup":"\u003cboolean\u003e","storageVolumePerformanceMode":"BALANCED","timeCreated":"\u003cdateTime\u003e","timeZone":"\u003cstring\u003e","version":"\u003cstring\u003e","vipIds":["\u003cstring\u003e","\u003cstring\u003e"],"zoneId":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","lifecycleState":"TERMINATING","displayName":"\u003cstring\u003e","availabilityDomain":"\u003cstring\u003e","subnetId":"\u003cstring\u003e","shape":"\u003cstring\u003e","sshPublicKeys":["\u003cstring\u003e","\u003cstring\u003e"],"cpuCoreCount":"\u003cinteger\u003e","databaseEdition":"ENTERPRISE_EDITION","hostname":"\u003cstring\u003e","domain":"\u003cstring\u003e","backupNetworkNsgIds":["\u003cstring\u003e","\u003cstring\u003e"],"backupSubnetId":"\u003cstring\u003e","clusterName":"\u003cstring\u003e","dataCollectionOptions":{"isDiagnosticsEventsEnabled":"\u003cboolean\u003e","isHealthMonitoringEnabled":"\u003cboolean\u003e","isIncidentLogsEnabled":"\u003cboolean\u003e"},"dataStoragePercentage":"\u003cinteger\u003e","dataStorageSizeInGBs":"\u003cinteger\u003e","dbSystemOptions":{"storageManagement":"ASM"},"definedTags":{"dolore_3e7":{"qui_34_":{},"id3":{},"incididunt66":{}},"nulla389":{"qui5":{},"pariatur_60":{},"ad_99e":{}},"do_76e":{"culpa44":{},"dolore_6":{},"fugiat_e8":{}}},"diskRedundancy":"HIGH","faultDomains":["\u003cstring\u003e","\u003cstring\u003e"],"freeformTags":{"adipisicing_d":"\u003cstring\u003e","adf":"\u003cstring\u003e"},"kmsKeyId":"\u003cstring\u003e","lastMaintenanceRunId":"\u003cstring\u003e","lastPatchHistoryEntryId":"\u003cstring\u003e","licenseModel":"LICENSE_INCLUDED","lifecycleDetails":"\u003cstring\u003e","listenerPort":"\u003cinteger\u003e","maintenanceWindow":{"customActionTimeoutInMins":"\u003cinteger\u003e","daysOfWeek":[{"name":"THURSDAY"},{"name":"SATURDAY"}],"hoursOfDay":["\u003cinteger\u003e","\u003cinteger\u003e"],"isCustomActionTimeoutEnabled":"\u003cboolean\u003e","leadTimeInWeeks":"\u003cinteger\u003e","months":[{"name":"MAY"},{"name":"MARCH"}],"patchingMode":"ROLLING","preference":"NO_PREFERENCE","weeksOfMonth":["\u003cinteger\u003e","\u003cinteger\u003e"]},"memorySizeInGBs":"\u003cinteger\u003e","nextMaintenanceRunId":"\u003cstring\u003e","nodeCount":"\u003cinteger\u003e","nsgIds":["\u003cstring\u003e","\u003cstring\u003e"],"pointInTimeDataDiskCloneTimestamp":"\u003cdateTime\u003e","recoStorageSizeInGB":"\u003cinteger\u003e","scanDnsName":"\u003cstring\u003e","scanDnsRecordId":"\u003cstring\u003e","scanIpIds":["\u003cstring\u003e","\u003cstring\u003e"],"sourceDbSystemId":"\u003cstring\u003e","sparseDiskgroup":"\u003cboolean\u003e","storageVolumePerformanceMode":"BALANCED","timeCreated":"\u003cdateTime\u003e","timeZone":"\u003cstring\u003e","version":"\u003cstring\u003e","vipIds":["\u003cstring\u003e","\u003cstring\u003e"],"zoneId":"\u003cstring\u003e"}]