Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DbSystemSummary

The Database Service supports several types of DB systems, ranging in size, price, and performance. For details about each type of system, see Bare Metal and Virtual Machine DB Systems.

*Note:** Deprecated for Exadata Cloud Service instances using the new [resource model](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model). To provision and manage new Exadata Cloud Service systems, use the CloudExadataInfrastructure and CloudVmCluster. See [Exadata Cloud Service](https://docs.cloud.oracle.com/Content/Database/Concepts/exaoverview.htm) for more information on Exadata systems.

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](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

For information about access control and compartments, see [Overview of the Identity Service](https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).

For information about availability domains, see [Regions and Availability Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm).

To get a list of availability domains, use the {@code ListAvailabilityDomains} operation in the Identity Service API.

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Properties

availabilityDomain

availabilityDomain: string

The name of the availability domain that the DB system is located in.

Optional backupNetworkNsgIds

backupNetworkNsgIds: Array<string>

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

Optional backupSubnetId

backupSubnetId: undefined | string

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

*Subnet Restriction:** See the subnet restrictions information for **subnetId**.

Optional clusterName

clusterName: undefined | string

The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

compartmentId

compartmentId: string

The OCID of the compartment.

cpuCoreCount

cpuCoreCount: number

The number of CPU cores enabled on the DB system. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional dataCollectionOptions

dataCollectionOptions: model.DataCollectionOptions

Optional dataStoragePercentage

dataStoragePercentage: undefined | number

The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional dataStorageSizeInGBs

dataStorageSizeInGBs: undefined | number

The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

databaseEdition

databaseEdition: DatabaseEdition

The Oracle Database edition that applies to all the databases on the DB system.

Optional dbSystemOptions

dbSystemOptions: model.DbSystemOptions

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Optional diskRedundancy

diskRedundancy: DiskRedundancy

The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

displayName

displayName: string

The user-friendly name for the DB system. The name does not have to be unique.

domain

domain: string

The domain name for the DB system.

Optional faultDomains

faultDomains: Array<string>

List of the Fault Domains in which this DB system is provisioned.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

hostname

hostname: string

The hostname for the DB system.

id

id: string

The OCID of the DB system.

Optional kmsKeyId

kmsKeyId: undefined | string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Optional lastMaintenanceRunId

lastMaintenanceRunId: undefined | string

The OCID of the last maintenance run.

Optional lastPatchHistoryEntryId

lastPatchHistoryEntryId: undefined | string

The OCID of the last patch history. This value is updated as soon as a patch operation starts.

Optional licenseModel

licenseModel: LicenseModel

The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Additional information about the current lifecycle state.

lifecycleState

lifecycleState: LifecycleState

The current state of the DB system.

Optional listenerPort

listenerPort: undefined | number

The port number configured for the listener on the DB system. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional maintenanceWindow

maintenanceWindow: model.MaintenanceWindow

Optional memorySizeInGBs

memorySizeInGBs: undefined | number

Memory allocated to the DB system, in gigabytes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional nextMaintenanceRunId

nextMaintenanceRunId: undefined | string

The OCID of the next maintenance run.

Optional nodeCount

nodeCount: undefined | number

The number of nodes in the DB system. For RAC DB systems, the value is greater than 1. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional nsgIds

nsgIds: Array<string>

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

Optional osVersion

osVersion: undefined | string

The most recent OS Patch Version applied on the DB system.

Optional pointInTimeDataDiskCloneTimestamp

pointInTimeDataDiskCloneTimestamp: Date

The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.

Optional recoStorageSizeInGB

recoStorageSizeInGB: undefined | number

The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional scanDnsName

scanDnsName: undefined | string

The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.

Optional scanDnsRecordId

scanDnsRecordId: undefined | string

The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.

Optional scanIpIds

scanIpIds: Array<string>

The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.

*Note:** For a single-node DB system, this list is empty.

shape

shape: string

The shape of the DB system. The shape determines resources to allocate to the DB system.

  • For virtual machine shapes, the number of CPU cores and memory
  • For bare metal and Exadata shapes, the number of CPU cores, storage, and memory

Optional sourceDbSystemId

sourceDbSystemId: undefined | string

The OCID of the DB system.

Optional sparseDiskgroup

sparseDiskgroup: undefined | false | true

True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

sshPublicKeys

sshPublicKeys: Array<string>

The public key portion of one or more key pairs used for SSH access to the DB system.

Optional storageVolumePerformanceMode

storageVolumePerformanceMode: StorageVolumePerformanceMode

The block storage volume performance level. Valid values are {@code BALANCED} and {@code HIGH_PERFORMANCE}. See Block Volume Performance for more information.

subnetId

subnetId: string

The OCID of the subnet the DB system is associated with.

*Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

Optional timeCreated

timeCreated: Date

The date and time the DB system was created.

Optional timeZone

timeZone: undefined | string

The time zone of the DB system. For details, see DB System Time Zones.

Optional version

version: undefined | string

The Oracle Database version of the DB system.

Optional vipIds

vipIds: Array<string>

The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.

*Note:** For a single-node DB system, this list is empty.

Optional zoneId

zoneId: undefined | string

The OCID of the zone the DB system is associated with.

Functions

getDeserializedJsonObj

getJsonObj