Class 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. To provision and manage new Exadata Cloud Service systems, use the {@link CloudExadataInfrastructure} and {@link CloudVmCluster}. See Exadata Cloud Service 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 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.
For information about access control and compartments, see Overview of the Identity Service.
For information about availability domains, see Regions and Availability Domains.
To get a list of availability domains, use the 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.

Inheritance

object

DbSystemSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatabaseService.Models

Assembly: OCI.DotNetSDK.Database.dll

Syntax

public class DbSystemSummary

Properties

AvailabilityDomain

Declaration

[Required(ErrorMessage = "AvailabilityDomain is required.")]
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }

Property Value

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

Remarks

Required

BackupNetworkNsgIds

Declaration

[JsonProperty(PropertyName = "backupNetworkNsgIds")]
public List<string> BackupNetworkNsgIds { get; set; }

Property Value

Type	Description
List<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.

BackupSubnetId

Declaration

[JsonProperty(PropertyName = "backupSubnetId")]
public string BackupSubnetId { get; set; }

Property Value

Type	Description
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.

ClusterName

Declaration

[JsonProperty(PropertyName = "clusterName")]
public string ClusterName { get; set; }

Property Value

Type	Description
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

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

CpuCoreCount

Declaration

[Required(ErrorMessage = "CpuCoreCount is required.")]
[JsonProperty(PropertyName = "cpuCoreCount")]
public int? CpuCoreCount { get; set; }

Property Value

Type	Description
int?	The number of CPU cores enabled on the DB system.

Remarks

Required

DataCollectionOptions

Declaration

[JsonProperty(PropertyName = "dataCollectionOptions")]
public DataCollectionOptions DataCollectionOptions { get; set; }

Property Value

Type	Description
DataCollectionOptions

DataStoragePercentage

Declaration

[JsonProperty(PropertyName = "dataStoragePercentage")]
public int? DataStoragePercentage { get; set; }

Property Value

Type	Description
int?	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.

DataStorageSizeInGBs

Declaration

[JsonProperty(PropertyName = "dataStorageSizeInGBs")]
public int? DataStorageSizeInGBs { get; set; }

Property Value

Type	Description
int?	The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

DatabaseEdition

Declaration

[Required(ErrorMessage = "DatabaseEdition is required.")]
[JsonProperty(PropertyName = "databaseEdition")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DbSystemSummary.DatabaseEditionEnum? DatabaseEdition { get; set; }

Property Value

Type	Description
DbSystemSummary.DatabaseEditionEnum?	The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

Remarks

Required

DbSystemOptions

Declaration

[JsonProperty(PropertyName = "dbSystemOptions")]
public DbSystemOptions DbSystemOptions { get; set; }

Property Value

Type	Description
DbSystemOptions

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DiskRedundancy

Declaration

[JsonProperty(PropertyName = "diskRedundancy")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DbSystemSummary.DiskRedundancyEnum? DiskRedundancy { get; set; }

Property Value

Type	Description
DbSystemSummary.DiskRedundancyEnum?	The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

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

Remarks

Required

Domain

Declaration

[Required(ErrorMessage = "Domain is required.")]
[JsonProperty(PropertyName = "domain")]
public string Domain { get; set; }

Property Value

Type	Description
string	The domain name for the DB system.

Remarks

Required

FaultDomains

Declaration

[JsonProperty(PropertyName = "faultDomains")]
public List<string> FaultDomains { get; set; }

Property Value

Type	Description
List<string>	List of the Fault Domains in which this DB system is provisioned.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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: {"Department": "Finance"}

GiSoftwareImageId

Declaration

[JsonProperty(PropertyName = "giSoftwareImageId")]
public string GiSoftwareImageId { get; set; }

Property Value

Type	Description
string	The OCID of a grid infrastructure software image. This is a database software image of the type `GRID_IMAGE`.

Hostname

Declaration

[Required(ErrorMessage = "Hostname is required.")]
[JsonProperty(PropertyName = "hostname")]
public string Hostname { get; set; }

Property Value

Type	Description
string	The hostname for the DB system.

Remarks

Required

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the DB system.

Remarks

Required

KmsKeyId

Declaration

[JsonProperty(PropertyName = "kmsKeyId")]
public string KmsKeyId { get; set; }

Property Value

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

LastMaintenanceRunId

Declaration

[JsonProperty(PropertyName = "lastMaintenanceRunId")]
public string LastMaintenanceRunId { get; set; }

Property Value

Type	Description
string	The OCID of the last maintenance run.

LastPatchHistoryEntryId

Declaration

[JsonProperty(PropertyName = "lastPatchHistoryEntryId")]
public string LastPatchHistoryEntryId { get; set; }

Property Value

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

LicenseModel

Declaration

[JsonProperty(PropertyName = "licenseModel")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DbSystemSummary.LicenseModelEnum? LicenseModel { get; set; }

Property Value

Type	Description
DbSystemSummary.LicenseModelEnum?	The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	Additional information about the current lifecycle state.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DbSystemSummary.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
DbSystemSummary.LifecycleStateEnum?	The current state of the DB system.

Remarks

Required

ListenerPort

Declaration

[JsonProperty(PropertyName = "listenerPort")]
public int? ListenerPort { get; set; }

Property Value

Type	Description
int?	The port number configured for the listener on the DB system.

MaintenanceWindow

Declaration

[JsonProperty(PropertyName = "maintenanceWindow")]
public MaintenanceWindow MaintenanceWindow { get; set; }

Property Value

Type	Description
MaintenanceWindow

MemorySizeInGBs

Declaration

[JsonProperty(PropertyName = "memorySizeInGBs")]
public int? MemorySizeInGBs { get; set; }

Property Value

Type	Description
int?	Memory allocated to the DB system, in gigabytes.

NextMaintenanceRunId

Declaration

[JsonProperty(PropertyName = "nextMaintenanceRunId")]
public string NextMaintenanceRunId { get; set; }

Property Value

Type	Description
string	The OCID of the next maintenance run.

NodeCount

Declaration

[JsonProperty(PropertyName = "nodeCount")]
public int? NodeCount { get; set; }

Property Value

Type	Description
int?	The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

NsgIds

Declaration

[JsonProperty(PropertyName = "nsgIds")]
public List<string> NsgIds { get; set; }

Property Value

Type	Description
List<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.

Type

Description

List<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.

OsVersion

Declaration

[JsonProperty(PropertyName = "osVersion")]
public string OsVersion { get; set; }

Property Value

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

PointInTimeDataDiskCloneTimestamp

Declaration

[JsonProperty(PropertyName = "pointInTimeDataDiskCloneTimestamp")]
public DateTime? PointInTimeDataDiskCloneTimestamp { get; set; }

Property Value

Type	Description
DateTime?	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.

RecoStorageSizeInGB

Declaration

[JsonProperty(PropertyName = "recoStorageSizeInGB")]
public int? RecoStorageSizeInGB { get; set; }

Property Value

Type	Description
int?	The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

ScanDnsName

Declaration

[JsonProperty(PropertyName = "scanDnsName")]
public string ScanDnsName { get; set; }

Property Value

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

ScanDnsRecordId

Declaration

[JsonProperty(PropertyName = "scanDnsRecordId")]
public string ScanDnsRecordId { get; set; }

Property Value

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

ScanIpIds

Declaration

[JsonProperty(PropertyName = "scanIpIds")]
public List<string> ScanIpIds { get; set; }

Property Value

Type	Description
List<string>	The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 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.

ScanIpv6Ids

Declaration

[JsonProperty(PropertyName = "scanIpv6Ids")]
public List<string> ScanIpv6Ids { get; set; }

Property Value

Type	Description
List<string>	The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 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.

SecurityAttributes

Declaration

[JsonProperty(PropertyName = "securityAttributes")]
public Dictionary<string, Dictionary<string, object>> SecurityAttributes { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}

Shape

Declaration

[Required(ErrorMessage = "Shape is required.")]
[JsonProperty(PropertyName = "shape")]
public string Shape { get; set; }

Property Value

Type	Description
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

Type

Description

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

Remarks

Required

SourceDbSystemId

Declaration

[JsonProperty(PropertyName = "sourceDbSystemId")]
public string SourceDbSystemId { get; set; }

Property Value

Type	Description
string	The OCID of the DB system.

SparseDiskgroup

Declaration

[JsonProperty(PropertyName = "sparseDiskgroup")]
public bool? SparseDiskgroup { get; set; }

Property Value

Type	Description
bool?	True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

SshPublicKeys

Declaration

[Required(ErrorMessage = "SshPublicKeys is required.")]
[JsonProperty(PropertyName = "sshPublicKeys")]
public List<string> SshPublicKeys { get; set; }

Property Value

Type	Description
List<string>	The public key portion of one or more key pairs used for SSH access to the DB system.

Remarks

Required

StorageVolumePerformanceMode

Declaration

[JsonProperty(PropertyName = "storageVolumePerformanceMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DbSystemSummary.StorageVolumePerformanceModeEnum? StorageVolumePerformanceMode { get; set; }

Property Value

Type	Description
DbSystemSummary.StorageVolumePerformanceModeEnum?	The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`. See Block Volume Performance for more information.

SubnetId

Declaration

[Required(ErrorMessage = "SubnetId is required.")]
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }

Property Value

Type	Description
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.

Type

Description

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.

Remarks

Required

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the DB system was created.

TimeZone

Declaration

[JsonProperty(PropertyName = "timeZone")]
public string TimeZone { get; set; }

Property Value

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

Version

Declaration

[JsonProperty(PropertyName = "version")]
public string Version { get; set; }

Property Value

Type	Description
string	The Oracle Database version of the DB system.

VipIds

Declaration

[JsonProperty(PropertyName = "vipIds")]
public List<string> VipIds { get; set; }

Property Value

Type	Description
List<string>	The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster. Note: For a single-node DB system, this list is empty.

Vipv6Ids

Declaration

[JsonProperty(PropertyName = "vipv6Ids")]
public List<string> Vipv6Ids { get; set; }

Property Value

Type	Description
List<string>	The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 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.

ZoneId

Declaration

[JsonProperty(PropertyName = "zoneId")]
public string ZoneId { get; set; }

Property Value

Type	Description
string	The OCID of the zone the DB system is associated with.